Class GridColumn
Inheritance
System.Object
GridColumn
Assembly: Syncfusion.EJ2.dll
Syntax
public class GridColumn : EJTagHelper
Constructors
GridColumn()
Declaration
Properties
AllowEditing
If allowEditing
set to false, then it disables editing of a particular column.
By default all columns are editable.
Declaration
public bool AllowEditing { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowFiltering
If allowFiltering
set to false, then it disables filtering option and filter bar element of a particular column.
By default all columns are filterable.
Declaration
public bool AllowFiltering { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowGrouping
If allowGrouping
set to false, then it disables grouping of a particular column.
By default all columns are groupable.
Declaration
public bool AllowGrouping { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowReordering
If allowReordering
set to false, then it disables reorder of a particular column.
By default all columns can be reorder.
Declaration
public bool AllowReordering { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowResizing
If allowResizing
set to false, it disables resize option of a particular column.
Declaration
public bool AllowResizing { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowSearching
If allowSearching
set to false, then it disables Searching of a particular column.
By default all columns allow Searching.
Declaration
public bool AllowSearching { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowSorting
If allowSorting
set to false, then it disables sorting option of a particular column.
By default all columns are sortable.
Declaration
public bool AllowSorting { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AutoFit
If autoFit
set to true, then the particular column content width will be
adjusted based on its content in the initial rendering itself.
Setting this property as true is equivalent to calling autoFitColumns
method in the dataBound
event.
Declaration
public bool AutoFit { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ClipMode
Defines the cell content's overflow mode. The available modes are
Clip
- Truncates the cell content when it overflows its area.
Ellipsis
- Displays ellipsis when the cell content overflows its area.
EllipsisWithTooltip
- Displays ellipsis when the cell content overflows its area
also it will display tooltip while hover on ellipsis applied cell.
Declaration
public ClipMode ClipMode { get; set; }
Property Value
Columns
Used to render multiple header rows(stacked headers) on the Grid header.
Declaration
public object Columns { get; set; }
Property Value
Type |
Description |
System.Object |
|
Commands
commands
provides an option to display command buttons in every cell.
The available built-in command buttons are
Edit - Edit the record.
Delete - Delete the record.
Save - Save the record.
Cancel - Cancel the edit state.
Declaration
public object Commands { get; set; }
Property Value
Type |
Description |
System.Object |
|
CustomAttributes
The CSS styles and attributes of the content cells of a particular column can be customized.
Declaration
public object CustomAttributes { get; set; }
Property Value
Type |
Description |
System.Object |
|
It is used to change display value with the given format and does not affect the original data.
Gets the format from the user which can be standard or custom
number
and date
formats.
Declaration
public object CustomFormat { get; set; }
Property Value
Type |
Description |
System.Object |
|
DataSource
Defines the column data source which will act as foreign data source.
Declaration
public object DataSource { get; set; }
Property Value
Type |
Description |
System.Object |
|
DefaultValue
Defines default values for the component when adding a new record to the Grid.
Declaration
public object DefaultValue { get; set; }
Property Value
Type |
Description |
System.Object |
|
DisableHtmlEncode
If disableHtmlEncode
is set to true, it encodes the HTML of the header and content cells.
Declaration
public bool DisableHtmlEncode { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
DisplayAsCheckBox
If displayAsCheckBox
is set to true, it displays the column value as a check box instead of Boolean value.
Declaration
public bool DisplayAsCheckBox { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Edit
Defines the IEditCell
object to customize default edit cell.
Declaration
public object Edit { get; set; }
Property Value
Type |
Description |
System.Object |
|
EditType
Defines the type of component for editing.
Declaration
public string EditType { get; set; }
Property Value
Type |
Description |
System.String |
|
If enableGroupByFormat
set to true, then it groups the particular column by formatted values.
By default no columns are group by format.
Declaration
public bool EnableGroupByFormat { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Field
Defines the field name of column which is mapped with mapping name of DataSource.
The bounded columns can be sort, filter and group etc.,
If the field
name contains “dot”, then it is considered as complex binding.
The field
name must be a valid JavaScript identifier,
the first character must be an alphabet and should not contain spaces and special characters.
Declaration
public string Field { get; set; }
Property Value
Type |
Description |
System.String |
|
Filter
Defines the filter options to customize filtering for the particular column.
@default null
Declaration
public object Filter { get; set; }
Property Value
Type |
Description |
System.Object |
|
FilterBarTemplate
The filterBarTemplate
is used to add a custom component instead of default input component for filter bar.
It have create and read functions.
create: It is used for creating custom components.
read: It is used to perform custom filter action.
Declaration
public object FilterBarTemplate { get; set; }
Property Value
Type |
Description |
System.Object |
|
ForeignKeyField
Defines the mapping column name of the foreign data source.
If it is not defined then the columns.field
will be considered as mapping column name
Declaration
public string ForeignKeyField { get; set; }
Property Value
Type |
Description |
System.String |
|
ForeignKeyValue
Defines the display column name from the foreign data source which will be obtained from comparing local and foreign data
Declaration
public string ForeignKeyValue { get; set; }
Property Value
Type |
Description |
System.String |
|
It is used to change display value with the given format and does not affect the original data.
Gets the format from the user which can be standard or custom
number
and date
formats.
Declaration
public string Format { get; set; }
Property Value
Type |
Description |
System.String |
|
Defines the method which is used to achieve custom formatting from an external function.
This function triggers before rendering of each cell.
Declaration
public object Formatter { get; set; }
Property Value
Type |
Description |
System.Object |
|
Freeze
Defines freeze direction of the grid columns.
Declaration
public FreezeDirection Freeze { get; set; }
Property Value
HeaderTemplate
Defines the column template as string or HTML element ID which is used to add customized element in the column header.
Declaration
public string HeaderTemplate { get; set; }
Property Value
Type |
Description |
System.String |
|
HeaderText
Defines the header text of column which is used to display in column header.
If headerText
is not defined, then field name value will be assigned to header text.
Declaration
public string HeaderText { get; set; }
Property Value
Type |
Description |
System.String |
|
HeaderTextAlign
Define the alignment of column header which is used to align the text of column header.
Declaration
public TextAlign HeaderTextAlign { get; set; }
Property Value
column visibility can change based on its Media Queries
.
hideAtMedia
accepts only valid Media Queries.
Declaration
public string HideAtMedia { get; set; }
Property Value
Type |
Description |
System.String |
|
Index
Gets the unique identifier value of the column. It is used to get the object.
Declaration
public double Index { get; set; }
Property Value
Type |
Description |
System.Double |
|
IsChild
Declaration
protected override bool IsChild { get; }
Property Value
Type |
Description |
System.Boolean |
|
Overrides
IsFrozen
You can use this property to freeze selected columns in grid.
Declaration
public bool IsFrozen { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsIdentity
If isIdentity
is set to true, then this column is considered as identity column.
Declaration
public bool IsIdentity { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsPrimaryKey
If isPrimaryKey
is set to true, considers this column as the primary key constraint.
Declaration
public bool IsPrimaryKey { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
LockColumn
Defines the mapping column name of the foreign data source.
If it is not defined then the columns.field
will be considered as mapping column name
Declaration
public bool LockColumn { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
MaxWidth
Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
Declaration
public string MaxWidth { get; set; }
Property Value
Type |
Description |
System.String |
|
MinWidth
Defines the minimum width of the column in pixels or percentage.
Declaration
public string MinWidth { get; set; }
Property Value
Type |
Description |
System.String |
|
ShowColumnMenu
If showColumnMenu
set to false, then it disable the column menu of a particular column.
By default column menu will show for all columns
Declaration
public bool ShowColumnMenu { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ShowInColumnChooser
If showInColumnChooser
set to false, then hides the particular column in column chooser.
By default all columns are displayed in column Chooser.
Declaration
public bool ShowInColumnChooser { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
SortComparer
It defines the custom sort comparer function.
Declaration
public object SortComparer { get; set; }
Property Value
Type |
Description |
System.Object |
|
Template
Defines the column template that renders customized element in each cell of the column.
It accepts either template string or HTML element ID.
Declaration
public string Template { get; set; }
Property Value
Type |
Description |
System.String |
|
TextAlign
Defines the alignment of the column in both header and content cells.
Declaration
public TextAlign TextAlign { get; set; }
Property Value
Type
Defines the data type of the column.
Declaration
public string Type { get; set; }
Property Value
Type |
Description |
System.String |
|
Uid
Gets the unique identifier value of the column. It is used to get the object.
Declaration
public string Uid { get; set; }
Property Value
Type |
Description |
System.String |
|
ValidationRules
Defines rules to validate data before creating and updating.
Declaration
public object ValidationRules { get; set; }
Property Value
Type |
Description |
System.Object |
|
ValueAccessor
Defines the method used to apply custom cell values from external function and display this on each cell rendered.
Declaration
public object ValueAccessor { get; set; }
Property Value
Type |
Description |
System.Object |
|
Visible
If visible
is set to false, hides the particular column. By default, all columns are displayed.
Declaration
public bool Visible { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Width
Defines the width of the column in pixels or percentage.
Declaration
public string Width { get; set; }
Property Value
Type |
Description |
System.String |
|