Inheritance diagram for Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >:

Public Member Functions
	Builder (TAbstractReader component)

virtual TBuilder	GroupRootProperty (string groupRootProperty)
	Name of the property from which to retrieve remote grouping summary information. More...

virtual TBuilder	IDProperty (string iDProperty)
	Name of the property within a row object that contains a record identifier value. Defaults to The id of the model. If an idProperty is explicitly specified it will override that of the one specified on the model More...

virtual TBuilder	ImplicitIncludes (bool implicitIncludes)
	True to automatically parse models nested within other models in a response object. See the Ext.data.reader.Reader intro docs for full explanation. Defaults to true. More...

virtual TBuilder	KeepRawData (bool? keepRawData)

virtual TBuilder	ReadRecordsOnFailure (bool readRecordsOnFailure)
	True to read extract the records from a data packet even if the success property returns false. Defaults to: true More...

virtual TBuilder	RootProperty (string rootProperty)
	The name of the property which contains the Array of row objects. For JSON reader it's dot-separated list of property names. For XML reader it's a CSS selector. For array reader it's not applicable. More...

virtual TBuilder	SuccessProperty (string successProperty)
	Name of the property from which to retrieve the success attribute. Defaults to success. See Ext.data.proxy.Proxy.exception for additional information. More...

virtual TBuilder	SummaryRootProperty (string summaryRootProperty)
	Name of the property from which to retrieve remote summary information. More...

virtual TBuilder	TotalProperty (string totalProperty)
	Name of the property from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server. Defaults to total. More...

virtual TBuilder	Transform (Action< TransformFunction > action)
	If a transform function is set, it will be invoked just before readRecords executes. It is passed the raw (deserialized) data object. The transform function returns a data object, which can be a modified version of the original data object, or a completely new data object. The transform can be a function, or an object with a 'fn' key and an optional 'scope' key. More...

virtual TBuilder	TypeProperty (string typeProperty)
	The name of the property in a node raw data block which indicates the type of the model to be created from that raw data. Useful for heterogenous trees. More...

virtual TBuilder	MessageProperty (string messageProperty)
	The name of the property which contains a response message for exception handling. More...

virtual TBuilder	MessagePropertyFn (JFunction messagePropertyFn)
	The name of the property which contains a response message for exception handling. More...

virtual TBuilder	ModelName (string modelName)
	The Ext.data.Model associated with this reader More...

virtual TBuilder	SetGroupRootProperty (string groupRootProperty)

virtual TBuilder	SetSummaryRootProperty (string summaryRootProperty)

virtual TBuilder	SetMessageProperty (string messageProperty)

virtual TBuilder	SetMessageProperty (JFunction messageProperty)

Public Member Functions inherited from Ext.Net.BaseItem.Builder< TAbstractReader, TBuilder >
	Builder (TItem item)

virtual TItem	ToComponent ()
	Get the instance of the underlying StateManagedItem. More...

virtual TBuilder	CustomConfig (Action< ConfigItemCollection > action)
	Collection of custom js config More...

Additional Inherited Members
Static Public Member Functions inherited from Ext.Net.BaseItem.Builder< TAbstractReader, TBuilder >
static implicit	operator TItem (BaseItem.Builder< TItem, TBuilder > builder)
	Implicit conversion of a TItem object directly into a TComponent. More...

Protected Attributes inherited from Ext.Net.BaseItem.Builder< TAbstractReader, TBuilder >
TItem	item

Detailed Description

Type Constraints

TAbstractReader	:	AbstractReader
TBuilder	:	Builder
TBuilder	:	TAbstractReader
TBuilder	:	TBuilder

Constructor & Destructor Documentation

◆ Builder()

Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.Builder ( TAbstractReader component )

inline

Member Function Documentation

◆ GroupRootProperty()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.GroupRootProperty ( string groupRootProperty )

inlinevirtual

Name of the property from which to retrieve remote grouping summary information.

◆ IDProperty()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.IDProperty ( string iDProperty )

inlinevirtual

Name of the property within a row object that contains a record identifier value. Defaults to The id of the model. If an idProperty is explicitly specified it will override that of the one specified on the model

◆ ImplicitIncludes()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.ImplicitIncludes ( bool implicitIncludes )

inlinevirtual

True to automatically parse models nested within other models in a response object. See the Ext.data.reader.Reader intro docs for full explanation. Defaults to true.

◆ KeepRawData()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.KeepRawData ( bool? keepRawData )

inlinevirtual

◆ MessageProperty()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.MessageProperty ( string messageProperty )

inlinevirtual

The name of the property which contains a response message for exception handling.

◆ MessagePropertyFn()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.MessagePropertyFn ( JFunction messagePropertyFn )

inlinevirtual

The name of the property which contains a response message for exception handling.

◆ ModelName()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.ModelName ( string modelName )

inlinevirtual

The Ext.data.Model associated with this reader

◆ ReadRecordsOnFailure()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.ReadRecordsOnFailure ( bool readRecordsOnFailure )

inlinevirtual

True to read extract the records from a data packet even if the success property returns false. Defaults to: true

◆ RootProperty()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.RootProperty ( string rootProperty )

inlinevirtual

The name of the property which contains the Array of row objects. For JSON reader it's dot-separated list of property names. For XML reader it's a CSS selector. For array reader it's not applicable.

◆ SetGroupRootProperty()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.SetGroupRootProperty ( string groupRootProperty )

inlinevirtual

◆ SetMessageProperty() [1/2]

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.SetMessageProperty ( JFunction messageProperty )

inlinevirtual

◆ SetMessageProperty() [2/2]

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.SetMessageProperty ( string messageProperty )

inlinevirtual

◆ SetSummaryRootProperty()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.SetSummaryRootProperty ( string summaryRootProperty )

inlinevirtual

◆ SuccessProperty()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.SuccessProperty ( string successProperty )

inlinevirtual

Name of the property from which to retrieve the success attribute. Defaults to success. See Ext.data.proxy.Proxy.exception for additional information.

◆ SummaryRootProperty()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.SummaryRootProperty ( string summaryRootProperty )

inlinevirtual

Name of the property from which to retrieve remote summary information.

◆ TotalProperty()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.TotalProperty ( string totalProperty )

inlinevirtual

Name of the property from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server. Defaults to total.

◆ Transform()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.Transform ( Action< TransformFunction > action )

inlinevirtual

If a transform function is set, it will be invoked just before readRecords executes. It is passed the raw (deserialized) data object. The transform function returns a data object, which can be a modified version of the original data object, or a completely new data object. The transform can be a function, or an object with a 'fn' key and an optional 'scope' key.

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ TypeProperty()

virtual TBuilder Ext.Net.AbstractReader.Builder< TAbstractReader, TBuilder >.TypeProperty ( string typeProperty )

inlinevirtual

The name of the property in a node raw data block which indicates the type of the model to be created from that raw data. Useful for heterogenous trees.

The documentation for this class was generated from the following file:

AbstractReaderBuilder.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Builder()

Member Function Documentation

◆ GroupRootProperty()

◆ IDProperty()

◆ ImplicitIncludes()

◆ KeepRawData()

◆ MessageProperty()

◆ MessagePropertyFn()

◆ ModelName()

◆ ReadRecordsOnFailure()

◆ RootProperty()

◆ SetGroupRootProperty()

◆ SetMessageProperty() [1/2]

◆ SetMessageProperty() [2/2]

◆ SetSummaryRootProperty()

◆ SuccessProperty()

◆ SummaryRootProperty()

◆ TotalProperty()

◆ Transform()

◆ TypeProperty()