Class GanttColumn
Inheritance
System.Object
GanttColumn
Implements
System.IDisposable
Assembly: Syncfusion.Blazor.dll
Syntax
public class GanttColumn : BaseComponent, IDisposable
Constructors
GanttColumn()
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 |
|
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
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 |
|
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 |
|
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
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 |
|
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 |
|
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 |
|
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 |
|
It is used to change display value with the given format and does not affect the original data.
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 |
|
HeaderTemplate
Defines the header template as string or HTML element ID which is used to add customized element in the column header.
Declaration
public RenderFragment<object> HeaderTemplate { get; set; }
Property Value
Type |
Description |
Microsoft.AspNetCore.Components.RenderFragment<System.Object> |
|
HeaderTemplateData
Declaration
public List<Dictionary<string, object>> HeaderTemplateData { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.List<System.Collections.Generic.Dictionary<System.String, System.Object>> |
|
HeaderTemplateID
Declaration
public string HeaderTemplateID { get; set; }
Property Value
Type |
Description |
System.String |
|
HeaderTemplateItems
Declaration
public List<string> HeaderTemplateItems { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.List<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 Media Queries.
hideAtMedia
accepts only valid Media Queries.
Declaration
public string HideAtMedia { get; set; }
Property Value
Type |
Description |
System.String |
|
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 |
|
jsProperty
Declaration
protected override string jsProperty { get; set; }
Property Value
Type |
Description |
System.String |
|
Overrides
mainParent
Declaration
protected override BaseComponent mainParent { get; set; }
Property Value
Overrides
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 |
|
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 RenderFragment<object> Template { get; set; }
Property Value
Type |
Description |
Microsoft.AspNetCore.Components.RenderFragment<System.Object> |
|
TemplateData
Declaration
public List<Dictionary<string, object>> TemplateData { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.List<System.Collections.Generic.Dictionary<System.String, System.Object>> |
|
TemplateID
Declaration
public string TemplateID { get; set; }
Property Value
Type |
Description |
System.String |
|
TemplateItems
Declaration
public List<string> TemplateItems { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.List<System.String> |
|
TextAlign
Defines the alignment of the column in both header and content cells.
Declaration
public TextAlign TextAlign { get; set; }
Property Value
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, 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 |
|
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type |
Name |
Description |
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder |
__builder |
|
GetJSNamespace()
Declaration
public string GetJSNamespace()
Returns
Type |
Description |
System.String |
|
OnAfterRenderAsync(Boolean)
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type |
Name |
Description |
System.Boolean |
firstRender |
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Overrides
OnInitializedAsync()
Declaration
protected override Task OnInitializedAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Overrides
OnParametersSetAsync()
Declaration
protected override Task OnParametersSetAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Implements
System.IDisposable