1. Sitecore.LayoutService.Client.Response.Model

Interface IFieldReader

Version: 21.x

Supports delayed reading of an IField.

Namespace: Sitecore.LayoutService.Client.Response.Model

Assembly: Sitecore.LayoutService.Client.Abstractions.dll

Syntax

public interface IFieldReader

Methods

Read(Type)

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

Declaration
object Read(Type type)
Parameters
TypeNameDescription
System.TypetypeThe type of field to be read.
Returns
TypeDescription
System.ObjectA new instance if successful.

Read()

Reads the current Field as the specified type.

Declaration

TField Read<TField>()
    where TField : IField
Returns
TypeDescription
TFieldA new instance of TField.
Type Parameters
NameDescription
TFieldThe 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.

Declaration
bool TryRead(Type type, out IField field)
Parameters
TypeNameDescription
System.TypetypeThe type of field to be read.
IFieldfieldThe resulting field.
Returns
TypeDescription
System.BooleanTrue if the field could be read as the specified type, otherwise false.

TryRead(out TField)

Attempts to read the current Field as the specified type.

Declaration

bool TryRead<TField>(out TField field)
    where TField : IField
Parameters
TypeNameDescription
TFieldfieldThe resulting instance if successful.
Returns
TypeDescription
System.BooleanTrue if the field could be read as the specified type, otherwise false.
Type Parameters
NameDescription
TFieldThe type of Field to be read.
If you have suggestions for improving this article, let us know!