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

More...

Inheritance diagram for Ext.Net.AbstractWriter.Config:
Ext.Net.BaseItem.Config Ext.Net.IApply Ext.Net.JsonWriter.Config Ext.Net.XmlWriter.Config

Properties

DataOptions AllDataOptions [get]
 This object contains the options passed to Ext.data.Model.getData when writing Ext.data.Model.phantom records or when writeAllFields is set to true. More...
 
virtual string NameProperty [get, set]
 This property is used to read the key for each value that will be sent to the server. More...
 
virtual bool WriteAllFields [get, set]
 True to write all fields from the record to the server. If set to false it will only send the fields that were modified. Defaults to false. More...
 
JFunction GetRecordData [get]
 Formats the data for each record before sending it to the server. This method should be overridden to format the data in a way that differs from the default. More...
 
JFunction FilterRecord [get]
 
JFunction FilterField [get]
 
JFunction Prepare [get]
 
virtual bool ExcludeId [get, set]
 
virtual bool SkipIdForPhantomRecords [get, set]
 
virtual bool SkipPhantomId [get, set]
 
virtual bool HtmlEncode [get, set]
 Configure true to encode html in record data before sending More...
 
virtual string ClientIdProperty [get, set]
 When specified this property causes the Ext.data.Model.idProperty of newly created records to be sent to the server as this name instead of the value of the idProperty. More...
 
virtual string DateFormat [get, set]
 
DataOptions PartialDataOptions [get]
 This object contains the options passed to Ext.data.Model.getData when writing non Ext.data.Model.phantom records or when writeAllFields is set to false. More...
 
TransformFunction Transform [get]
 If a transform function is set, it will be invoked just before writeRecords executes. It is passed the unserialized data object and the request 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 bool WriteRecordId [get, set]
 

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

◆ AllDataOptions

DataOptions Ext.Net.AbstractWriter.Config.AllDataOptions
get

This object contains the options passed to Ext.data.Model.getData when writing Ext.data.Model.phantom records or when writeAllFields is set to true.

◆ ClientIdProperty

virtual string Ext.Net.AbstractWriter.Config.ClientIdProperty
getset

When specified this property causes the Ext.data.Model.idProperty of newly created records to be sent to the server as this name instead of the value of the idProperty.

◆ DateFormat

virtual string Ext.Net.AbstractWriter.Config.DateFormat
getset

◆ ExcludeId

virtual bool Ext.Net.AbstractWriter.Config.ExcludeId
getset

◆ FilterField

JFunction Ext.Net.AbstractWriter.Config.FilterField
get

◆ FilterRecord

JFunction Ext.Net.AbstractWriter.Config.FilterRecord
get

◆ GetRecordData

JFunction Ext.Net.AbstractWriter.Config.GetRecordData
get

Formats the data for each record before sending it to the server. This method should be overridden to format the data in a way that differs from the default.

◆ HtmlEncode

virtual bool Ext.Net.AbstractWriter.Config.HtmlEncode
getset

Configure true to encode html in record data before sending

◆ NameProperty

virtual string Ext.Net.AbstractWriter.Config.NameProperty
getset

This property is used to read the key for each value that will be sent to the server.

◆ PartialDataOptions

DataOptions Ext.Net.AbstractWriter.Config.PartialDataOptions
get

This object contains the options passed to Ext.data.Model.getData when writing non Ext.data.Model.phantom records or when writeAllFields is set to false.

◆ Prepare

JFunction Ext.Net.AbstractWriter.Config.Prepare
get

◆ SkipIdForPhantomRecords

virtual bool Ext.Net.AbstractWriter.Config.SkipIdForPhantomRecords
getset

◆ SkipPhantomId

virtual bool Ext.Net.AbstractWriter.Config.SkipPhantomId
getset

◆ Transform

TransformFunction Ext.Net.AbstractWriter.Config.Transform
get

If a transform function is set, it will be invoked just before writeRecords executes. It is passed the unserialized data object and the request 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.

◆ WriteAllFields

virtual bool Ext.Net.AbstractWriter.Config.WriteAllFields
getset

True to write all fields from the record to the server. If set to false it will only send the fields that were modified. Defaults to false.

◆ WriteRecordId

virtual bool Ext.Net.AbstractWriter.Config.WriteRecordId
getset


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