Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.JsonReader.Builder< TJsonReader, TBuilder > Class Template Reference

More...

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

Public Member Functions

 Builder (TJsonReader component)
 
virtual TBuilder Record (string record)
 The optional location within the JSON response that the record data itself can be found at. See the JsonReader intro docs for more details. This is not often needed and defaults to undefined. More...
 
virtual TBuilder MetaProperty (string metaProperty)
 Name of the property from which to retrieve the metaData attribute. Defaults to: "metaData" More...
 
virtual TBuilder PreserveRawData (bool preserveRawData)
 The reader will keep a copy of the most recent request in the rawData property. For performance reasons, the data object for each record is used directly as the model data. This means that these objects may be modified and thus modify the raw data. To ensure the objects are copied, set this option to true. More...
 
virtual TBuilder UseSimpleAccessors (bool useSimpleAccessors)
 True to ensure that field names/mappings are treated as literals when reading values. Defalts to false. For example, by default, using the mapping "foo.bar.baz" will try and read a property foo from the root, then a property bar from foo, then a property baz from bar. Setting the simple accessors to true will read the property with the name "foo.bar.baz" direct from the root object. More...
 
 Builder ()
 
 Builder (JsonReader component)
 
 Builder (JsonReader.Config config)
 
- Public Member Functions inherited from Ext.Net.AbstractReader.Builder< TJsonReader, TBuilder >
 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)
 

Static Public Member Functions

static implicit operator Builder (JsonReader component)
 

Detailed Description

Type Constraints
TJsonReader :JsonReader 
TBuilder :Builder 
TBuilder :TJsonReader 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.JsonReader.Builder< TJsonReader, TBuilder >.Builder ( TJsonReader  component)
inline

◆ Builder() [2/4]

Ext.Net.JsonReader.Builder< TJsonReader, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.JsonReader.Builder< TJsonReader, TBuilder >.Builder ( JsonReader  component)
inline

◆ Builder() [4/4]

Ext.Net.JsonReader.Builder< TJsonReader, TBuilder >.Builder ( JsonReader.Config  config)
inline

Member Function Documentation

◆ MetaProperty()

virtual TBuilder Ext.Net.JsonReader.Builder< TJsonReader, TBuilder >.MetaProperty ( string  metaProperty)
inlinevirtual

Name of the property from which to retrieve the metaData attribute. Defaults to: "metaData"

◆ operator Builder()

static implicit Ext.Net.JsonReader.Builder< TJsonReader, TBuilder >.operator Builder ( JsonReader  component)
inlinestatic

◆ PreserveRawData()

virtual TBuilder Ext.Net.JsonReader.Builder< TJsonReader, TBuilder >.PreserveRawData ( bool  preserveRawData)
inlinevirtual

The reader will keep a copy of the most recent request in the rawData property. For performance reasons, the data object for each record is used directly as the model data. This means that these objects may be modified and thus modify the raw data. To ensure the objects are copied, set this option to true.

◆ Record()

virtual TBuilder Ext.Net.JsonReader.Builder< TJsonReader, TBuilder >.Record ( string  record)
inlinevirtual

The optional location within the JSON response that the record data itself can be found at. See the JsonReader intro docs for more details. This is not often needed and defaults to undefined.

◆ UseSimpleAccessors()

virtual TBuilder Ext.Net.JsonReader.Builder< TJsonReader, TBuilder >.UseSimpleAccessors ( bool  useSimpleAccessors)
inlinevirtual

True to ensure that field names/mappings are treated as literals when reading values. Defalts to false. For example, by default, using the mapping "foo.bar.baz" will try and read a property foo from the root, then a property bar from foo, then a property baz from bar. Setting the simple accessors to true will read the property with the name "foo.bar.baz" direct from the root object.


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