Class FieldsReader
Version: 21.x
Implements reading of a collection of fields as a specified type.
Inheritance
System.Object
FieldsReader
Implements
Namespace: Sitecore.LayoutService.Client.Response.Model
Assembly: Sitecore.LayoutService.Client.Abstractions.dll
Syntax
Constructors
FieldsReader()
Declaration
Properties
Fields
Gets or sets the Fields associated with this instance.
Declaration
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
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
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(String)
Reads a field from the collection as the specified type.
Declaration
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
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()
Reads the collection of fields as the specified type.
Declaration
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
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(String, out TField)
Attempts to read a field from the collection as the specified type.
Declaration
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
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(out T)
Attempts to read the collection of fields as the specified type.
Declaration
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
If you have suggestions for improving this article, let us know!