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

More...

Inheritance diagram for Ext.Net.JsonWriter.Builder< TJsonWriter, TBuilder >:
Ext.Net.AbstractWriter.Builder< TJsonWriter, TBuilder >

Public Member Functions

 Builder (TJsonWriter component)
 
virtual TBuilder RootProperty (string rootProperty)
 The HTTP parameter name by which JSON encoded records will be passed to the server if the encode option is true. More...
 
virtual TBuilder Encode (bool encode)
 Configure true to send record data (all record fields if writeAllFields is true) as a JSON encoded HTTP parameter named by the root configuration. More...
 
virtual TBuilder AllowSingle (bool allowSingle)
 False to ensure that records are always wrapped in an array, even if there is only one record being sent. When there is more than one record, they will always be encoded into an array. More...
 
virtual TBuilder ExpandData (bool expandData)
 
 Builder ()
 
 Builder (JsonWriter component)
 
 Builder (JsonWriter.Config config)
 
- Public Member Functions inherited from Ext.Net.AbstractWriter.Builder< TJsonWriter, TBuilder >
 Builder (TAbstractWriter component)
 
virtual TBuilder AllDataOptions (Action< DataOptions > action)
 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 TBuilder NameProperty (string nameProperty)
 This property is used to read the key for each value that will be sent to the server. More...
 
virtual TBuilder WriteAllFields (bool writeAllFields)
 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...
 
virtual TBuilder GetRecordData (Action< JFunction > action)
 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...
 
virtual TBuilder FilterRecord (Action< JFunction > action)
 
virtual TBuilder FilterField (Action< JFunction > action)
 
virtual TBuilder Prepare (Action< JFunction > action)
 
virtual TBuilder ExcludeId (bool excludeId)
 
virtual TBuilder SkipIdForPhantomRecords (bool skipIdForPhantomRecords)
 
virtual TBuilder SkipPhantomId (bool skipPhantomId)
 
virtual TBuilder HtmlEncode (bool htmlEncode)
 Configure true to encode html in record data before sending More...
 
virtual TBuilder ClientIdProperty (string clientIdProperty)
 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 TBuilder DateFormat (string dateFormat)
 
virtual TBuilder PartialDataOptions (Action< DataOptions > action)
 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...
 
virtual TBuilder Transform (Action< TransformFunction > action)
 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 TBuilder WriteRecordId (bool writeRecordId)
 

Static Public Member Functions

static implicit operator Builder (JsonWriter component)
 

Detailed Description

Type Constraints
TJsonWriter :JsonWriter 
TBuilder :Builder 
TBuilder :TJsonWriter 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.JsonWriter.Builder< TJsonWriter, TBuilder >.Builder ( TJsonWriter  component)
inline

◆ Builder() [2/4]

Ext.Net.JsonWriter.Builder< TJsonWriter, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.JsonWriter.Builder< TJsonWriter, TBuilder >.Builder ( JsonWriter  component)
inline

◆ Builder() [4/4]

Ext.Net.JsonWriter.Builder< TJsonWriter, TBuilder >.Builder ( JsonWriter.Config  config)
inline

Member Function Documentation

◆ AllowSingle()

virtual TBuilder Ext.Net.JsonWriter.Builder< TJsonWriter, TBuilder >.AllowSingle ( bool  allowSingle)
inlinevirtual

False to ensure that records are always wrapped in an array, even if there is only one record being sent. When there is more than one record, they will always be encoded into an array.

◆ Encode()

virtual TBuilder Ext.Net.JsonWriter.Builder< TJsonWriter, TBuilder >.Encode ( bool  encode)
inlinevirtual

Configure true to send record data (all record fields if writeAllFields is true) as a JSON encoded HTTP parameter named by the root configuration.

◆ ExpandData()

virtual TBuilder Ext.Net.JsonWriter.Builder< TJsonWriter, TBuilder >.ExpandData ( bool  expandData)
inlinevirtual

◆ operator Builder()

static implicit Ext.Net.JsonWriter.Builder< TJsonWriter, TBuilder >.operator Builder ( JsonWriter  component)
inlinestatic

◆ RootProperty()

virtual TBuilder Ext.Net.JsonWriter.Builder< TJsonWriter, TBuilder >.RootProperty ( string  rootProperty)
inlinevirtual

The HTTP parameter name by which JSON encoded records will be passed to the server if the encode option is true.


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