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

Writer that outputs model data in XML format More...

Inheritance diagram for Ext.Net.XmlWriter:
Ext.Net.AbstractWriter Ext.Net.BaseItem Ext.Net.IAlias Ext.Net.IXObject Ext.Net.IBase

Classes

class  Builder
 
class  Config
 

Public Member Functions

 XmlWriter ()
 
XmlWriter.Builder ToBuilder ()
 
override IControlBuilder ToNativeBuilder ()
 
 XmlWriter (Config config)
 
- Public Member Functions inherited from Ext.Net.BaseItem
virtual bool HasExplicitValue (string name)
 
void EnsureDataBind ()
 
virtual void Call (string name)
 
virtual void Call (string name, params object[] args)
 
virtual void AddScript (string script)
 
virtual void AddScript (string script, params object[] args)
 
virtual bool IsEmptyObject ()
 
Apply< T > (IApply config)
 
BaseItem Apply (object config)
 
virtual void LoadViewState (object state)
 
virtual object SaveViewState ()
 
virtual void TrackViewState ()
 
void SetDirty ()
 
virtual void DataBind ()
 

Static Public Member Functions

static implicit operator XmlWriter (XmlWriter.Config config)
 

Properties

override string InstanceOf [get]
 
override string Type [get]
 Alias More...
 
virtual string DefaultDocumentRoot [get, set]
 The root to be used if documentRoot is empty and a root is required to form a valid XML document. More...
 
virtual string DocumentRoot [get, set]
 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 string Header [get, set]
 A header to use in the XML document (such as setting the encoding or version). Defaults to ''. More...
 
virtual string Record [get, set]
 The name of the node to use for each record. Defaults to 'record'. More...
 
override ConfigOptionsCollection ConfigOptions [get]
 
- Properties inherited from Ext.Net.AbstractWriter
override string InstanceOf [get]
 
abstract string Type [get]
 Alias More...
 
virtual 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. NOTE: The serialize option cannot be used here. Defaults to: {persist: true} More...
 
virtual string AllDataOptionsProxy [get]
 A proxy to serialize AllDataOptions More...
 
virtual string NameProperty [get, set]
 This property is used to read the key for each value that will be sent to the server. For example: 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...
 
virtual 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. Parameters record : Object The record that we are writing to the server. Returns An object literal of name/value keys to be written to the server. By default this method returns the data property on the record. More...
 
virtual JFunction FilterRecord [get]
 
virtual JFunction FilterField [get]
 
virtual 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]
 
string PropertyName [get]
 
virtual 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. NOTE: The serialize option cannot be used here. Defaults to: {changes: true, critical: true} More...
 
virtual string PartialDataOptionsProxy [get]
 A proxy to serialize PartialDataOptions More...
 
virtual 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. Example usage: Ext.create('Ext.data.Store', { model: 'User', proxy: { type: 'ajax', url : 'users.json', writer: { type: 'json', transform: { fn: function(data, request) { /// do some manipulation of the unserialized data object return data; }, scope: this } } } }); More...
 
virtual string TransformProxy [get]
 A proxy to render .Transform to client More...
 
virtual bool WriteRecordId [get, set]
 By default, each record's id is always included in the output for non-phantom records since in most cases the id will be required on the server to process the record action. This is helpful since the id will normally not be modified, and so would not be sent to the server unless writeAllFields was explicitly enabled. However, there are cases where it is not desirable for the record id to be passed in the data directly. For example, when using a RESTful API the record id would typically be appended to the url instead. Defaults to: true More...
 
override ConfigOptionsCollection ConfigOptions [get]
 
- Properties inherited from Ext.Net.BaseItem
virtual string InstanceOf [get]
 
ItemState State [get]
 
virtual DefaultValueMode DefaultValueMode [get, set]
 
virtual bool DesignMode [get]
 
bool AutoDataBind [get, set]
 
ResourceManager ResourceManager [get]
 
virtual Control Owner [get, set]
 The Owner Control for this Listener. More...
 
virtual bool IsDefault [get]
 Does this object currently represent it's default state. More...
 
bool IsTrackingViewState [get]
 
EventHandlerList Events [get]
 
EventHandler DataBinding
 
Control?? BindingContainer [get]
 
virtual ConfigItemCollection?? CustomConfig [get]
 Collection of custom js config More...
 
virtual ConfigOptionsCollection ConfigOptions [get]
 
virtual ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
System.Web.Mvc.HtmlHelper?? HtmlHelper [get, set]
 
- Properties inherited from Ext.Net.IXObject
ConfigOptionsCollection ConfigOptions [get]
 
ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
DefaultValueMode DefaultValueMode [get, set]
 
- Properties inherited from Ext.Net.IAlias
string PropertyName [get]
 

Additional Inherited Members

- Protected Member Functions inherited from Ext.Net.BaseItem
 BaseItem (Control owner)
 
 BaseItem ()
 
virtual void OwnerUpdate (Control owner)
 
virtual void OnDataBinding (EventArgs e)
 

Detailed Description

Writer that outputs model data in XML format

Constructor & Destructor Documentation

◆ XmlWriter() [1/2]

Ext.Net.XmlWriter.XmlWriter ( )
inline

◆ XmlWriter() [2/2]

Ext.Net.XmlWriter.XmlWriter ( Config  config)
inline

Member Function Documentation

◆ operator XmlWriter()

static implicit Ext.Net.XmlWriter.operator XmlWriter ( XmlWriter.Config  config)
inlinestatic

◆ ToBuilder()

XmlWriter.Builder Ext.Net.XmlWriter.ToBuilder ( )
inline

◆ ToNativeBuilder()

override IControlBuilder Ext.Net.XmlWriter.ToNativeBuilder ( )
inlinevirtual

Reimplemented from Ext.Net.BaseItem.

Property Documentation

◆ ConfigOptions

override ConfigOptionsCollection Ext.Net.XmlWriter.ConfigOptions
get

◆ DefaultDocumentRoot

virtual string Ext.Net.XmlWriter.DefaultDocumentRoot
getset

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

◆ DocumentRoot

virtual string Ext.Net.XmlWriter.DocumentRoot
getset

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 string Ext.Net.XmlWriter.Header
getset

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

◆ InstanceOf

override string Ext.Net.XmlWriter.InstanceOf
get

◆ Record

virtual string Ext.Net.XmlWriter.Record
getset

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

◆ Type

override string Ext.Net.XmlWriter.Type
getprotected

Alias


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