Class GanttColumnBuilder

Inheritance
System.Object
ControlBuilder
GanttColumnBuilder
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.EJ2.Gantt
Assembly: Syncfusion.EJ2.dll
Syntax
public class GanttColumnBuilder : ControlBuilder

Constructors

GanttColumnBuilder()

Declaration
public GanttColumnBuilder()

GanttColumnBuilder(List<GanttColumn>)

Declaration
public GanttColumnBuilder(List<GanttColumn> collection)
Parameters
Type Name Description
System.Collections.Generic.List<GanttColumn> collection

Methods

Add()

Declaration
public void Add()

AllowEditing(Boolean)

If allowEditing set to false, then it disables editing of a particular column. By default all columns are editable.

Declaration
public GanttColumnBuilder AllowEditing(bool allowEditing)
Parameters
Type Name Description
System.Boolean allowEditing
Returns
Type Description
GanttColumnBuilder

AllowFiltering(Boolean)

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 GanttColumnBuilder AllowFiltering(bool allowFiltering)
Parameters
Type Name Description
System.Boolean allowFiltering
Returns
Type Description
GanttColumnBuilder

AllowReordering(Boolean)

If allowReordering set to false, then it disables reorder of a particular column. By default all columns can be reorder.

Declaration
public GanttColumnBuilder AllowReordering(bool allowReordering)
Parameters
Type Name Description
System.Boolean allowReordering
Returns
Type Description
GanttColumnBuilder

AllowResizing(Boolean)

If allowResizing is set to false, it disables resize option of a particular column. By default all the columns can be resized.

Declaration
public GanttColumnBuilder AllowResizing(bool allowResizing)
Parameters
Type Name Description
System.Boolean allowResizing
Returns
Type Description
GanttColumnBuilder

AllowSorting(Boolean)

If allowSorting set to false, then it disables sorting option of a particular column. By default all columns are sortable.

Declaration
public GanttColumnBuilder AllowSorting(bool allowSorting)
Parameters
Type Name Description
System.Boolean allowSorting
Returns
Type Description
GanttColumnBuilder

ClipMode(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 GanttColumnBuilder ClipMode(ClipMode clipMode)
Parameters
Type Name Description
ClipMode clipMode
Returns
Type Description
GanttColumnBuilder

CustomAttributes(Object)

The CSS styles and attributes of the content cells of a particular column can be customized.

Declaration
public GanttColumnBuilder CustomAttributes(object customAttributes)
Parameters
Type Name Description
System.Object customAttributes
Returns
Type Description
GanttColumnBuilder

DisableHtmlEncode(Boolean)

If disableHtmlEncode is set to true, it encodes the HTML of the header and content cells.

Declaration
public GanttColumnBuilder DisableHtmlEncode(bool disableHtmlEncode)
Parameters
Type Name Description
System.Boolean disableHtmlEncode
Returns
Type Description
GanttColumnBuilder

DisplayAsCheckBox(Boolean)

If displayAsCheckBox is set to true, it displays the column value as a check box instead of Boolean value.

Declaration
public GanttColumnBuilder DisplayAsCheckBox(bool displayAsCheckBox)
Parameters
Type Name Description
System.Boolean displayAsCheckBox
Returns
Type Description
GanttColumnBuilder

Edit(Object)

Defines the IEditCell object to customize default edit cell.

Declaration
public GanttColumnBuilder Edit(object edit)
Parameters
Type Name Description
System.Object edit
Returns
Type Description
GanttColumnBuilder

EditType(String)

Defines the type of component for editing.

Declaration
public GanttColumnBuilder EditType(string editType)
Parameters
Type Name Description
System.String editType
Returns
Type Description
GanttColumnBuilder

Field(String)

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 GanttColumnBuilder Field(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
GanttColumnBuilder

Filter(Object)

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 GanttColumnBuilder Filter(object filter)
Parameters
Type Name Description
System.Object filter
Returns
Type Description
GanttColumnBuilder

Format(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 GanttColumnBuilder Format(object format)
Parameters
Type Name Description
System.Object format
Returns
Type Description
GanttColumnBuilder

Format(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 GanttColumnBuilder Format(string format)
Parameters
Type Name Description
System.String format
Returns
Type Description
GanttColumnBuilder

Formatter(Object)

Defines the method which is used to achieve custom formatting from an external function. This function triggers before rendering of each cell.

Declaration
public GanttColumnBuilder Formatter(object formatter)
Parameters
Type Name Description
System.Object formatter
Returns
Type Description
GanttColumnBuilder

HeaderTemplate(String)

Defines the header template as string or HTML element ID which is used to add customized element in the column header.

Declaration
public GanttColumnBuilder HeaderTemplate(string headerTemplate)
Parameters
Type Name Description
System.String headerTemplate
Returns
Type Description
GanttColumnBuilder

HeaderText(String)

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 GanttColumnBuilder HeaderText(string headerText)
Parameters
Type Name Description
System.String headerText
Returns
Type Description
GanttColumnBuilder

HeaderTextAlign(TextAlign)

Define the alignment of column header which is used to align the text of column header.

Declaration
public GanttColumnBuilder HeaderTextAlign(TextAlign headerTextAlign)
Parameters
Type Name Description
TextAlign headerTextAlign
Returns
Type Description
GanttColumnBuilder

HideAtMedia(String)

Column visibility can change based on Media Queries. hideAtMedia accepts only valid Media Queries.

Declaration
public GanttColumnBuilder HideAtMedia(string hideAtMedia)
Parameters
Type Name Description
System.String hideAtMedia
Returns
Type Description
GanttColumnBuilder

IsPrimaryKey(Boolean)

If isPrimaryKey is set to true, considers this column as the primary key constraint.

Declaration
public GanttColumnBuilder IsPrimaryKey(bool isPrimaryKey)
Parameters
Type Name Description
System.Boolean isPrimaryKey
Returns
Type Description
GanttColumnBuilder

MaxWidth(Double)

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

Declaration
public GanttColumnBuilder MaxWidth(double maxWidth)
Parameters
Type Name Description
System.Double maxWidth
Returns
Type Description
GanttColumnBuilder

MaxWidth(String)

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

Declaration
public GanttColumnBuilder MaxWidth(string maxWidth)
Parameters
Type Name Description
System.String maxWidth
Returns
Type Description
GanttColumnBuilder

MinWidth(Double)

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

Declaration
public GanttColumnBuilder MinWidth(double minWidth)
Parameters
Type Name Description
System.Double minWidth
Returns
Type Description
GanttColumnBuilder

MinWidth(String)

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

Declaration
public GanttColumnBuilder MinWidth(string minWidth)
Parameters
Type Name Description
System.String minWidth
Returns
Type Description
GanttColumnBuilder

SortComparer(Object)

Defines the sort comparer property.

Declaration
public GanttColumnBuilder SortComparer(object sortComparer)
Parameters
Type Name Description
System.Object sortComparer
Returns
Type Description
GanttColumnBuilder

SortComparer(String)

Defines the sort comparer property.

Declaration
public GanttColumnBuilder SortComparer(string sortComparer)
Parameters
Type Name Description
System.String sortComparer
Returns
Type Description
GanttColumnBuilder

Template(String)

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 GanttColumnBuilder Template(string template)
Parameters
Type Name Description
System.String template
Returns
Type Description
GanttColumnBuilder

TextAlign(TextAlign)

Defines the alignment of the column in both header and content cells.

Declaration
public GanttColumnBuilder TextAlign(TextAlign textAlign)
Parameters
Type Name Description
TextAlign textAlign
Returns
Type Description
GanttColumnBuilder

ValueAccessor(Object)

Defines the method used to apply custom cell values from external function and display this on each cell rendered.

Declaration
public GanttColumnBuilder ValueAccessor(object valueAccessor)
Parameters
Type Name Description
System.Object valueAccessor
Returns
Type Description
GanttColumnBuilder

ValueAccessor(String)

Defines the method used to apply custom cell values from external function and display this on each cell rendered.

Declaration
public GanttColumnBuilder ValueAccessor(string valueAccessor)
Parameters
Type Name Description
System.String valueAccessor
Returns
Type Description
GanttColumnBuilder

Visible(Boolean)

If visible is set to false, hides the particular column. By default, columns are displayed.

Declaration
public GanttColumnBuilder Visible(bool visible)
Parameters
Type Name Description
System.Boolean visible
Returns
Type Description
GanttColumnBuilder

Width(Double)

Defines the width of the column in pixels or percentage.

Declaration
public GanttColumnBuilder Width(double width)
Parameters
Type Name Description
System.Double width
Returns
Type Description
GanttColumnBuilder

Width(String)

Defines the width of the column in pixels or percentage.

Declaration
public GanttColumnBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
GanttColumnBuilder