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

More...

Inheritance diagram for Ext.Net.ModelField.Config:
Ext.Net.BaseItem.Config Ext.Net.IApply

Static Public Member Functions

static implicit operator ModelField.Builder (ModelField.Config config)
 
- Static Public Member Functions inherited from Ext.Net.BaseItem.Config
static Config Deserialize (string config)
 
static TConfig Deserialize< TConfig > (string config)
 

Properties

virtual bool AllowNull [get, set]
 Use when converting received data into a int, float, bool or string type. More...
 
JFunction Calculate [get]
 
virtual ? bool Critical [get, set]
 
virtual string Name [get, set]
 The name by which the field is referenced within the Model. More...
 
virtual string Mapping [get, set]
 (Optional) A path expression for use by the Ext.data.reader.Reader implementation that is creating the Model to extract the Field value from the data object. If the path expression is the same as the field name, the mapping may be omitted. More...
 
JFunction MappingFunction [get]
 
virtual string ServerMapping [get, set]
 
virtual ModelFieldType Type [get, set]
 (Optional) The data type for automatic conversion from received data to the stored value if convert has not been specified. More...
 
virtual SortTypeMethod SortType [get, set]
 Sort method More...
 
virtual SortDirection SortDir [get, set]
 (Optional) Initial direction to sort More...
 
virtual EmptyValue SubmitEmptyValue [get, set]
 Empty value representation during saving (default value as None) More...
 
JFunction CustomSortType [get]
 A function which converts a Field's value to a comparable value in order to ensure correct sort ordering. More...
 
JFunction Serialize [get]
 A function which converts the Model's value for this Field into a form which can be used by whatever Writer is being used to sync data with the server. More...
 
JFunction Convert [get]
 (Optional) A function which converts the value provided by the Reader into an object that will be stored in the Record. More...
 
virtual bool NullConvert [get, set]
 
virtual string DateFormat [get, set]
 (Optional) Used when converting received data into a Date when the type is specified as "date". More...
 
virtual string DateWriteFormat [get, set]
 Used to provide a custom format when serializing dates with a writer. If this is not specified, the DateFormat will be used. More...
 
virtual string DateReadFormat [get, set]
 Used when converting received data into a Date when the Type is specified as "Date". This configuration takes precedence over DateFormat. More...
 
virtual string DefaultValue [get, set]
 (Optional) The default value used when a Model is being created by a Reader when the item referenced by the mapping does not exist in the data object (i.e. undefined). (defaults to "") More...
 
virtual ? bool Persist [get, set]
 False to exclude this field from the Ext.data.Model.modified fields in a model. This will also exclude the field from being written using a Ext.data.writer.Writer. This option is useful when model fields are used to keep state on the client but do not need to be persisted to the server. Defaults to true. More...
 
virtual bool HtmlEncode [get, set]
 Configure true to encode html in the field before sync More...
 
virtual string ModelName [get, set]
 The Ext.data.Model associated with this field More...
 
ModelCollection Model [get]
 
ModelFieldCollection Fields [get]
 The fields for this complex field. More...
 
virtual string[] Depends [get, set]
 The field name or names within the Model on which the value of this field depends, and from which a new value may be calculated. More...
 
virtual bool Unique [get, set]
 true if the value of this field is unique amongst all instances. More...
 
virtual string ReferenceString [get, set]
 The name of the entity referenced by this field. In most databases, this relationship is represented by a "foreign key". More...
 
FieldReference Reference [get]
 Reference can also describe ownership between the entities More...
 
virtual string VersionProperty [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 ()
 

Detailed Description

Member Function Documentation

◆ operator ModelField.Builder()

static implicit Ext.Net.ModelField.Config.operator ModelField.Builder ( ModelField.Config  config)
inlinestatic

Property Documentation

◆ AllowNull

virtual bool Ext.Net.ModelField.Config.AllowNull
getset

Use when converting received data into a int, float, bool or string type.

◆ Calculate

JFunction Ext.Net.ModelField.Config.Calculate
get

◆ Convert

JFunction Ext.Net.ModelField.Config.Convert
get

(Optional) A function which converts the value provided by the Reader into an object that will be stored in the Record.

◆ Critical

virtual ? bool Ext.Net.ModelField.Config.Critical
getset

◆ CustomSortType

JFunction Ext.Net.ModelField.Config.CustomSortType
get

A function which converts a Field's value to a comparable value in order to ensure correct sort ordering.

◆ DateFormat

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

(Optional) Used when converting received data into a Date when the type is specified as "date".

◆ DateReadFormat

virtual string Ext.Net.ModelField.Config.DateReadFormat
getset

Used when converting received data into a Date when the Type is specified as "Date". This configuration takes precedence over DateFormat.

◆ DateWriteFormat

virtual string Ext.Net.ModelField.Config.DateWriteFormat
getset

Used to provide a custom format when serializing dates with a writer. If this is not specified, the DateFormat will be used.

◆ DefaultValue

virtual string Ext.Net.ModelField.Config.DefaultValue
getset

(Optional) The default value used when a Model is being created by a Reader when the item referenced by the mapping does not exist in the data object (i.e. undefined). (defaults to "")

◆ Depends

virtual string [] Ext.Net.ModelField.Config.Depends
getset

The field name or names within the Model on which the value of this field depends, and from which a new value may be calculated.

◆ Fields

ModelFieldCollection Ext.Net.ModelField.Config.Fields
get

The fields for this complex field.

◆ HtmlEncode

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

Configure true to encode html in the field before sync

◆ Mapping

virtual string Ext.Net.ModelField.Config.Mapping
getset

(Optional) A path expression for use by the Ext.data.reader.Reader implementation that is creating the Model to extract the Field value from the data object. If the path expression is the same as the field name, the mapping may be omitted.

◆ MappingFunction

JFunction Ext.Net.ModelField.Config.MappingFunction
get

◆ Model

ModelCollection Ext.Net.ModelField.Config.Model
get

◆ ModelName

virtual string Ext.Net.ModelField.Config.ModelName
getset

The Ext.data.Model associated with this field

◆ Name

virtual string Ext.Net.ModelField.Config.Name
getset

The name by which the field is referenced within the Model.

◆ NullConvert

virtual bool Ext.Net.ModelField.Config.NullConvert
getset

◆ Persist

virtual ? bool Ext.Net.ModelField.Config.Persist
getset

False to exclude this field from the Ext.data.Model.modified fields in a model. This will also exclude the field from being written using a Ext.data.writer.Writer. This option is useful when model fields are used to keep state on the client but do not need to be persisted to the server. Defaults to true.

◆ Reference

FieldReference Ext.Net.ModelField.Config.Reference
get

Reference can also describe ownership between the entities

◆ ReferenceString

virtual string Ext.Net.ModelField.Config.ReferenceString
getset

The name of the entity referenced by this field. In most databases, this relationship is represented by a "foreign key".

◆ Serialize

JFunction Ext.Net.ModelField.Config.Serialize
get

A function which converts the Model's value for this Field into a form which can be used by whatever Writer is being used to sync data with the server.

◆ ServerMapping

virtual string Ext.Net.ModelField.Config.ServerMapping
getset

◆ SortDir

virtual SortDirection Ext.Net.ModelField.Config.SortDir
getset

(Optional) Initial direction to sort

◆ SortType

virtual SortTypeMethod Ext.Net.ModelField.Config.SortType
getset

Sort method

◆ SubmitEmptyValue

virtual EmptyValue Ext.Net.ModelField.Config.SubmitEmptyValue
getset

Empty value representation during saving (default value as None)

◆ Type

virtual ModelFieldType Ext.Net.ModelField.Config.Type
getset

(Optional) The data type for automatic conversion from received data to the stored value if convert has not been specified.

◆ Unique

virtual bool Ext.Net.ModelField.Config.Unique
getset

true if the value of this field is unique amongst all instances.

◆ VersionProperty

virtual string Ext.Net.ModelField.Config.VersionProperty
getset


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