Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.AbstractReader.Config Class Reference

More...

Inheritance diagram for Ext.Net.AbstractReader.Config:
Ext.Net.BaseItem.Config Ext.Net.IApply Ext.Net.JsonReader.Config Ext.Net.XmlReader.Config Ext.Net.ArrayReader.Config Ext.Net.ODataReader.Config

Properties

virtual string GroupRootProperty [get, set]
 Name of the property from which to retrieve remote grouping summary information. More...
 
virtual string IDProperty [get, set]
 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 bool ImplicitIncludes [get, set]
 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 ? bool KeepRawData [get, set]
 
virtual bool ReadRecordsOnFailure [get, set]
 True to read extract the records from a data packet even if the success property returns false. Defaults to: true More...
 
virtual string RootProperty [get, set]
 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 string SuccessProperty [get, set]
 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 string SummaryRootProperty [get, set]
 Name of the property from which to retrieve remote summary information. More...
 
virtual string TotalProperty [get, set]
 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...
 
TransformFunction Transform [get]
 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 string TypeProperty [get, set]
 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 string MessageProperty [get, set]
 The name of the property which contains a response message for exception handling. More...
 
virtual JFunction MessagePropertyFn [get, set]
 The name of the property which contains a response message for exception handling. More...
 
virtual string ModelName [get, set]
 The Ext.data.Model associated with this reader More...
 

Additional Inherited Members

- Public Member Functions inherited from Ext.Net.BaseItem.Config
override string ToString ()
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
new Type GetType ()
 
object ApplyIf (object obj)
 
Apply< T > (object obj)
 
object Apply (object obj)
 
virtual string Serialize ()
 
- Static Public Member Functions inherited from Ext.Net.BaseItem.Config
static Config Deserialize (string config)
 
static TConfig Deserialize< TConfig > (string config)
 

Detailed Description

Property Documentation

◆ GroupRootProperty

virtual string Ext.Net.AbstractReader.Config.GroupRootProperty
getset

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

◆ IDProperty

virtual string Ext.Net.AbstractReader.Config.IDProperty
getset

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 bool Ext.Net.AbstractReader.Config.ImplicitIncludes
getset

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 ? bool Ext.Net.AbstractReader.Config.KeepRawData
getset

◆ MessageProperty

virtual string Ext.Net.AbstractReader.Config.MessageProperty
getset

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

◆ MessagePropertyFn

virtual JFunction Ext.Net.AbstractReader.Config.MessagePropertyFn
getset

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

◆ ModelName

virtual string Ext.Net.AbstractReader.Config.ModelName
getset

The Ext.data.Model associated with this reader

◆ ReadRecordsOnFailure

virtual bool Ext.Net.AbstractReader.Config.ReadRecordsOnFailure
getset

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

◆ RootProperty

virtual string Ext.Net.AbstractReader.Config.RootProperty
getset

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.

◆ SuccessProperty

virtual string Ext.Net.AbstractReader.Config.SuccessProperty
getset

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 string Ext.Net.AbstractReader.Config.SummaryRootProperty
getset

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

◆ TotalProperty

virtual string Ext.Net.AbstractReader.Config.TotalProperty
getset

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

TransformFunction Ext.Net.AbstractReader.Config.Transform
get

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.

◆ TypeProperty

virtual string Ext.Net.AbstractReader.Config.TypeProperty
getset

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: