Class GanttColumn
Inheritance
Namespace: Syncfusion.EJ2.Gantt
Assembly: Syncfusion.EJ2.dll
Syntax
public class GanttColumn : EJTagHelper
Constructors
GanttColumn()
Declaration
public GanttColumn()
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 | The default value is true |
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 | The default value is true |
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 | The default value is true |
AllowResizing
If allowResizing
is set to false, it disables resize option of a particular column.
By default all the columns can be resized.
Declaration
public bool AllowResizing { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
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 | The default value is true |
ClipMode
Defines the overflow mode for cell content. The available modes are:
Clip
- Truncates the cell content when it overflows its area.
Ellipsis
- Displays an ellipsis when the cell content overflows its area.
EllipsisWithTooltip
- Displays an ellipsis when the cell content overflows its area, and shows a tooltip on hover over the ellipsis.
Declaration
public ClipMode ClipMode { get; set; }
Property Value
Type | Description |
---|---|
ClipMode | The default value is Syncfusion.EJ2.Grids.ClipMode.EllipsisWithTooltip |
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 | The default value is null |
CustomFormat
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 |
---|
System.Object |
DisableHtmlEncode
If disableHtmlEncode
is set to true, it disables HTML encoding for the content of specific column.
Declaration
public bool DisableHtmlEncode { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
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 | The default value is false |
Edit
Defines the IEditCell
object to customize default edit cell.
Declaration
public object Edit { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
EditType
Defines the type of component used for editing the field.
Declaration
public string EditType { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "stringedit" |
Field
Defines the field name of column which is mapped with mapping name of DataSource.
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 | The default value is null |
Filter
It is used to customize the default filter options for a specific columns. ui - to render custom component for specific column. It has following functions: ui.create - It is used for creating custom components. ui.read - It is used for read the value from the component. ui.write - It is used to apply component model as dynamically.
Declaration
public object Filter { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
Format
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 | The default value is null |
Formatter
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 | The default value is null |
HeaderTemplate
Defines the header 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 | The default value is null |
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 | The default value is null |
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
Type | Description |
---|---|
TextAlign | The default value is Syncfusion.EJ2.Grids.TextAlign.Left |
HideAtMedia
Column visibility can change based on Media Queries
.
hideAtMedia
accepts only valid Media Queries.
Declaration
public string HideAtMedia { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
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 | The default value is false |
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 | The default value is null |
MinWidth
Defines the minimum width of the column in pixels or percentage.
Declaration
public string MinWidth { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SortComparer
Defines the sort comparer property.
Declaration
public object SortComparer { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
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 | The default value is null |
TextAlign
Defines the alignment of the column in both header and content cells.
Declaration
public TextAlign TextAlign { get; set; }
Property Value
Type | Description |
---|---|
TextAlign | The default value is Syncfusion.EJ2.Grids.TextAlign.Left |
ValidationRules
Defines validation rules for data before creating or updating records. The rules are used to ensure that data meets specific criteria before it is saved or updated.
Declaration
public object ValidationRules { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
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 | The default value is null |
Visible
If visible
is set to false, hides the particular column. By default, columns are displayed.
Declaration
public bool Visible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
Width
Defines the width of the column in pixels or percentage.
Declaration
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |