Class FieldsReader

Implements reading of a collection of fields as a specified type.

Inheritance

System.Object

FieldsReader

Component

ItemLinkField

Route

Implements

IFieldsReader

Namespace: Sitecore.LayoutService.Client.Response.Model

Assembly: Sitecore.LayoutService.Client.Abstractions.dll

Syntax

public abstract class FieldsReader : Object, IFieldsReader

Constructors

FieldsReader()

Declaration

protected FieldsReader()

Properties

Fields

Gets or sets the Fields associated with this instance.

Declaration

public Dictionary<string, IFieldReader> Fields { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, IFieldReader>

Methods

HandleReadFields(Type)

Handles reading the field collection, binding to the specified type.

Declaration

protected virtual object HandleReadFields(Type type)

Parameters

Type	Name	Description
System.Type	type	The type to be bound.

Returns

Type	Description
System.Object	A new instance of the specified type, if successful.

ReadField(Type, String)

Reads a field from the collection as the specified type.

Declaration

public virtual object ReadField(Type type, string name)

Parameters

Type	Name	Description
System.Type	type	The type of object to return.
System.String	name	The name of the field to be read.

Returns

Type	Description
System.Object	A new instance of the specified type.

ReadField<TField>(String)

Reads a field from the collection as the specified type.

Declaration

public virtual TField ReadField<TField>(string name)
    where TField : IField, new()

Parameters

Type	Name	Description
System.String	name	The name of the field to be read.

Returns

Type	Description
TField	A new instance of TField.

Type Parameters

Name	Description
TField	The type of object to return.

ReadFields(Type)

Reads the collection of fields as the specified type.

Declaration

public object ReadFields(Type type)

Parameters

Type	Name	Description
System.Type	type	The type of object to return.

Returns

Type	Description
System.Object	A new instance of the specified type.

ReadFields<T>()

Reads the collection of fields as the specified type.

Declaration

public virtual T ReadFields<T>()
    where T : new()

Returns

Type	Description
T	A new instance of T.

Type Parameters

Name	Description
T	The type of object to return.

TryReadField(Type, String, out Object)

Attempts to read a field from the collection as the specified type.

Declaration

public virtual bool TryReadField(Type type, string name, out object instance)

Parameters

Type	Name	Description
System.Type	type	The type of object to return.
System.String	name	The name of the field to be read.
System.Object	instance	A new instance of type if successful.

Returns

Type	Description
System.Boolean	True if successful, otherwise false.

TryReadField<TField>(String, out TField)

Attempts to read a field from the collection as the specified type.

Declaration

public virtual bool TryReadField<TField>(string name, out TField instance)
    where TField : IField, new()

Parameters

Type	Name	Description
System.String	name	The name of the field to be read.
TField	instance	The resulting instance if successful.

Returns

Type	Description
System.Boolean	True if successful, otherwise false.

Type Parameters

Name	Description
TField	The type of object to return.

TryReadFields(Type, out Object)

Attempts to read the collection of fields as the specified type.

Declaration

public bool TryReadFields(Type type, out object instance)

Parameters

Type	Name	Description
System.Type	type	The type of object to return.
System.Object	instance	A new instance of type if successful.

Returns

Type	Description
System.Boolean	True if successful, otherwise false.

TryReadFields<T>(out T)

Attempts to read the collection of fields as the specified type.

Declaration

public virtual bool TryReadFields<T>(out T instance)
    where T : new()

Parameters

Type	Name	Description
T	instance	The resulting instance if successful.

Returns

Type	Description
System.Boolean	True if successful, otherwise false.

Type Parameters

Name	Description
T	The type of object to return.

Implements

IFieldsReader