Class ColumnModel

Class that defines Gantt column model.

Inheritance
System.Object
ColumnModel
Implements
System.IEquatable<ColumnModel>
Namespace: Syncfusion.Blazor.Gantt
Assembly: Syncfusion.Blazor.dll
Syntax
public class ColumnModel : Object, IEquatable<ColumnModel>

Constructors

ColumnModel()

Declaration
public ColumnModel()

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
Type Description
ClipMode

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

Format

It is used to change display value with the given format and does not affect the original data.

Declaration
public object Format { get; set; }
Property Value
Type Description
System.Object

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

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

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
Type Description
TextAlign

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

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

MaxWidth

Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.

Declaration
public object MaxWidth { get; set; }
Property Value
Type Description
System.Object

MinWidth

Defines the minimum width of the column in pixels or percentage.

Declaration
public object MinWidth { 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 Description
TextAlign

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 object Width { get; set; }
Property Value
Type Description
System.Object

Methods

Equals(ColumnModel)

Returns boolean value by comparing columnModel

Declaration
public bool Equals(ColumnModel columnModel)
Parameters
Type Name Description
ColumnModel columnModel
Returns
Type Description
System.Boolean

Equals(Object)

Returns boolean value by comparing object

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

GetHashCode()

Returns hashcode for current object

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Implements

System.IEquatable<>