Show / Hide Table of Contents

Class ItemLinkField<TTargetModel>

Facilitates mapping a link field to a specific target model type.

Inheritance
System.Object
FieldsReader
ItemLinkField
ItemLinkField<TTargetModel>
Implements
IFieldsReader
IField
IFieldReader
Inherited Members
ItemLinkField.Id
ItemLinkField.Url
FieldsReader.ReadField<TField>(String)
FieldsReader.TryReadField<TField>(String, TField)
FieldsReader.ReadFields<T>()
FieldsReader.TryReadFields<T>(T)
FieldsReader.ReadField(Type, String)
FieldsReader.TryReadField(Type, String, Object)
FieldsReader.TryReadFields(Type, Object)
FieldsReader.ReadFields(Type)
FieldsReader.HandleReadFields(Type)
Namespace: Sitecore.LayoutService.Client.Response.Model.Fields
Assembly: Sitecore.LayoutService.Client.Abstractions.dll
Syntax
public class ItemLinkField<TTargetModel> : ItemLinkField, IFieldsReader, IField, IFieldReader where TTargetModel : class
Type Parameters
Name Description
TTargetModel

Target model type.

Constructors

ItemLinkField()

Declaration
public ItemLinkField()

Properties

Fields

Gets or sets the strongly typed target.

Declaration
public TTargetModel Fields { get; set; }
Property Value
Type Description
TTargetModel

Target

Gets or sets the strongly types target if the item link.

Declaration
public TTargetModel Target { get; protected set; }
Property Value
Type Description
TTargetModel

Methods

HandleRead(Type)

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

Declaration
protected override object HandleRead(Type type)
Parameters
Type Name Description
System.Type type

The type to read the field as.

Returns
Type Description
System.Object

A new instance of the specified type.

Overrides
ItemLinkField.HandleRead(Type)

Read(Type)

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

Declaration
public override object Read(Type type)
Parameters
Type Name Description
System.Type type

The type of field to be read.

Returns
Type Description
System.Object

A new instance if successful.

Overrides
ItemLinkField.Read(Type)

Read<TField>()

Reads the current Field as the specified type.

Declaration
public override TField Read<TField>()
    where TField : IField
Returns
Type Description
TField

A new instance of TField.

Type Parameters
Name Description
TField

The type of Field to be read.

Overrides
ItemLinkField.Read<TField>()

TryRead(Type, out IField)

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

Declaration
public override bool TryRead(Type type, out IField field)
Parameters
Type Name Description
System.Type type

The type of field to be read.

IField field

The resulting field.

Returns
Type Description
System.Boolean

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

Overrides
ItemLinkField.TryRead(Type, out IField)

TryRead<TField>(out TField)

Declaration
public override bool TryRead<TField>(out TField field)
    where TField : IField
Parameters
Type Name Description
TField field
Returns
Type Description
System.Boolean
Type Parameters
Name Description
TField
Overrides
Sitecore.LayoutService.Client.Response.Model.Fields.ItemLinkField.TryRead<TField>(TField)

Implements

IFieldsReader
IField
IFieldReader
Back to top Generated by DocFX