Syncfusion.EJ2
Properties  Methods 


Syncfusion.EJ2.TreeGrid Namespace : TreeGridColumn Class

TreeGridColumn Class Members

The following tables list the members exposed by TreeGridColumn.

Public Constructors
 NameDescription
Public Constructor  
Top
Public Properties
 NameDescription
Public Property If `allowEditing` set to false, then it disables editing of a particular column. By default all columns are editable.  
Public Property If `allowFiltering` set to false, then it disables filtering option and filter bar element of a particular column. By default all columns are filterable.  
Public Property If `allowReordering` set to false, then it disables reorder of a particular column. By default all columns can be reorder.  
Public Property If `allowResizing` set to false, it disables resize option of a particular column.  
Public Property If `allowSorting` set to false, then it disables sorting option of a particular column. By default all columns are sortable.  
Public Property 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.  
Public Property Used to render multiple header rows(stacked headers) on TreeGrid header.  
Public Property `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.  
Public Property The CSS styles and attributes of the content cells of a particular column can be customized.  
Public Property Defines default values for the component when adding a new record to the TreeGrid.  
Public Property If `disableHtmlEncode` is set to true, it encodes the HTML of the header and content cells.  
Public Property If `displayAsCheckBox` is set to true, it displays the column value as a check box instead of Boolean value.  
Public Property Defines the `IEditCell` object to customize default edit cell.  
Public Property Defines the type of component for editing.  
Public Property Defines the field name of column which is mapped with mapping name of DataSource. The bounded columns can be sort, filter etc., The `field` name must be a valid JavaScript identifier, the first character must be an alphabet and should not contain spaces and special characters.  
Public Property Defines the filter options to customize filtering for the particular column. @default null  
Public Property 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.  
Public Property 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`](../../../common/internationalization/#supported-format-string) and [`date`](../../../common/internationalization/#supported-format-string-1) formats.  
Public Property Defines the method which is used to achieve custom formatting from an external function. This function triggers before rendering of each cell.  
Public Property Defines the header template as string or HTML element ID which is used to add customized element in the column header.  
Public Property 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.  
Public Property Define the alignment of column header which is used to align the text of column header.  
Public Property Column visibility can change based on [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html). `hideAtMedia` accepts only valid Media Queries.  
Public Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Public Property You can use this property to freeze selected columns in grid.  
Public Property If `isIdentity` is set to true, then this column is considered as identity column.  
Public Property If `isPrimaryKey` is set to true, considers this column as the primary key constraint.  
Public Property If `lockColumn` set to true, then it disables Reordering of a particular column. The locked column will be moved to first position.  
Public Property Defines the maximum width of the column in pixels or percentage, which will restrict resizing beyond this pixels or percentage.  
Public Property Defines the minimum width of the column in pixels or percentage.  
Public Property If `showCheckbox` set to true, then the checkboxes will be displayed in particular column.  
Public Property If `showColumnMenu` set to false, then it disable the column menu of a particular column. By default column menu will show for all columns  
Public Property Defines the sort comparer property.  
Public Property Defines the column template that renders customized element in each cell of the column. It accepts either [template string](../../../common/template-engine/) or HTML element ID.  
Public Property Defines the alignment of the column in both header and content cells.  
Public Property Defines the data type of the column.  
Public Property Gets the unique identifier value of the column. It is used to get the object.  
Public Property Defines rules to validate data before creating and updating.  
Public Property Defines the method used to apply custom cell values from external function and display this on each cell rendered.  
Public Property If `visible` is set to false, hides the particular column. By default, columns are displayed.  
Public Property Defines the width of the column in pixels or percentage.  
Top
Protected Properties
Public Methods
Protected Methods
 NameDescription
Protected Method (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Method (Inherited from Syncfusion.EJ2.EJTagHelper)
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded.  Iterates the index.
Top
See Also