TIWCGJQGridCol Class

Initializes a new instance of the TIWCGJQGridCol class. (Overrides TIWCGJSon.Create(TCollection).)

Represents the destructor of the TIWCGJQGridCol class. (Overrides TIWCGJSon.Destroy.)

Defines the alignment of the cell in the Body layer, not in header cell. Possible values: left, center, right.

Represents property Caption.

Column caption align

This option allow to add classes to the column. If more than one class will be used a space should be set. By example classes:'class1 class2' will set a class1 and class2 to every cell on that column. In the grid css there is a predefined class ui-ellipsis which allow to attach ellipsis to a particular row. Also this will work in FireFox too.

Represents property ColModel.

Governs format of sorttype:date (when datetype is set to local) and editrules {date:true} fields. Determines the expected date format for that column. Uses a PHP-like date formatting. Currently ”/”, ”-”, and ”.” are supported as date separators. Valid formats are: y,Y,yyyy for four digits year YY, yy for two digits year m,mm for months d,dd for days.

The default value for the search field. This option is used only in Custom Searching and will be set as initial search.

Defines if the field is editable. This option is used in cell, inline and form modules. See editing

Array of allowed options (attributes) for edittype option editing

sets additional rules for the editable field editing

Defines the edit type for inline and form editing Possible values: text, textarea, select, checkbox, password, button, image and file. See also editing

If set to asc or desc, the column will be sorted in that direction on first sort.Subsequent sorts of the column will toggle as usual

If set to true this option does not allow recalculation of the width of the column if shrinkToFit option is set to true. Also the width does not change if a setGridWidth method is used to change the grid width.

array Format options can be defined for particular columns, overwriting the defaults from the language file. See Formatter for more details.

Represents property FormatOptionsActions.

Represents property FormatOptionsCheckBox.

Represents property FormatOptionsControl.

Represents property FormatOptionsCurrency.

Represents property FormatOptionsDate.

Represents property FormatOptionsDateTime.

Represents property FormatOptionsEMail.

Represents property FormatOptionsFunction.

Represents property FormatOptionsGetData.

Represents property FormatOptionsImage.

Represents property FormatOptionsInteger.

Represents property FormatOptionsLink.

Represents property FormatOptionsLinkClick.

Represents property FormatOptionsNumber.

Represents property FormatOptionsSelect.

Represents property FormatOptionsShowLink.

Represents property FormatOptionsStaticImage.

Represents property FormatOptionsTime.

The predefined types (string) or custom function name that controls the format of this field. See Formatter for more details.

Defines various options for form editing. See Form options

If set to true determines that this column will be frozen after calling the setFrozenColumns method

Defines if this column is hidden at initialization.

If set to true this column will not appear in the modal dialog where users can choose which columns to show or hide. See Show/Hide Columns.

Set the index name when sorting. Passed as sidx parameter.

Defines the json mapping for the column in the incoming json string. See Retrieving Data

In case if there is no id from server, this can be set as as id for the unique row id. Only one column can have this property. If there are more than one key the grid finds the first one and the second is ignored.

label string When colNames array is empty, defines the heading for this column. If both the colNames array and this setting are empty, the heading for this column comes from the name property.

Represents property MappingName.

Set the unique name in the grid for the column. This property is required. As well as other words used as property/event names, the reserved words (which cannot be used for names) include subgrid, cb and rn.

This function add attributes to the cell during the creation of the data - i.e dynamically. By example all valid attributes for the table cell can be used or a style attribute with different properties. The function should return string. Parameters passed to this function are: rowId - the id of the row val - the value which will be added in the cell rawObject - the raw object of the data row - i.e if datatype is json - array, if datatype is xml xml node. cm - all the properties of this column listed in the colModel rdata - the data row which will be inserted in the row. This parameter is array of type name:value, where name is the name in colModel

Custom function to “unformat” a value of the cell when used in editing See Custom Formatter. (Unformat is also called during sort operations. The value returned by unformat is the value compared during the sort.)

Define the Column Position

The real database field name in case when you have non standard field name, like spaces and/or special chars.

Important Note
Check the Name property, for proper work of component, the name must be unique and clear (without the spaces and special chars)!

Defines if the column can be re sized true

When used in search modules, disables or enables searching on that column. Search Configuration

Defines the search options used searching Search Configuration

Object which contain additional conditions for validating user input

Defines is this can be sorted.

Define the SQLPrefix to apply to each Column for Search Operations. Fi, if SQLPrefix = 'Customers' and Name = 'Code', the SQL formed will be 'Customers.Code';

Represents property SQLName.

Define the SQLPrefix to apply to each Column for Search Operations. Fi, if SQLPrefix = 'Customers' and Name = 'Code', the SQL formed will be 'Customers.Code';

Determines the type of the element when searching. See Search Configuration

Summary template

Type of summary

Valid only in Search ToolBar and edittype : 'select' and describes the url from where we can get already-constructed select element

If this option is false the title is not displayed in that column when we hover a cell with the mouse

This option is valid only when viewGridRow method is activated. When the option is set to false the column is does not appear in view Form

Set the initial width of the column, in pixels. This value currently can not be set as percentage

Defines the xml mapping for the column in the incomming xml file. Use a CCS specification for this See Retrieving Data

Called to get the Edit Values when Formatter is Select.

Get the Image for each row. For columns with formatter Image

Get the Image for each row. For columns with formatter Image

To Get a Link for columns with formatter ShowLink

Called to get the Search Values when Formatter is Select.

This event is used when Col.Formatter = gcfControl and FormatOptionsControl.CreateCellsOnRender = True. When assigned, allows to set the properties to the cell controls, using FindCellControl

This event is used when Col.Formatter = gcfControl and FormatOptionsControl.CreateCellsOnRender = False. It's called before grids create a cell control based on ControlTemplate. User should update the properties in the ControlTemplate and childs. After this, the Grid will create cloned cell controls