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

Public Member Functions
	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)

Public Member Functions inherited from Ext.Net.BaseItem.Builder< TAbstractWriter, TBuilder >
	Builder (TItem item)

virtual TItem	ToComponent ()
	Get the instance of the underlying StateManagedItem. More...

virtual TBuilder	CustomConfig (Action< ConfigItemCollection > action)
	Collection of custom js config More...

Additional Inherited Members
Static Public Member Functions inherited from Ext.Net.BaseItem.Builder< TAbstractWriter, TBuilder >
static implicit	operator TItem (BaseItem.Builder< TItem, TBuilder > builder)
	Implicit conversion of a TItem object directly into a TComponent. More...

Protected Attributes inherited from Ext.Net.BaseItem.Builder< TAbstractWriter, TBuilder >
TItem	item

Detailed Description

Type Constraints

TAbstractWriter	:	AbstractWriter
TBuilder	:	Builder
TBuilder	:	TAbstractWriter
TBuilder	:	TBuilder

Constructor & Destructor Documentation

◆ Builder()

Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.Builder ( TAbstractWriter component )

inline

Member Function Documentation

◆ AllDataOptions()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.AllDataOptions ( Action< DataOptions > action )

inlinevirtual

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.

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ ClientIdProperty()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.ClientIdProperty ( string clientIdProperty )

inlinevirtual

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 TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.DateFormat ( string dateFormat )

inlinevirtual

◆ ExcludeId()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.ExcludeId ( bool excludeId )

inlinevirtual

◆ FilterField()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.FilterField ( Action< JFunction > action )

inlinevirtual

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ FilterRecord()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.FilterRecord ( Action< JFunction > action )

inlinevirtual

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ GetRecordData()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.GetRecordData ( Action< JFunction > action )

inlinevirtual

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

action The action delegate

Returns: An instance of TBuilder

◆ HtmlEncode()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.HtmlEncode ( bool htmlEncode )

inlinevirtual

Configure true to encode html in record data before sending

◆ NameProperty()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.NameProperty ( string nameProperty )

inlinevirtual

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

◆ PartialDataOptions()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.PartialDataOptions ( Action< DataOptions > action )

inlinevirtual

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.

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ Prepare()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.Prepare ( Action< JFunction > action )

inlinevirtual

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ SkipIdForPhantomRecords()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.SkipIdForPhantomRecords ( bool skipIdForPhantomRecords )

inlinevirtual

◆ SkipPhantomId()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.SkipPhantomId ( bool skipPhantomId )

inlinevirtual

◆ Transform()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.Transform ( Action< TransformFunction > action )

inlinevirtual

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.

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ WriteAllFields()

virtual TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.WriteAllFields ( bool writeAllFields )

inlinevirtual

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 TBuilder Ext.Net.AbstractWriter.Builder< TAbstractWriter, TBuilder >.WriteRecordId ( bool writeRecordId )

inlinevirtual

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

AbstractWriterBuilder.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Builder()

Member Function Documentation

◆ AllDataOptions()

◆ ClientIdProperty()

◆ DateFormat()

◆ ExcludeId()

◆ FilterField()

◆ FilterRecord()

◆ GetRecordData()

◆ HtmlEncode()

◆ NameProperty()

◆ PartialDataOptions()

◆ Prepare()

◆ SkipIdForPhantomRecords()

◆ SkipPhantomId()

◆ Transform()

◆ WriteAllFields()

◆ WriteRecordId()