Class Gantt

Inheritance
System.Object
Syncfusion.EJ2.EJTagHelper
Gantt
Namespace: Syncfusion.EJ2.Gantt
Assembly: Syncfusion.EJ2.dll
Syntax
public class Gantt : EJTagHelper

Constructors

Gantt()

Declaration
public Gantt()

Properties

ActionBegin

Triggers when Gantt actions such as sorting, filtering, searching etc., starts.

Declaration
public string ActionBegin { get; set; }
Property Value
Type Description
System.String

The default value is null

ActionComplete

Triggers when Gantt actions such as sorting, filtering, searching etc. are completed.

Declaration
public string ActionComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

ActionFailure

Triggers when actions are failed.

Declaration
public string ActionFailure { get; set; }
Property Value
Type Description
System.String

The default value is null

AddDialogFields

Defines the tabs and fields to be displayed in the add dialog. If not specified, the fields will be derived from the taskSettings and columns values.

Declaration
public List<GanttAddDialogField> AddDialogFields { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GanttAddDialogField>

The default value is null

AllowExcelExport

If allowExcelExport set to true, then it will allow the user to export Gantt chart to Excel and CSV file.

Declaration
public bool AllowExcelExport { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AllowFiltering

Enables or disables filtering functionality in the Gantt chart.

Declaration
public bool AllowFiltering { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AllowKeyboard

Enables or disables keyboard interactions in the Gantt chart.

Declaration
public bool AllowKeyboard { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

AllowParentDependency

Specifies whether to allow dependency connection support for parent records.

Declaration
public bool AllowParentDependency { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

AllowPdfExport

If allowPdfExport set to true, then it will allow the user to export Gantt chart to PDF file.

Declaration
public bool AllowPdfExport { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AllowReordering

If allowReordering is set to true, Gantt chart columns can be reordered. Reordering can be done by drag and drop of a particular column from one index to another index.

Declaration
public bool AllowReordering { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AllowResizing

Enables column resizing in the Gantt chart when allowResizing is set to true. When enabled, users can adjust the width of columns by dragging the column borders.

Declaration
public bool AllowResizing { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AllowRowDragAndDrop

If allowRowDragAndDrop set to true, then it will allow the user to perform row drag and drop action in Gantt chart.

Declaration
public bool AllowRowDragAndDrop { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AllowSelection

If allowSelection is set to true, it enables row selection in the Gantt chart, and the selected rows are highlighted.

Declaration
public bool AllowSelection { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

AllowSorting

If allowSorting is set to true, it enables sorting of Gantt chart tasks when the column header is clicked.

Declaration
public bool AllowSorting { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AllowTaskbarDragAndDrop

Defines whether to enable or disable the taskbar drag and drop action in the Gantt chart.

Declaration
public bool AllowTaskbarDragAndDrop { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AllowTaskbarOverlap

Specifies whether taskbars can overlap in the Gantt chart.

Declaration
public bool AllowTaskbarOverlap { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

AllowUnscheduledTasks

Enables or disables the rendering of unscheduled tasks in the Gantt chart. When allowUnscheduledTasks set to true, unscheduled tasks will be displayed in the chart.

Declaration
public bool AllowUnscheduledTasks { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AutoCalculateDateScheduling

Specifies whether to auto calculate the start and end dates based on factors such as working time, holidays, weekends, and task dependencies.

Declaration
public bool AutoCalculateDateScheduling { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

AutoFocusTasks

Enables or disables automatic focusing on the taskbar when a task is clicked.

Declaration
public bool AutoFocusTasks { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

BaselineColor

Specifies the color of the baseline bar in the Gantt chart.

Declaration
public string BaselineColor { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeExcelExport

Triggers before Gantt data is exported to Excel file.

Declaration
public string BeforeExcelExport { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforePdfExport

Triggers before Gantt data is exported to PDF document.

Declaration
public string BeforePdfExport { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeTooltipRender

Triggers before tooltip get rendered.

Declaration
public string BeforeTooltipRender { get; set; }
Property Value
Type Description
System.String

The default value is null

CellDeselected

Triggers when a particular selected cell is deselected.

Declaration
public string CellDeselected { get; set; }
Property Value
Type Description
System.String

The default value is null

CellDeselecting

Triggers before the selected cell is deselecting.

Declaration
public string CellDeselecting { get; set; }
Property Value
Type Description
System.String

The default value is null

CellEdit

This will be triggered a cell get begins to edit.

Declaration
public string CellEdit { get; set; }
Property Value
Type Description
System.String

The default value is null

CellSelected

Triggers after a cell is selected.

Declaration
public string CellSelected { get; set; }
Property Value
Type Description
System.String

The default value is null

CellSelecting

Triggers before any cell selection occurs.

Declaration
public string CellSelecting { get; set; }
Property Value
Type Description
System.String

The default value is null

CollapseAllParentTasks

Defines whether all root tasks should be rendered in a collapsed state. When collapseAllParentTasks set to true, all parent tasks will be collapsed by default.

Declaration
public bool CollapseAllParentTasks { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

Collapsed

This will be triggered after the row getting collapsed.

Declaration
public string Collapsed { get; set; }
Property Value
Type Description
System.String

The default value is null

Collapsing

This will be triggered before the row getting collapsed.

Declaration
public string Collapsing { get; set; }
Property Value
Type Description
System.String

The default value is null

ColumnDrag

Triggers when column header element is dragged (moved) continuously.

Declaration
public string ColumnDrag { get; set; }
Property Value
Type Description
System.String

The default value is null

ColumnDragStart

Triggers when column header element drag (move) starts.

Declaration
public string ColumnDragStart { get; set; }
Property Value
Type Description
System.String

The default value is null

ColumnDrop

Triggers when a column header element is dropped on the target column.

Declaration
public string ColumnDrop { get; set; }
Property Value
Type Description
System.String

The default value is null

ColumnMenuClick

Triggers when click on column menu.

Declaration
public string ColumnMenuClick { get; set; }
Property Value
Type Description
System.String

The default value is null

ColumnMenuItems

columnMenuItems defines both built-in and custom menu items for the Gantt chart column menu.

The available built-in items are, ColumnChooser - To show/hide the TreeGrid columns. SortAscending - Sort the current column in ascending order. SortDescending - Sort the current column in descending order. AutoFitAll - Auto fit the size of all columns. AutoFit - Auto fit the size of the current column. Filter - Displays filter options based on the filterSettings property.

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

The default value is null

ColumnMenuOpen

Triggers before column menu opens.

Declaration
public string ColumnMenuOpen { get; set; }
Property Value
Type Description
System.String

The default value is null

Columns

Defines the collection of columns displayed in the Gantt chart grid. If the columns declaration is empty, the columns are automatically populated based on the taskSettings values.

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

The default value is null

ConnectorLineBackground

Defines the background color of the dependency lines (connector lines) in the Gantt chart. You can set the color as a valid CSS color string (e.g., "red", "#FF5733", "rgb(255,0,0)").

Declaration
public string ConnectorLineBackground { get; set; }
Property Value
Type Description
System.String

The default value is null

ConnectorLineWidth

Defines the width of the dependency lines in the Gantt chart. The value should be a positive integer, representing the thickness of the lines.

Declaration
public int ConnectorLineWidth { get; set; }
Property Value
Type Description
System.Int32

The default value is 1

ContextMenuClick

Triggers when click on context menu.

Declaration
public string ContextMenuClick { get; set; }
Property Value
Type Description
System.String

The default value is null

ContextMenuItems

Defines the built-in and custom items that appear in the context menu of the Gantt chart. You can use this property to control the content and functionality of the right-click context menu.

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

The default value is null

ContextMenuOpen

Triggers before context menu opens.

Declaration
public string ContextMenuOpen { get; set; }
Property Value
Type Description
System.String

The default value is null

Created

Triggers when the component is created.

Declaration
public string Created { get; set; }
Property Value
Type Description
System.String

The default value is null

DataBound

Triggers when data source is populated in the Grid.

Declaration
public string DataBound { get; set; }
Property Value
Type Description
System.String

The default value is null

DataSource

Defines the data source for the Gantt chart, which is used to render rows and tasks. The dataSource can be an array of JavaScript objects, an instance of DataManager, or a single object. The array of objects should contain the task data with properties such as TaskID, TaskName, StartDate, EndDate, etc. This allows dynamic binding of tasks and their relationships (e.g., dependencies, subtasks, progress) to the Gantt chart.

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

The default value is null

DataStateChange

Triggers when the Gantt actions such as Sorting, Editing etc., are done. In this event,the current view data and total record count should be assigned to the dataSource based on the action performed.

Declaration
public string DataStateChange { get; set; }
Property Value
Type Description
System.String

The default value is null

DateFormat

Specifies the date format for displaying dates in the Gantt chart, including in tooltips and grid cells. By default, the format is determined based on the current culture/locale settings.

Declaration
public string DateFormat { get; set; }
Property Value
Type Description
System.String

The default value is null

DayWorkingTime

Defines the customized working time for the project. This helps in accurately planning tasks based on available working hours and ensures proper task scheduling.

Declaration
public List<GanttDayWorkingTime> DayWorkingTime { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GanttDayWorkingTime>

The default value is null

Destroyed

Triggers when the component is destroyed.

Declaration
public string Destroyed { get; set; }
Property Value
Type Description
System.String

The default value is null

DisableHtmlEncode

If disableHtmlEncode is set to true, the Gantt component disables HTML entity encoding across the Gantt content, allowing custom HTML elements to be rendered.

Declaration
public bool DisableHtmlEncode { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

DurationUnit

durationUnit Specifies the duration unit for each task. The available options are: day: Sets the duration unit to day. hour: Sets the duration unit to hour. minute: Sets the duration unit to minute.

Declaration
public DurationUnit DurationUnit { get; set; }
Property Value
Type Description
DurationUnit

The default value is DurationUnit.Day

EditDialogFields

Defines the tabs and fields to be displayed in the edit dialog. If not specified, the fields will be derived from the taskSettings and columns values.

Declaration
public List<GanttEditDialogField> EditDialogFields { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GanttEditDialogField>

The default value is null

EditSettings

Configures the edit settings for the Gantt chart, such as enabling or disabling task modifications.

Declaration
public GanttEditSettings EditSettings { get; set; }
Property Value
Type Description
GanttEditSettings

The default value is null

EnableAdaptiveUI

If enableAdaptiveUI is set to true, the pop-up UI becomes adaptive to smaller screens, enabling better usability for filtering and other features.

Declaration
public bool EnableAdaptiveUI { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableContextMenu

If enableContextMenu is set to true, enables the context menu in the Gantt chart. The context menu provides additional actions that can be accessed by right-clicking on Gantt chart elements

Declaration
public bool EnableContextMenu { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableCriticalPath

Enables the highlighting of critical tasks in the Gantt Chart that directly affect the project's end date. When enabled, tasks that are critical to the project timeline will be visually distinguished by colours.

Declaration
public bool EnableCriticalPath { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableHtmlSanitizer

Specifies whether to display or remove the untrusted HTML values in the TreeGrid component. If enableHtmlSanitizer set to true, any potentially harmful strings and scripts are sanitized before rendering.

Declaration
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnableImmutableMode

If enableImmutableMode is set to true, the Gantt Chart will reuse existing rows from previous results instead of performing a full refresh when Gantt actions are executed.

Declaration
public bool EnableImmutableMode { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableMultiTaskbar

Enables the rendering of child taskbars on the parent row when it is in a collapsed state in the Gantt chart.

Declaration
public bool EnableMultiTaskbar { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnablePredecessorValidation

If enablePredecessorValidation is set to true, enables validation for predecessor links in the Gantt chart.

Declaration
public bool EnablePredecessorValidation { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableTimelineVirtualization

Enables better performance for projects with a large time span by initially rendering only the visible timeline cells. Subsequent cells are loaded on horizontal scrolling.

Declaration
public bool EnableTimelineVirtualization { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableUndoRedo

Enables or disables the undo and redo functionality in the Gantt chart.

Declaration
public bool EnableUndoRedo { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableVirtualization

If enableVirtualization is set to true, the Gantt chart will render only the rows visible within the viewport. and load subsequent rows as the user scrolls vertically. This improves performance when dealing with large datasets.

Declaration
public bool EnableVirtualization { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableVirtualMaskRow

Specifies whether to display shimmer effect during scrolling action in virtual scrolling feature. If disabled, spinner is shown instead of shimmer effect.

Declaration
public bool EnableVirtualMaskRow { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EndEdit

This will be triggered when a task get saved by cell edit.

Declaration
public string EndEdit { get; set; }
Property Value
Type Description
System.String

The default value is null

EventMarkers

Defines the events and milestones along the project timeline. These event markers indicate significant events or milestones throughout the project's duration.

Declaration
public List<GanttEventMarker> EventMarkers { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GanttEventMarker>

The default value is null

ExcelExportComplete

Triggers after Gantt data is exported to Excel file.

Declaration
public string ExcelExportComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

ExcelHeaderQueryCellInfo

Triggers before exporting each header cell to Excel file. You can also customize the Excel cells.

Declaration
public string ExcelHeaderQueryCellInfo { get; set; }
Property Value
Type Description
System.String

The default value is null

ExcelQueryCellInfo

Triggers before exporting each cell to Excel file. You can also customize the Excel cells.

Declaration
public string ExcelQueryCellInfo { get; set; }
Property Value
Type Description
System.String

The default value is null

Expanded

This will be triggered after the row getting expanded.

Declaration
public string Expanded { get; set; }
Property Value
Type Description
System.String

The default value is null

Expanding

This will be triggered before the row getting expanded.

Declaration
public string Expanding { get; set; }
Property Value
Type Description
System.String

The default value is null

FilterSettings

Configures the filter settings for the Gantt chart, enabling users to filter tasks based on specific columns or criteria. The filterSettings property allows customization of filter behavior, such as which columns to filter and the filter type.

Declaration
public GanttFilterSettings FilterSettings { get; set; }
Property Value
Type Description
GanttFilterSettings

The default value is null

GridLines

Configures the grid lines displayed in the TreeGrid and Gantt chart. The gridLines property allows customization of the type of grid lines to be shown, either horizontal, vertical, or both.

Declaration
public GridLine GridLines { get; set; }
Property Value
Type Description
GridLine

The default value is GridLine.Horizontal

HeaderCellInfo

This will be triggered before the header cell element is appended to the Grid element.

Declaration
public string HeaderCellInfo { get; set; }
Property Value
Type Description
System.String

The default value is null

Height

Defines the height of the Gantt component container. The height property can be set to a specific value (in pixels or percentage) or set to 'auto' for automatic height adjustment based on content.

Declaration
public string Height { get; set; }
Property Value
Type Description
System.String

The default value is "auto"

HighlightWeekends

If highlightWeekends is set to true, it highlights all weekend days in the week-day timeline mode. This makes weekends visually distinct in the timeline view.

Declaration
public bool HighlightWeekends { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

Holidays

Defines holidays within the project timeline, allowing you to mark specific dates as holidays. This helps in accounting for non-working days in scheduling and task planning.

Declaration
public List<GanttHoliday> Holidays { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GanttHoliday>

The default value is null

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

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

IncludeWeekend

Defines whether weekend days should be considered as working days in the Gantt chart. When includeWeekend set to true, weekends (Saturday and Sunday) are treated as regular working days.

Declaration
public bool IncludeWeekend { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

LabelSettings

Configures the labels displayed on the right, left, and inside the taskbars in the Gantt chart.

Declaration
public GanttLabelSettings LabelSettings { get; set; }
Property Value
Type Description
GanttLabelSettings

The default value is null

Load

Triggered before the Gantt control gets rendered.

Declaration
public string Load { get; set; }
Property Value
Type Description
System.String

The default value is null

LoadChildOnDemand

Gets or sets whether to load child records on demand in remote data binding. When loadChildOnDemand set to true, child records are loaded only when expanded, and parent records are rendered in a collapsed state initially.

Declaration
public bool LoadChildOnDemand { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

LoadingIndicator

Configures the loading indicator for the Gantt Chart. Specifies the type of indicator to display (spinner or shimmer effect) during waiting periods when actions are performed in the Gantt Chart.

Declaration
public GanttLoadingIndicator LoadingIndicator { get; set; }
Property Value
Type Description
GanttLoadingIndicator

The default value is null

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
public string Locale { get; set; }
Property Value
Type Description
System.String

The default value is ""

MilestoneTemplate

Defines a custom template for rendering milestone tasks in the Gantt chart. This template allows you to customize the appearance of milestone tasks.

Declaration
public string MilestoneTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

OnMouseMove

This event will be triggered when mouse move on Gantt.

Declaration
public string OnMouseMove { get; set; }
Property Value
Type Description
System.String

The default value is null

OnTaskbarClick

This event will be triggered when click on taskbar element.

Declaration
public string OnTaskbarClick { get; set; }
Property Value
Type Description
System.String

The default value is null

ParentTaskbarTemplate

Defines a custom template for rendering parent task bars in the Gantt chart. This template allows you to customize the appearance of parent task bars.

Declaration
public string ParentTaskbarTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

PdfColumnHeaderQueryCellInfo

Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.

Declaration
public string PdfColumnHeaderQueryCellInfo { get; set; }
Property Value
Type Description
System.String

The default value is null

PdfExportComplete

Triggers after TreeGrid data is exported to PDF document.

Declaration
public string PdfExportComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

PdfQueryCellInfo

Triggers before exporting each cell to PDF document. You can also customize the PDF cells.

Declaration
public string PdfQueryCellInfo { get; set; }
Property Value
Type Description
System.String

The default value is null

PdfQueryTaskbarInfo

Triggers before exporting each taskbar to PDF document. You can also customize the taskbar.

Declaration
public string PdfQueryTaskbarInfo { get; set; }
Property Value
Type Description
System.String

The default value is null

PdfQueryTimelineCellInfo

Triggers before exporting each cell to PDF document. You can also customize the PDF cells.

Declaration
public string PdfQueryTimelineCellInfo { get; set; }
Property Value
Type Description
System.String

The default value is null

ProjectEndDate

Defines the end date of the project. If the projectEndDate is not set, it will be automatically calculated based on the data source. The date can be provided as a Date object or a string in a valid date format.

Declaration
public string ProjectEndDate { get; set; }
Property Value
Type Description
System.String

The default value is null

ProjectStartDate

Defines the start date of the project. If the projectStartDate is not set, it will be automatically calculated based on the data source. The date can be provided as a Date object or a string in a valid date format.

Declaration
public string ProjectStartDate { get; set; }
Property Value
Type Description
System.String

The default value is null

Query

Defines an external Query that will be executed in conjunction with data processing to filter, sort the data. This allows for advanced data manipulation before binding the data to the Gantt chart.

Declaration
public string Query { get; set; }
Property Value
Type Description
System.String

The default value is null

QueryCellInfo

This will be triggered before the header cell element is appended to the Grid element.

Declaration
public string QueryCellInfo { get; set; }
Property Value
Type Description
System.String

The default value is null

QueryTaskbarInfo

This will be triggered after the taskbar element is appended to the Gantt element.

Declaration
public string QueryTaskbarInfo { get; set; }
Property Value
Type Description
System.String

The default value is null

ReadOnly

If readOnly is set to true, the Gantt chart becomes read-only, meaning tasks and other elements cannot be edited. This setting disables all editing features, including task updates, dependency management, and any editing acions.

Declaration
public bool ReadOnly { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

RecordDoubleClick

This event will be triggered when double click on record.

Declaration
public string RecordDoubleClick { get; set; }
Property Value
Type Description
System.String

The default value is null

RenderBaseline

If renderBaseline is set to true, baselines will be rendered for tasks in the Gantt chart. Baselines provide a visual reference to track the planned vs. actual progress of tasks.

Declaration
public bool RenderBaseline { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ResizeStart

Triggers when column resize starts.

Declaration
public string ResizeStart { get; set; }
Property Value
Type Description
System.String

The default value is null

ResizeStop

Triggers when column resize ends.

Declaration
public string ResizeStop { get; set; }
Property Value
Type Description
System.String

The default value is null

Resizing

Triggers on column resizing.

Declaration
public string Resizing { get; set; }
Property Value
Type Description
System.String

The default value is null

ResourceFields

Defines the mapping properties to extract resource values, such as id, name, unit, and group from the resource collection in the Gantt chart. This helps to map data from a custom resource collection to the appropriate fields for resource allocation.

Declaration
public GanttResourceFields ResourceFields { get; set; }
Property Value
Type Description
GanttResourceFields

The default value is null

ResourceIDMapping

Defines the mapping property to retrieve the resource ID value from the resource collection. This is used to map the resource ID from the resource data to the Gantt chart for resource allocation.

Declaration
public string ResourceIDMapping { get; set; }
Property Value
Type Description
System.String

The default value is null

ResourceNameMapping

Defines the mapping property to retrieve the resource name value from the resource collection. This is used to map the resource name from the resource data to the Gantt chart for task allocation.

Declaration
public string ResourceNameMapping { get; set; }
Property Value
Type Description
System.String

The default value is null

Resources

Defines the collection of resources assigned to the project.

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

The default value is null

RowDataBound

This will be triggered before the row element is appended to the Grid element.

Declaration
public string RowDataBound { get; set; }
Property Value
Type Description
System.String

The default value is null

RowDeselected

Triggers when a selected row is deselected.

Declaration
public string RowDeselected { get; set; }
Property Value
Type Description
System.String

The default value is null

RowDeselecting

Triggers before deselecting the selected row.

Declaration
public string RowDeselecting { get; set; }
Property Value
Type Description
System.String

The default value is null

RowDrag

Triggers when row elements are dragged (moved) continuously.

Declaration
public string RowDrag { get; set; }
Property Value
Type Description
System.String

The default value is null

RowDragStart

Triggers when row element’s drag(move) starts.

Declaration
public string RowDragStart { get; set; }
Property Value
Type Description
System.String

The default value is null

RowDragStartHelper

Triggers when row element’s before drag(move).

Declaration
public string RowDragStartHelper { get; set; }
Property Value
Type Description
System.String

The default value is null

RowDrop

Triggers when row elements are dropped on the target row.

Declaration
public string RowDrop { get; set; }
Property Value
Type Description
System.String

The default value is null

RowHeight

Defines the height of grid and chart rows in the Gantt chart. This property sets the vertical space allocated for each task or row, allowing customization of row sizes.

Declaration
public int RowHeight { get; set; }
Property Value
Type Description
System.Int32

The default value is 36

RowSelected

Triggers after row selection occurs.

Declaration
public string RowSelected { get; set; }
Property Value
Type Description
System.String

The default value is null

RowSelecting

Triggers before row selection occurs.

Declaration
public string RowSelecting { get; set; }
Property Value
Type Description
System.String

The default value is null

SearchSettings

Configures the search functionality within the Gantt chart.

Declaration
public GanttSearchSettings SearchSettings { get; set; }
Property Value
Type Description
GanttSearchSettings

The default value is null

SegmentData

Defines the collection of segments assigned to tasks in the Gantt chart.

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

The default value is null

SelectedRowIndex

The selectedRowIndex allows you to specify the index of the row to be selected at the time of initial rendering. It can also be used to get the currently selected row index after selection. A value of -1 indicates no row is selected.

Declaration
public int SelectedRowIndex { get; set; }
Property Value
Type Description
System.Int32

The default value is -1

SelectionSettings

Configures the settings for selection in the Gantt chart.

Declaration
public GanttSelectionSettings SelectionSettings { get; set; }
Property Value
Type Description
GanttSelectionSettings

The default value is null

ShowColumnMenu

If showColumnMenu set to true, enables the column menu options for each column in the Gantt chart.

Declaration
public bool ShowColumnMenu { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ShowInlineNotes

To show notes column cell values inside the cell or in tooltip.

Declaration
public bool ShowInlineNotes { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ShowOverAllocation

If showOverAllocation set to true, enables the rendering of the overallocation container in the Gantt chart.

Declaration
public bool ShowOverAllocation { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

SortSettings

Configures the sort settings for the Gantt chart.

Declaration
public GanttSortSettings SortSettings { get; set; }
Property Value
Type Description
GanttSortSettings

The default value is null

SplitterResized

Triggers when splitter resizing action completed.

Declaration
public string SplitterResized { get; set; }
Property Value
Type Description
System.String

The default value is null

SplitterResizeStart

Triggers when splitter resizing starts.

Declaration
public string SplitterResizeStart { get; set; }
Property Value
Type Description
System.String

The default value is null

SplitterResizing

Triggers when splitter bar was dragging.

Declaration
public string SplitterResizing { get; set; }
Property Value
Type Description
System.String

The default value is null

SplitterSettings

Configures the splitter settings for the Gantt chart.

Declaration
public GanttSplitterSettings SplitterSettings { get; set; }
Property Value
Type Description
GanttSplitterSettings

The default value is null

TaskbarEdited

Triggered when a taskbar is dragged and dropped into a new position on the Gantt chart.

Declaration
public string TaskbarEdited { get; set; }
Property Value
Type Description
System.String

The default value is null

TaskbarEditing

Triggered when a taskbar is in the dragging state on the Gantt chart.

Declaration
public string TaskbarEditing { get; set; }
Property Value
Type Description
System.String

The default value is null

TaskbarHeight

Defines height of the taskbar element in the Gantt chart.

Declaration
public Nullable<int> TaskbarHeight { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

The default value is null

TaskbarTemplate

The task bar template that renders customized child task bars from the given template. This property allows users to define a custom template for rendering child task bars in the Gantt chart.

Declaration
public string TaskbarTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

TaskFields

Defines the mapping properties to extract task-related values, such as ID, start date, end date, duration, and progress, from the data source. This allows the Gantt chart to properly map the provided data to the corresponding task fields and render them accordingly.

Declaration
public GanttTaskFields TaskFields { get; set; }
Property Value
Type Description
GanttTaskFields

The default value is null

TaskMode

Specifies task schedule mode for a project.

Declaration
public ScheduleMode TaskMode { get; set; }
Property Value
Type Description
ScheduleMode

The default value is ScheduleMode.Auto

TaskType

taskType Specifies the task type for task whether fixedUnit or fixedWork or fixedDuration. fixedUnit: Sets the task type as fixedUnit. fixedWork: Sets the task type as fixedWork. fixedDuration: Sets the task type as fixedDuration.

Declaration
public TaskType TaskType { get; set; }
Property Value
Type Description
TaskType

The default value is TaskType.FixedUnit

TimelineSettings

Configures timeline settings of Gantt. Defines default timeline modes or customized top tier mode and bottom tier mode or single tier only.

Declaration
public GanttTimelineSettings TimelineSettings { get; set; }
Property Value
Type Description
GanttTimelineSettings

The default value is null

TimelineTemplate

Renders customized html elements for timeline cell from the given template.

Declaration
public string TimelineTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

Timezone

By default, task schedule dates are calculated with system time zone. If the Gantt chart is assigned with a specific time zone, then schedule dates are calculated based on the given time zone date value.

Declaration
public string Timezone { get; set; }
Property Value
Type Description
System.String

The default value is null

Toolbar

toolbar defines the toolbar items of the Gantt. It contains built-in and custom toolbar items. If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Gantt's toolbar.

The available built-in toolbar items are: Add: Adds a new record. Edit: Edits the selected task. Update: Updates the edited task. Delete: Deletes the selected task. Cancel: Cancels the edit state. Search: Searches tasks by the given key. ExpandAll: Expands all the task of Gantt. CollapseAll: Collapses all the task of Gantt. PrevTimeSpan: Extends timeline with one unit before the timeline start date. NextTimeSpan: Extends timeline with one unit after the timeline finish date. ZoomIn: ZoomIn the Gantt control. ZoomOut: ZoomOut the Gantt control. ZoomToFit: Display the all tasks within the viewable Gantt chart. ExcelExport: To export in Excel format. CsvExport : To export in CSV format. Indent: To indent a task to one level. Outdent: To outdent a task from one level.

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

The default value is null

ToolbarClick

Triggers when toolbar item was clicked.

Declaration
public string ToolbarClick { get; set; }
Property Value
Type Description
System.String

The default value is null

TooltipSettings

Enables or disables default tooltip of Gantt element and defines customized tooltip for Gantt elements.

Declaration
public GanttTooltipSettings TooltipSettings { get; set; }
Property Value
Type Description
GanttTooltipSettings

The default value is null

TreeColumnIndex

To define expander column index in Grid.

Declaration
public int TreeColumnIndex { get; set; }
Property Value
Type Description
System.Int32

The default value is 0

UndoRedoActions

undoRedoActions Defines action items that retain for undo and redo operation.

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

The default value is null

UndoRedoStepsCount

Defines number of undo/redo actions that should be stored.

Declaration
public double UndoRedoStepsCount { get; set; }
Property Value
Type Description
System.Double

The default value is 10

UpdateOffsetOnTaskbarEdit

Specifies whether to update offset value on a task for all the predecessor edit actions.

Declaration
public bool UpdateOffsetOnTaskbarEdit { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

ValidateManualTasksOnLinking

If validateManualTasksOnLinking is set to true, it enables date validation while connecting manually scheduled tasks with predecessor.

Declaration
public bool ValidateManualTasksOnLinking { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ViewType

Defines the view type of the Gantt.

Declaration
public ViewType ViewType { get; set; }
Property Value
Type Description
ViewType

The default value is ViewType.ProjectView

WeekWorkingTime

Specifies unique working hours for each weekday in gantt chart to tailor schedules precisely.

Declaration
public List<GanttWeekWorkingTime> WeekWorkingTime { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GanttWeekWorkingTime>

The default value is null

Width

Defines the width of the Gantt component container.

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String

The default value is "auto"

WorkUnit

workUnit Specifies the work unit for each tasks whether day or hour or minute. day: Sets the work unit as day. hour: Sets the work unit as hour. minute: Sets the work unit as minute.

Declaration
public WorkUnit WorkUnit { get; set; }
Property Value
Type Description
WorkUnit

The default value is WorkUnit.Hour

WorkWeek

Defines workweek of project.

Declaration
public string[] WorkWeek { get; set; }
Property Value
Type Description
System.String[]

The default value is null

ZoomingLevels

Configure zooming levels of Gantt Timeline.

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

The default value is null