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

More...

Inheritance diagram for Ext.Net.XmlWriter.Builder< TXmlWriter, TBuilder >:
Ext.Net.AbstractWriter.Builder< TXmlWriter, TBuilder >

Public Member Functions

 Builder (TXmlWriter component)
 
virtual TBuilder DefaultDocumentRoot (string defaultDocumentRoot)
 The root to be used if documentRoot is empty and a root is required to form a valid XML document. More...
 
virtual TBuilder DocumentRoot (string documentRoot)
 The name of the root element of the document. Defaults to 'xmlData'. If there is more than 1 record and the root is not specified, the default document root will still be used to ensure a valid XML document is created. More...
 
virtual TBuilder Header (string header)
 A header to use in the XML document (such as setting the encoding or version). Defaults to ''. More...
 
virtual TBuilder Record (string record)
 The name of the node to use for each record. Defaults to 'record'. More...
 
 Builder ()
 
 Builder (XmlWriter component)
 
 Builder (XmlWriter.Config config)
 
- Public Member Functions inherited from Ext.Net.AbstractWriter.Builder< TXmlWriter, 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 (XmlWriter component)
 

Detailed Description

Type Constraints
TXmlWriter :XmlWriter 
TBuilder :Builder 
TBuilder :TXmlWriter 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.XmlWriter.Builder< TXmlWriter, TBuilder >.Builder ( TXmlWriter  component)
inline

◆ Builder() [2/4]

Ext.Net.XmlWriter.Builder< TXmlWriter, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.XmlWriter.Builder< TXmlWriter, TBuilder >.Builder ( XmlWriter  component)
inline

◆ Builder() [4/4]

Ext.Net.XmlWriter.Builder< TXmlWriter, TBuilder >.Builder ( XmlWriter.Config  config)
inline

Member Function Documentation

◆ DefaultDocumentRoot()

virtual TBuilder Ext.Net.XmlWriter.Builder< TXmlWriter, TBuilder >.DefaultDocumentRoot ( string  defaultDocumentRoot)
inlinevirtual

The root to be used if documentRoot is empty and a root is required to form a valid XML document.

◆ DocumentRoot()

virtual TBuilder Ext.Net.XmlWriter.Builder< TXmlWriter, TBuilder >.DocumentRoot ( string  documentRoot)
inlinevirtual

The name of the root element of the document. Defaults to 'xmlData'. If there is more than 1 record and the root is not specified, the default document root will still be used to ensure a valid XML document is created.

◆ Header()

virtual TBuilder Ext.Net.XmlWriter.Builder< TXmlWriter, TBuilder >.Header ( string  header)
inlinevirtual

A header to use in the XML document (such as setting the encoding or version). Defaults to ''.

◆ operator Builder()

static implicit Ext.Net.XmlWriter.Builder< TXmlWriter, TBuilder >.operator Builder ( XmlWriter  component)
inlinestatic

◆ Record()

virtual TBuilder Ext.Net.XmlWriter.Builder< TXmlWriter, TBuilder >.Record ( string  record)
inlinevirtual

The name of the node to use for each record. Defaults to 'record'.


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