DataGridColumnBuilder<T> Methods
Represents a DataGrid column.
Name | Description |
---|---|
Alignment |
Aligns the content of the column. Mirrors the client-side alignment option. |
Allow |
Specifies whether a user can edit values in the column at runtime. By default, inherits the value of the editing. |
Allow |
Specifies whether a user can edit values in the column at runtime. By default, inherits the value of the editing. |
Allow |
Specifies whether data from this column should be exported. Applies only if the column is visible. Mirrors the client-side allow |
Allow |
Specifies whether data from this column should be exported. Applies only if the column is visible. Mirrors the client-side allow |
Allow |
Specifies whether data can be filtered by this column. Mirrors the client-side allow |
Allow |
Specifies whether data can be filtered by this column. Mirrors the client-side allow |
Allow |
Specifies whether a user can fix the column at runtime. Applies only if column |
Allow |
Specifies whether a user can fix the column at runtime. Applies only if column |
Allow |
Specifies whether the user can group data by values of this column. Applies only when grouping is enabled. Mirrors the client-side allow |
Allow |
Specifies whether the user can group data by values of this column. Applies only when grouping is enabled. Mirrors the client-side allow |
Allow |
Specifies whether the header filter can be used to filter data by this column. Applies only if header |
Allow |
Specifies whether the header filter can be used to filter data by this column. Applies only if header |
Allow |
Specifies whether a user can hide the column using the column chooser at runtime. Applies only if column |
Allow |
Specifies whether a user can hide the column using the column chooser at runtime. Applies only if column |
Allow |
Specifies whether users can reorder this column. Overrides the allow |
Allow |
Specifies whether users can reorder this column. Overrides the allow |
Allow |
Specifies whether a user can resize the column at runtime. Applies only if allow |
Allow |
Specifies whether a user can resize the column at runtime. Applies only if allow |
Allow |
Specifies whether this column can be searched. Applies only if search |
Allow |
Specifies whether this column can be searched. Applies only if search |
Allow |
Specifies whether a user can sort rows by this column at runtime. Applies only if sorting. |
Allow |
Specifies whether a user can sort rows by this column at runtime. Applies only if sorting. |
Auto |
Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this property makes sense only when grouping is allowed for this column. Mirrors the client-side auto |
Auto |
Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this property makes sense only when grouping is allowed for this column. Mirrors the client-side auto |
Buttons |
Provides access to the client-side buttons option that represents a Data |
Buttons |
Allows you to customize buttons in the edit column or create a custom command column. Applies only if the column's type is 'buttons'. Mirrors the client-side buttons option. |
Calculate |
Calculates custom cell values. Use this function to create an unbound data column. Mirrors the client-side calculate |
Calculate |
Calculates custom cell values. Use this function to create an unbound data column. Mirrors the client-side calculate |
Calculate |
Calculates custom display values for column cells. Requires specifying the data |
Calculate |
Calculates custom display values for column cells. Requires specifying the data |
Calculate |
Specifies the column's custom rules to filter data. Mirrors the client-side calculate |
Calculate |
Specifies the column's custom rules to filter data. Mirrors the client-side calculate |
Calculate |
Sets custom column values used to group grid records. Mirrors the client-side calculate |
Calculate |
Sets custom column values used to group grid records. Mirrors the client-side calculate |
Calculate |
Calculates custom values used to sort this column. Mirrors the client-side calculate |
Calculate |
Calculates custom values used to sort this column. Mirrors the client-side calculate |
Caption |
Specifies a caption for the column. Mirrors the client-side caption option. |
Caption |
Specifies a caption for the column. Mirrors the client-side caption option. |
Cell |
Specifies the client-side cell |
Cell |
Specifies the client-side cell |
Cell |
Specifies the client-side cell |
Cell |
Specifies the client-side cell |
Columns |
An array of grid columns. Mirrors the client-side columns option. |
Columns |
Provides access to the client-side columns option that represents a Data |
Columns |
An array of grid columns. Mirrors the client-side columns option. |
Css |
Specifies a CSS class to be applied to the column. Mirrors the client-side css |
Css |
Specifies a CSS class to be applied to the column. Mirrors the client-side css |
Customize |
Customizes the text displayed in column cells. Mirrors the client-side customize |
Customize |
Customizes the text displayed in column cells. Mirrors the client-side customize |
Data |
Binds the column to a field of the data |
Data |
Binds the column to a field of the data |
Data |
Casts column values to a specific data type. Mirrors the client-side data |
Edit |
Specifies the client-side edit |
Edit |
Specifies the client-side edit |
Edit |
Specifies the client-side edit |
Edit |
Specifies the client-side edit |
Editor |
Configures the default UI component used for editing and filtering in the filter row. Mirrors the client-side editor |
Encode |
Mirrors the client-side encode |
Encode |
Mirrors the client-side encode |
Equals |
Determines whether the specified object instances are considered equal. Inherited from Object. |
Equals |
Determines whether the specified object is equal to the current object. Inherited from Object. |
False |
In a boolean column, replaces all false items with a specified text. Applies only if show |
False |
In a boolean column, replaces all false items with a specified text. Applies only if show |
Filter |
Specifies available filter operations. Applies if allow |
Filter |
Obsolete. Specifies available filter operations. Applies if allow |
Filter |
Specifies available filter operations. Applies if allow |
Filter |
Specifies available filter operations. Applies if allow |
Filter |
Specifies whether a user changes the current filter by including (selecting) or excluding (clearing the selection of) values. Applies only if header |
Filter |
Specifies the value to display in the filter row. Mirrors the client-side filter |
Filter |
Sets the values in the header filter. Mirrors the client-side filter |
Filter |
Sets the values in the header filter. Mirrors the client-side filter |
Fixed |
Fixes the column. Mirrors the client-side fixed option. |
Fixed |
Fixes the column. Mirrors the client-side fixed option. |
Fixed |
|
Format |
Mirrors the client-side format option. |
Format |
Mirrors the client-side format option. |
Format |
Mirrors the client-side format object. |
Format |
Mirrors the client-side format option. |
Form |
Configures the form item that the column produces in the editing state. Applies only if editing. |
Get |
Serves as the default hash function. Inherited from Object. |
Get |
Gets the Type of the current instance. Inherited from Object. |
Group |
Specifies the client-side group |
Group |
Specifies the client-side group |
Group |
Specifies the client-side group |
Group |
Specifies the client-side group |
Group |
Specifies the index of a column when grid records are grouped by the values of this column. Mirrors the client-side group |
Group |
Specifies the index of a column when grid records are grouped by the values of this column. Mirrors the client-side group |
Header |
Specifies the client-side header |
Header |
Specifies the client-side header |
Header |
Specifies the client-side header |
Header |
Specifies the client-side header |
Header |
Specifies data settings for the header filter. Mirrors the client-side header |
Hiding |
Specifies the order in which columns are hidden when the UI component adapts to the screen or container size. Ignored if allowtrue and column |
Hiding |
Specifies the order in which columns are hidden when the UI component adapts to the screen or container size. Ignored if allowtrue and column |
Is |
Specifies whether the column organizes other columns into bands. Mirrors the client-side is |
Is |
Specifies whether the column organizes other columns into bands. Mirrors the client-side is |
Lookup |
Specifies properties of a lookup column. Mirrors the client-side lookup object. |
Memberwise |
Creates a shallow copy of the current Object. Inherited from Object. |
Min |
Specifies the minimum width of the column. Mirrors the client-side min |
Min |
Specifies the minimum width of the column. Mirrors the client-side min |
Name |
Specifies the column's unique identifier. If not set in code, this value is inherited from the data |
Name |
Specifies the column's unique identifier. If not set in code, this value is inherited from the data |
Option |
Specifies an option by its name. |
Owner |
Specifies the band column that owns the current column. Accepts the index of the band column in the columns array. Mirrors the client-side owner |
Owner |
Specifies the band column that owns the current column. Accepts the index of the band column in the columns array. Mirrors the client-side owner |
Reference |
Determines whether the specified Object instances are the same instance. Inherited from Object. |
Render |
Specifies whether to render the column after other columns and elements. Use if column cells have a complex template. Requires the width property specified. Mirrors the client-side render |
Render |
Specifies whether to render the column after other columns and elements. Use if column cells have a complex template. Requires the width property specified. Mirrors the client-side render |
Selected |
Specifies a filter operation that applies when users use the filter row to filter the column. Mirrors the client-side selected |
Set |
Specifies a function to be invoked after the user has edited a cell value, but before it is saved in the data source. Mirrors the client-side set |
Set |
Specifies a function to be invoked after the user has edited a cell value, but before it is saved in the data source. Mirrors the client-side set |
Show |
Specifies whether the column displays its values in editors. Mirrors the client-side show |
Show |
Specifies whether the column displays its values in editors. Mirrors the client-side show |
Show |
Specifies whether the column chooser can contain the column header. Mirrors the client-side show |
Show |
Specifies whether the column chooser can contain the column header. Mirrors the client-side show |
Show |
Specifies whether or not to display the column when grid records are grouped by it. Mirrors the client-side show |
Show |
Specifies whether or not to display the column when grid records are grouped by it. Mirrors the client-side show |
Sort |
Specifies the index according to which columns participate in sorting. Mirrors the client-side sort |
Sort |
Specifies the index according to which columns participate in sorting. Mirrors the client-side sort |
Sorting |
Specifies a custom comparison function for sorting. Applies only when sorting is performed on the client. Mirrors the client-side sorting |
Sorting |
Specifies a custom comparison function for sorting. Applies only when sorting is performed on the client. Mirrors the client-side sorting |
Sort |
Specifies the sort order of column values. Mirrors the client-side sort |
To |
Returns a string that represents the current object. Inherited from Object. |
True |
In a boolean column, replaces all true items with a specified text. Applies only if show |
True |
In a boolean column, replaces all true items with a specified text. Applies only if show |
Type |
Specifies the command column that this object customizes. Mirrors the client-side type option. |
Validation |
Specifies validation rules to be checked when cell values are updated. Mirrors the client-side validation |
Visible |
Specifies whether the column is visible, that is, occupies space in the table. Mirrors the client-side visible option. |
Visible |
Specifies whether the column is visible, that is, occupies space in the table. Mirrors the client-side visible option. |
Visible |
Specifies the position of the column regarding other columns in the resulting UI component. Mirrors the client-side visible |
Visible |
Specifies the position of the column regarding other columns in the resulting UI component. Mirrors the client-side visible |
Width |
Specifies the column's width in pixels or as a percentage. Ignored if it is less than min |
Width |
Specifies the column's width in pixels or as a percentage. Ignored if it is less than min |
Width |
Specifies the column's width in pixels or as a percentage. Ignored if it is less than min |
See Also