Class FieldReader
Implements reading of a Field as a specified type.
Implements
Namespace: Sitecore.LayoutService.Client.Response.Model
Assembly: Sitecore.LayoutService.Client.Abstractions.dll
Syntax
public abstract class FieldReader : Object, IFieldReaderConstructors
FieldReader()
Declaration
protected FieldReader()Methods
HandleRead(Type)
Returns an instance of the Field data as a specified type.
Declaration
protected abstract 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. |
Read(Type)
Reads the current Field as the specified type. The type must implement IField.
Declaration
public virtual 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
public virtual TField Read<TField>()
where TField : IFieldReturns
| Type | Description |
|---|---|
| TField |
A new instance of |
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
public virtual 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
public virtual bool TryRead<TField>(out TField field)
where TField : IFieldParameters
| 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. |