Show / Hide Table of Contents

Interface IFieldReader

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
Type Name Description
System.Type type

The type of field to be read.

Returns
Type Description
System.Object

A new instance if successful.

Read<TField>()

Reads the current Field as the specified type.

Declaration
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.

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
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.

TryRead<TField>(out TField)

Attempts to read the current Field as the specified type.

Declaration
bool TryRead<TField>(out TField field)
    where TField : IField
Parameters
Type Name Description
TField field

The resulting instance if successful.

Returns
Type Description
System.Boolean

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

Type Parameters
Name Description
TField

The type of Field to be read.

Back to top Generated by DocFX