Class ContentListField<TTargetModel>

Namespace

Sitecore.AspNetCore.SDK.LayoutService.Client.Response.Model.Fields

Assembly

Sitecore.AspNetCore.SDK.LayoutService.Client.dll

Allows list field types to be mapped to a specific model.

[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1649:File name should match first type name", Justification = "Generic Type.")]
public class ContentListField<TTargetModel> : List<ItemLinkField<TTargetModel>>, IList<ItemLinkField<TTargetModel>>, ICollection<ItemLinkField<TTargetModel>>, IReadOnlyList<ItemLinkField<TTargetModel>>, IReadOnlyCollection<ItemLinkField<TTargetModel>>, IEnumerable<ItemLinkField<TTargetModel>>, IList, ICollection, IEnumerable, IField, IFieldReader where TTargetModel : class

Type Parameters

TTargetModel

Strongly typed model to map the target of each list item to.

Inheritance

object

List<ItemLinkField<TTargetModel>>

ContentListField<TTargetModel>

Implements

IList<ItemLinkField<TTargetModel>>

ICollection<ItemLinkField<TTargetModel>>

IReadOnlyList<ItemLinkField<TTargetModel>>

IReadOnlyCollection<ItemLinkField<TTargetModel>>

IEnumerable<ItemLinkField<TTargetModel>>

IList

ICollection

IEnumerable

IField

IFieldReader

Inherited Members

List<ItemLinkField<TTargetModel>>.Add(ItemLinkField<TTargetModel>)

List<ItemLinkField<TTargetModel>>.AddRange(IEnumerable<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.AsReadOnly()

List<ItemLinkField<TTargetModel>>.BinarySearch(int, int, ItemLinkField<TTargetModel>, IComparer<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.BinarySearch(ItemLinkField<TTargetModel>)

List<ItemLinkField<TTargetModel>>.BinarySearch(ItemLinkField<TTargetModel>, IComparer<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.Clear()

List<ItemLinkField<TTargetModel>>.Contains(ItemLinkField<TTargetModel>)

List<ItemLinkField<TTargetModel>>.ConvertAll<TOutput>(Converter<ItemLinkField<TTargetModel>, TOutput>)

List<ItemLinkField<TTargetModel>>.CopyTo(int, ItemLinkField<TTargetModel>[], int, int)

List<ItemLinkField<TTargetModel>>.CopyTo(ItemLinkField<TTargetModel>[])

List<ItemLinkField<TTargetModel>>.CopyTo(ItemLinkField<TTargetModel>[], int)

List<ItemLinkField<TTargetModel>>.EnsureCapacity(int)

List<ItemLinkField<TTargetModel>>.Exists(Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.Find(Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.FindAll(Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.FindIndex(int, int, Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.FindIndex(int, Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.FindIndex(Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.FindLast(Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.FindLastIndex(int, int, Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.FindLastIndex(int, Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.FindLastIndex(Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.ForEach(Action<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.GetEnumerator()

List<ItemLinkField<TTargetModel>>.GetRange(int, int)

List<ItemLinkField<TTargetModel>>.IndexOf(ItemLinkField<TTargetModel>)

List<ItemLinkField<TTargetModel>>.IndexOf(ItemLinkField<TTargetModel>, int)

List<ItemLinkField<TTargetModel>>.IndexOf(ItemLinkField<TTargetModel>, int, int)

List<ItemLinkField<TTargetModel>>.Insert(int, ItemLinkField<TTargetModel>)

List<ItemLinkField<TTargetModel>>.InsertRange(int, IEnumerable<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.LastIndexOf(ItemLinkField<TTargetModel>)

List<ItemLinkField<TTargetModel>>.LastIndexOf(ItemLinkField<TTargetModel>, int)

List<ItemLinkField<TTargetModel>>.LastIndexOf(ItemLinkField<TTargetModel>, int, int)

List<ItemLinkField<TTargetModel>>.Remove(ItemLinkField<TTargetModel>)

List<ItemLinkField<TTargetModel>>.RemoveAll(Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.RemoveAt(int)

List<ItemLinkField<TTargetModel>>.RemoveRange(int, int)

List<ItemLinkField<TTargetModel>>.Reverse()

List<ItemLinkField<TTargetModel>>.Reverse(int, int)

List<ItemLinkField<TTargetModel>>.Slice(int, int)

List<ItemLinkField<TTargetModel>>.Sort()

List<ItemLinkField<TTargetModel>>.Sort(IComparer<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.Sort(Comparison<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.Sort(int, int, IComparer<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.ToArray()

List<ItemLinkField<TTargetModel>>.TrimExcess()

List<ItemLinkField<TTargetModel>>.TrueForAll(Predicate<ItemLinkField<TTargetModel>>)

List<ItemLinkField<TTargetModel>>.Capacity

List<ItemLinkField<TTargetModel>>.Count

List<ItemLinkField<TTargetModel>>.this[int]

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

HandleRead(Type)

Returns an instance of the Field data as a specified type.

protected virtual object HandleRead(Type type)

Parameters

type Type

The type to read the field as.

Returns

object

A new instance of the specified type.

Read(Type)

Reads the current Field as the specified type. The type must implement IField.

public virtual object Read(Type type)

Parameters

type Type

The type of field to be read.

Returns

object

A new instance if successful.

Read<TField>()

Reads the current Field as the specified type.

public virtual TField Read<TField>() where TField : IField

Returns

TField

A new instance of TField.

Type Parameters

TField

The type of Field to be read.

TryRead(Type, out IField?)

Attempts to read the current Field as the specified type. The type must implement IField.

public virtual bool TryRead(Type type, out IField? field)

Parameters

type Type

The type of field to be read.

field IField

The resulting field.

Returns

bool

True if the field could be read as the specified type, otherwise false.

TryRead<TField>(out TField?)

Attempts to read the current Field as the specified type.

public virtual bool TryRead<TField>(out TField? field) where TField : IField

Parameters

field TField

The resulting instance if successful.

Returns

bool

True if the field could be read as the specified type, otherwise false.

Type Parameters

TField

The type of Field to be read.