Class GanttBuilder
Inheritance
System.Object
GanttBuilder
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()
Assembly: Syncfusion.EJ2.dll
Syntax
public class GanttBuilder : ControlBuilder
Constructors
GanttBuilder()
Declaration
GanttBuilder(Gantt)
Declaration
public GanttBuilder(Gantt model)
Parameters
| Type |
Name |
Description |
| Gantt |
model |
|
Fields
model
Declaration
Field Value
Properties
HtmlAttr
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
| Type |
Description |
| System.Collections.Generic.IDictionary<System.String, System.Object> |
|
ID
Declaration
public string ID { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Output
Declaration
public override TextWriter Output { get; set; }
Property Value
| Type |
Description |
| System.IO.TextWriter |
|
Overrides
Methods
ActionBegin(String)
Triggers when Gantt actions such as sorting, filtering, searching etc., starts.
Declaration
public GanttBuilder ActionBegin(string actionBegin)
Parameters
| Type |
Name |
Description |
| System.String |
actionBegin |
|
Returns
ActionComplete(String)
Triggers when Gantt actions such as sorting, filtering, searching etc. are completed.
Declaration
public GanttBuilder ActionComplete(string actionComplete)
Parameters
| Type |
Name |
Description |
| System.String |
actionComplete |
|
Returns
ActionFailure(String)
Triggers when actions are failed.
Declaration
public GanttBuilder ActionFailure(string actionFailure)
Parameters
| Type |
Name |
Description |
| System.String |
actionFailure |
|
Returns
AddDialogFields(Action<GanttAddDialogFieldBuilder>)
Declaration
public GanttBuilder AddDialogFields(Action<GanttAddDialogFieldBuilder> addDialogFields)
Parameters
Returns
AddDialogFields(List<GanttAddDialogField>)
Defines the tabs and fields to be included in the add dialog.
If the value was empty, then it will be calculated from taskSettings and columns value.
{% codeBlock src='gantt/addDialogFields/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder AddDialogFields(List<GanttAddDialogField> addDialogFields)
Parameters
Returns
AllowExcelExport(Boolean)
If allowExcelExport set to true, then it will allow the user to export Gantt to Excel and CSV file.
Declaration
public GanttBuilder AllowExcelExport(bool allowExcelExport = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowExcelExport |
|
Returns
AllowFiltering(Boolean)
Enables or disables filtering support in Gantt.
Declaration
public GanttBuilder AllowFiltering(bool allowFiltering = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowFiltering |
|
Returns
AllowKeyboard(Boolean)
Enables or disables the key board interaction of Gantt.
Declaration
public GanttBuilder AllowKeyboard(bool allowKeyboard = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowKeyboard |
|
Returns
AllowParentDependency(Boolean)
Specifies whether to allow dependency connection support for parent records.
Declaration
public GanttBuilder AllowParentDependency(bool allowParentDependency = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowParentDependency |
|
Returns
AllowPdfExport(Boolean)
If allowPdfExport set to true, then it will allow the user to export Gantt to PDF file.
Declaration
public GanttBuilder AllowPdfExport(bool allowPdfExport = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowPdfExport |
|
Returns
AllowReordering(Boolean)
If allowReordering is set to true, Gantt columns can be reordered.
Reordering can be done by drag and drop of a particular column from one index to another index.
Declaration
public GanttBuilder AllowReordering(bool allowReordering = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowReordering |
|
Returns
AllowResizing(Boolean)
If allowResizing is set to true, Gantt columns can be resized.
Declaration
public GanttBuilder AllowResizing(bool allowResizing = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowResizing |
|
Returns
AllowRowDragAndDrop(Boolean)
If allowRowDragAndDrop set to true, then it will allow the user to perform drag and drop action in Gantt.
Declaration
public GanttBuilder AllowRowDragAndDrop(bool allowRowDragAndDrop = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowRowDragAndDrop |
|
Returns
AllowSelection(Boolean)
If allowSelection is set to true, it allows selection of (highlight row) Gantt chart rows by clicking it.
Declaration
public GanttBuilder AllowSelection(bool allowSelection = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowSelection |
|
Returns
AllowSorting(Boolean)
If allowSorting is set to true, it allows sorting of gantt chart tasks when column header is clicked.
Declaration
public GanttBuilder AllowSorting(bool allowSorting = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowSorting |
|
Returns
AllowTaskbarDragAndDrop(Boolean)
Defines whether to enable or disable taskbar drag and drop.
Declaration
public GanttBuilder AllowTaskbarDragAndDrop(bool allowTaskbarDragAndDrop = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowTaskbarDragAndDrop |
|
Returns
AllowTaskbarOverlap(Boolean)
Defines whether taskbar to get overlapped or not.
Declaration
public GanttBuilder AllowTaskbarOverlap(bool allowTaskbarOverlap = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowTaskbarOverlap |
|
Returns
AllowUnscheduledTasks(Boolean)
Enables or disables rendering of unscheduled tasks in Gantt.
Declaration
public GanttBuilder AllowUnscheduledTasks(bool allowUnscheduledTasks = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowUnscheduledTasks |
|
Returns
AutoCalculateDateScheduling(Boolean)
Specifies whether to auto calculate start and end-date based on various factors such as working time, holidays, weekends, and predecessors.
Declaration
public GanttBuilder AutoCalculateDateScheduling(bool autoCalculateDateScheduling = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
autoCalculateDateScheduling |
|
Returns
AutoFocusTasks(Boolean)
Enables or disables the focusing the task bar on click action.
Declaration
public GanttBuilder AutoFocusTasks(bool autoFocusTasks = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
autoFocusTasks |
|
Returns
BaselineColor(String)
Defines the baseline bar color.
Declaration
public GanttBuilder BaselineColor(string baselineColor)
Parameters
| Type |
Name |
Description |
| System.String |
baselineColor |
|
Returns
BeforeExcelExport(String)
Triggers before Gantt data is exported to Excel file.
Declaration
public GanttBuilder BeforeExcelExport(string beforeExcelExport)
Parameters
| Type |
Name |
Description |
| System.String |
beforeExcelExport |
|
Returns
BeforePdfExport(String)
Triggers before Gantt data is exported to PDF document.
Declaration
public GanttBuilder BeforePdfExport(string beforePdfExport)
Parameters
| Type |
Name |
Description |
| System.String |
beforePdfExport |
|
Returns
Triggers before tooltip get rendered.
Declaration
public GanttBuilder BeforeTooltipRender(string beforeTooltipRender)
Parameters
| Type |
Name |
Description |
| System.String |
beforeTooltipRender |
|
Returns
CellDeselected(String)
Triggers when a particular selected cell is deselected.
Declaration
public GanttBuilder CellDeselected(string cellDeselected)
Parameters
| Type |
Name |
Description |
| System.String |
cellDeselected |
|
Returns
CellDeselecting(String)
Triggers before the selected cell is deselecting.
Declaration
public GanttBuilder CellDeselecting(string cellDeselecting)
Parameters
| Type |
Name |
Description |
| System.String |
cellDeselecting |
|
Returns
CellEdit(String)
This will be triggered a cell get begins to edit.
Declaration
public GanttBuilder CellEdit(string cellEdit)
Parameters
| Type |
Name |
Description |
| System.String |
cellEdit |
|
Returns
CellSelected(String)
Triggers after a cell is selected.
Declaration
public GanttBuilder CellSelected(string cellSelected)
Parameters
| Type |
Name |
Description |
| System.String |
cellSelected |
|
Returns
CellSelecting(String)
Triggers before any cell selection occurs.
Declaration
public GanttBuilder CellSelecting(string cellSelecting)
Parameters
| Type |
Name |
Description |
| System.String |
cellSelecting |
|
Returns
CollapseAllParentTasks(Boolean)
If collapseAllParentTasks set to true, then root tasks are rendered with collapsed state.
Declaration
public GanttBuilder CollapseAllParentTasks(bool collapseAllParentTasks = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
collapseAllParentTasks |
|
Returns
Collapsed(String)
This will be triggered after the row getting collapsed.
Declaration
public GanttBuilder Collapsed(string collapsed)
Parameters
| Type |
Name |
Description |
| System.String |
collapsed |
|
Returns
Collapsing(String)
This will be triggered before the row getting collapsed.
Declaration
public GanttBuilder Collapsing(string collapsing)
Parameters
| Type |
Name |
Description |
| System.String |
collapsing |
|
Returns
ColumnDrag(String)
Triggers when column header element is dragged (moved) continuously.
Declaration
public GanttBuilder ColumnDrag(string columnDrag)
Parameters
| Type |
Name |
Description |
| System.String |
columnDrag |
|
Returns
ColumnDragStart(String)
Triggers when column header element drag (move) starts.
Declaration
public GanttBuilder ColumnDragStart(string columnDragStart)
Parameters
| Type |
Name |
Description |
| System.String |
columnDragStart |
|
Returns
ColumnDrop(String)
Triggers when a column header element is dropped on the target column.
Declaration
public GanttBuilder ColumnDrop(string columnDrop)
Parameters
| Type |
Name |
Description |
| System.String |
columnDrop |
|
Returns
ColumnMenuClick(String)
Triggers when click on column menu.
Declaration
public GanttBuilder ColumnMenuClick(string columnMenuClick)
Parameters
| Type |
Name |
Description |
| System.String |
columnMenuClick |
|
Returns
ColumnMenuItems(Object)
columnMenuItems defines both built-in and custom column menu items.
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.
Filter - Filter options will show based on filterSettings property.
Declaration
public GanttBuilder ColumnMenuItems(object columnMenuItems)
Parameters
| Type |
Name |
Description |
| System.Object |
columnMenuItems |
|
Returns
ColumnMenuOpen(String)
Triggers before column menu opens.
Declaration
public GanttBuilder ColumnMenuOpen(string columnMenuOpen)
Parameters
| Type |
Name |
Description |
| System.String |
columnMenuOpen |
|
Returns
Columns(Action<GanttColumnBuilder>)
Declaration
public GanttBuilder Columns(Action<GanttColumnBuilder> columns)
Parameters
Returns
Columns(List<GanttColumn>)
Defines column collection displayed in grid
If the columns declaration was empty then columns are automatically populated from taskSettings value.
{% codeBlock src='gantt/columns/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder Columns(List<GanttColumn> columns)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<GanttColumn> |
columns |
|
Returns
Columns(Object)
Defines column collection displayed in grid
If the columns declaration was empty then columns are automatically populated from taskSettings value.
{% codeBlock src='gantt/columns/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder Columns(object columns)
Parameters
| Type |
Name |
Description |
| System.Object |
columns |
|
Returns
Columns(String[])
Defines column collection displayed in grid
If the columns declaration was empty then columns are automatically populated from taskSettings value.
{% codeBlock src='gantt/columns/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder Columns(string[] columns)
Parameters
| Type |
Name |
Description |
| System.String[] |
columns |
|
Returns
ConnectorLineBackground(String)
Defines background color of dependency lines.
Declaration
public GanttBuilder ConnectorLineBackground(string connectorLineBackground)
Parameters
| Type |
Name |
Description |
| System.String |
connectorLineBackground |
|
Returns
ConnectorLineWidth(Int32)
Defines width of dependency lines.
Declaration
public GanttBuilder ConnectorLineWidth(int connectorLineWidth)
Parameters
| Type |
Name |
Description |
| System.Int32 |
connectorLineWidth |
|
Returns
Triggers when click on context menu.
Declaration
public GanttBuilder ContextMenuClick(string contextMenuClick)
Parameters
| Type |
Name |
Description |
| System.String |
contextMenuClick |
|
Returns
contextMenuItems defines both built-in and custom context menu items.
{% codeBlock src='gantt/contextMenuItems/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder ContextMenuItems(object contextMenuItems)
Parameters
| Type |
Name |
Description |
| System.Object |
contextMenuItems |
|
Returns
Triggers before context menu opens.
Declaration
public GanttBuilder ContextMenuOpen(string contextMenuOpen)
Parameters
| Type |
Name |
Description |
| System.String |
contextMenuOpen |
|
Returns
Created(String)
Triggers when the component is created.
Declaration
public GanttBuilder Created(string created)
Parameters
| Type |
Name |
Description |
| System.String |
created |
|
Returns
DataBound(String)
Triggers when data source is populated in the Grid.
Declaration
public GanttBuilder DataBound(string dataBound)
Parameters
| Type |
Name |
Description |
| System.String |
dataBound |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public GanttBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
Returns
DataSource(Object)
It is used to render Gantt chart rows and tasks.
dataSource value was defined as array of JavaScript objects or instances of DataManager.
{% codeBlock src='gantt/dataSource/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder DataSource(object dataSource)
Parameters
| Type |
Name |
Description |
| System.Object |
dataSource |
|
Returns
DataStateChange(String)
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 GanttBuilder DataStateChange(string dataStateChange)
Parameters
| Type |
Name |
Description |
| System.String |
dataStateChange |
|
Returns
Specifies the dateFormat for Gantt, given format is displayed in tooltip and Grid cells.
By default, the format is based on the culture.
Declaration
public GanttBuilder DateFormat(string dateFormat)
Parameters
| Type |
Name |
Description |
| System.String |
dateFormat |
|
Returns
DayWorkingTime(Action<GanttDayWorkingTimeBuilder>)
Declaration
public GanttBuilder DayWorkingTime(Action<GanttDayWorkingTimeBuilder> dayWorkingTime)
Parameters
Returns
DayWorkingTime(List<GanttDayWorkingTime>)
Defines customized working time of project.
{% codeBlock src='gantt/dayWorkingTime/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder DayWorkingTime(List<GanttDayWorkingTime> dayWorkingTime)
Parameters
Returns
Destroyed(String)
Triggers when the component is destroyed.
Declaration
public GanttBuilder Destroyed(string destroyed)
Parameters
| Type |
Name |
Description |
| System.String |
destroyed |
|
Returns
DisableHtmlEncode(Boolean)
If disableHtmlEncode is set to true, it encodes the HTML of the header and content cells.
Declaration
public GanttBuilder DisableHtmlEncode(bool disableHtmlEncode = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
disableHtmlEncode |
|
Returns
DurationUnit(DurationUnit)
durationUnit Specifies the duration unit for each tasks whether day or hour or minute.
day: Sets the duration unit as day.
hour: Sets the duration unit as hour.
minute: Sets the duration unit as minute.
Declaration
public GanttBuilder DurationUnit(DurationUnit durationUnit)
Parameters
Returns
EditDialogFields(Action<GanttEditDialogFieldBuilder>)
Declaration
public GanttBuilder EditDialogFields(Action<GanttEditDialogFieldBuilder> editDialogFields)
Parameters
Returns
EditDialogFields(List<GanttEditDialogField>)
Defines the tabs and fields to be included in the edit dialog.
If the value was empty, then it will be calculated from taskSettings and columns value.
{% codeBlock src='gantt/editDialogFields/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder EditDialogFields(List<GanttEditDialogField> editDialogFields)
Parameters
Returns
EditSettings(GanttEditSettings)
Configures edit settings of Gantt.
{% codeBlock src='gantt/editSettings/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder EditSettings(GanttEditSettings editSettings)
Parameters
Returns
EditSettings(Action<GanttEditSettingsBuilder>)
Declaration
public GanttBuilder EditSettings(Action<GanttEditSettingsBuilder> editSettings)
Parameters
Returns
If enableContextMenu is set to true, Enable context menu in Gantt.
Declaration
public GanttBuilder EnableContextMenu(bool enableContextMenu = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableContextMenu |
|
Returns
EnableCriticalPath(Boolean)
It highlights the critical tasks in the Gantt Chart that affect the project’s end date.
Declaration
public GanttBuilder EnableCriticalPath(bool enableCriticalPath = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableCriticalPath |
|
Returns
EnableHtmlSanitizer(Boolean)
Specifies whether to display or remove the untrusted HTML values in the TreeGrid component.
If enableHtmlSanitizer set to true, then it will sanitize any suspected untrusted strings and scripts before rendering them.
Declaration
public GanttBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableHtmlSanitizer |
|
Returns
EnableImmutableMode(Boolean)
If enableImmutableMode is set to true, the Gantt Chart will reuse old rows if it exists in the new result instead of
full refresh while performing the Gantt actions.
Declaration
public GanttBuilder EnableImmutableMode(bool enableImmutableMode = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableImmutableMode |
|
Returns
EnableMultiTaskbar(Boolean)
It enables to render the child taskbar on parent row for resource view Gantt.
Declaration
public GanttBuilder EnableMultiTaskbar(bool enableMultiTaskbar = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableMultiTaskbar |
|
Returns
EnablePersistence(Boolean)
Enable or disable persisting component's state between page reloads.
Declaration
public GanttBuilder EnablePersistence(bool enablePersistence = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enablePersistence |
|
Returns
EnablePredecessorValidation(Boolean)
If enablePredecessorValidation is set to true, it allows to validate the predecessor link.
Declaration
public GanttBuilder EnablePredecessorValidation(bool enablePredecessorValidation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enablePredecessorValidation |
|
Returns
EnableRtl(Boolean)
Enable or disable rendering component in right to left direction.
Declaration
public GanttBuilder EnableRtl(bool enableRtl = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableRtl |
|
Returns
EnableVirtualization(Boolean)
If enableVirtualization set to true, then the Gantt will render only the rows visible within the view-port.
and load subsequent rows on vertical scrolling. This helps to load large dataset in Gantt.
Declaration
public GanttBuilder EnableVirtualization(bool enableVirtualization = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableVirtualization |
|
Returns
EnableVirtualMaskRow(Boolean)
Specifies whether to display shimmer effect during scrolling action in virtual scrolling feature. If disabled, spinner is shown instead of shimmer effect.
Declaration
public GanttBuilder EnableVirtualMaskRow(bool enableVirtualMaskRow = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableVirtualMaskRow |
|
Returns
EndEdit(String)
This will be triggered when a task get saved by cell edit.
Declaration
public GanttBuilder EndEdit(string endEdit)
Parameters
| Type |
Name |
Description |
| System.String |
endEdit |
|
Returns
EventMarkers(Action<GanttEventMarkerBuilder>)
Declaration
public GanttBuilder EventMarkers(Action<GanttEventMarkerBuilder> eventMarkers)
Parameters
Returns
EventMarkers(List<GanttEventMarker>)
Defines events and status of project throughout the timeline.
{% codeBlock src='gantt/eventMarkers/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder EventMarkers(List<GanttEventMarker> eventMarkers)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<GanttEventMarker> |
eventMarkers |
|
Returns
ExcelExportComplete(String)
Triggers after Gantt data is exported to Excel file.
Declaration
public GanttBuilder ExcelExportComplete(string excelExportComplete)
Parameters
| Type |
Name |
Description |
| System.String |
excelExportComplete |
|
Returns
Triggers before exporting each header cell to Excel file.
You can also customize the Excel cells.
Declaration
public GanttBuilder ExcelHeaderQueryCellInfo(string excelHeaderQueryCellInfo)
Parameters
| Type |
Name |
Description |
| System.String |
excelHeaderQueryCellInfo |
|
Returns
ExcelQueryCellInfo(String)
Triggers before exporting each cell to Excel file.
You can also customize the Excel cells.
Declaration
public GanttBuilder ExcelQueryCellInfo(string excelQueryCellInfo)
Parameters
| Type |
Name |
Description |
| System.String |
excelQueryCellInfo |
|
Returns
Expanded(String)
This will be triggered after the row getting expanded.
Declaration
public GanttBuilder Expanded(string expanded)
Parameters
| Type |
Name |
Description |
| System.String |
expanded |
|
Returns
Expanding(String)
This will be triggered before the row getting expanded.
Declaration
public GanttBuilder Expanding(string expanding)
Parameters
| Type |
Name |
Description |
| System.String |
expanding |
|
Returns
FilterSettings(GanttFilterSettings)
Configures the filter settings for Gantt.
{% codeBlock src='gantt/filterSettings/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder FilterSettings(GanttFilterSettings filterSettings)
Parameters
Returns
FilterSettings(Action<GanttFilterSettingsBuilder>)
Declaration
public GanttBuilder FilterSettings(Action<GanttFilterSettingsBuilder> filterSettings)
Parameters
Returns
GridLines(GridLine)
Configures the grid lines in tree grid and gantt chart.
Declaration
public GanttBuilder GridLines(GridLine gridLines)
Parameters
| Type |
Name |
Description |
| GridLine |
gridLines |
|
Returns
This will be triggered before the header cell element is appended to the Grid element.
Declaration
public GanttBuilder HeaderCellInfo(string headerCellInfo)
Parameters
| Type |
Name |
Description |
| System.String |
headerCellInfo |
|
Returns
Height(Double)
Defines the height of the Gantt component container.
Declaration
public GanttBuilder Height(double height)
Parameters
| Type |
Name |
Description |
| System.Double |
height |
|
Returns
Height(String)
Defines the height of the Gantt component container.
Declaration
public GanttBuilder Height(string height)
Parameters
| Type |
Name |
Description |
| System.String |
height |
|
Returns
HighlightWeekends(Boolean)
If highlightWeekends set to true, then all weekend days are highlighted in week - day timeline mode.
Declaration
public GanttBuilder HighlightWeekends(bool highlightWeekends = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
highlightWeekends |
|
Returns
Holidays(Action<GanttHolidayBuilder>)
Declaration
public GanttBuilder Holidays(Action<GanttHolidayBuilder> holidays)
Parameters
Returns
Holidays(List<GanttHoliday>)
Defines holidays presented in project timeline.
{% codeBlock src='gantt/holidays/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder Holidays(List<GanttHoliday> holidays)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<GanttHoliday> |
holidays |
|
Returns
HtmlAttributes(Object)
Allows additional HTML attributes such as title, name, etc., and
accepts n number of attributes in a key-value pair format.
Declaration
public GanttBuilder HtmlAttributes(object htmlAttributes)
Parameters
| Type |
Name |
Description |
| System.Object |
htmlAttributes |
|
Returns
IncludeWeekend(Boolean)
Defines weekend days are considered as working day or not.
Declaration
public GanttBuilder IncludeWeekend(bool includeWeekend = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
includeWeekend |
|
Returns
LabelSettings(GanttLabelSettings)
Defines the right, left and inner task labels in task bar.
{% codeBlock src='gantt/labelSettings/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder LabelSettings(GanttLabelSettings labelSettings)
Parameters
Returns
LabelSettings(Action<GanttLabelSettingsBuilder>)
Declaration
public GanttBuilder LabelSettings(Action<GanttLabelSettingsBuilder> labelSettings)
Parameters
Returns
Load(String)
Triggered before the Gantt control gets rendered.
Declaration
public GanttBuilder Load(string load)
Parameters
| Type |
Name |
Description |
| System.String |
load |
|
Returns
LoadingIndicator(GanttLoadingIndicator)
Configures the loading indicator of the Gantt Chart. Specifies whether to display spinner or shimmer effect during the waiting time on any actions performed in Gantt Chart.
Declaration
public GanttBuilder LoadingIndicator(GanttLoadingIndicator loadingIndicator)
Parameters
Returns
LoadingIndicator(Action<GanttLoadingIndicatorBuilder>)
Declaration
public GanttBuilder LoadingIndicator(Action<GanttLoadingIndicatorBuilder> loadingIndicator)
Parameters
Returns
Locale(String)
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public GanttBuilder Locale(string locale)
Parameters
| Type |
Name |
Description |
| System.String |
locale |
|
Returns
MilestoneTemplate(String)
The milestone template that renders customized milestone task from the given template.
Declaration
public GanttBuilder MilestoneTemplate(string milestoneTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
milestoneTemplate |
|
Returns
OnMouseMove(String)
This event will be triggered when mouse move on Gantt.
Declaration
public GanttBuilder OnMouseMove(string onMouseMove)
Parameters
| Type |
Name |
Description |
| System.String |
onMouseMove |
|
Returns
OnTaskbarClick(String)
This event will be triggered when click on taskbar element.
Declaration
public GanttBuilder OnTaskbarClick(string onTaskbarClick)
Parameters
| Type |
Name |
Description |
| System.String |
onTaskbarClick |
|
Returns
ParentTaskbarTemplate(String)
The parent task bar template that renders customized parent task bars from the given template.
Declaration
public GanttBuilder ParentTaskbarTemplate(string parentTaskbarTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
parentTaskbarTemplate |
|
Returns
PdfColumnHeaderQueryCellInfo(String)
Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.
Declaration
public GanttBuilder PdfColumnHeaderQueryCellInfo(string pdfColumnHeaderQueryCellInfo)
Parameters
| Type |
Name |
Description |
| System.String |
pdfColumnHeaderQueryCellInfo |
|
Returns
PdfExportComplete(String)
Triggers after TreeGrid data is exported to PDF document.
Declaration
public GanttBuilder PdfExportComplete(string pdfExportComplete)
Parameters
| Type |
Name |
Description |
| System.String |
pdfExportComplete |
|
Returns
PdfQueryCellInfo(String)
Triggers before exporting each cell to PDF document. You can also customize the PDF cells.
Declaration
public GanttBuilder PdfQueryCellInfo(string pdfQueryCellInfo)
Parameters
| Type |
Name |
Description |
| System.String |
pdfQueryCellInfo |
|
Returns
PdfQueryTaskbarInfo(String)
Triggers before exporting each taskbar to PDF document. You can also customize the taskbar.
Declaration
public GanttBuilder PdfQueryTaskbarInfo(string pdfQueryTaskbarInfo)
Parameters
| Type |
Name |
Description |
| System.String |
pdfQueryTaskbarInfo |
|
Returns
PdfQueryTimelineCellInfo(String)
Triggers before exporting each cell to PDF document. You can also customize the PDF cells.
Declaration
public GanttBuilder PdfQueryTimelineCellInfo(string pdfQueryTimelineCellInfo)
Parameters
| Type |
Name |
Description |
| System.String |
pdfQueryTimelineCellInfo |
|
Returns
ProjectEndDate(String)
Defines end date of the project, if projectEndDate value not set then it will be calculated from data source.
Declaration
public GanttBuilder ProjectEndDate(string projectEndDate)
Parameters
| Type |
Name |
Description |
| System.String |
projectEndDate |
|
Returns
ProjectStartDate(String)
Defines start date of the project, if projectStartDate value not set then it will be calculated from data source.
Declaration
public GanttBuilder ProjectStartDate(string projectStartDate)
Parameters
| Type |
Name |
Description |
| System.String |
projectStartDate |
|
Returns
Query(String)
Defines the external Query
that will be executed along with data processing.
Declaration
public GanttBuilder Query(string query)
Parameters
| Type |
Name |
Description |
| System.String |
query |
|
Returns
QueryCellInfo(String)
This will be triggered before the header cell element is appended to the Grid element.
Declaration
public GanttBuilder QueryCellInfo(string queryCellInfo)
Parameters
| Type |
Name |
Description |
| System.String |
queryCellInfo |
|
Returns
QueryTaskbarInfo(String)
This will be triggered after the taskbar element is appended to the Gantt element.
Declaration
public GanttBuilder QueryTaskbarInfo(string queryTaskbarInfo)
Parameters
| Type |
Name |
Description |
| System.String |
queryTaskbarInfo |
|
Returns
ReadOnly(Boolean)
If readOnly is set to true, Gantt cannot be edited.
Declaration
public GanttBuilder ReadOnly(bool readOnly = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
readOnly |
|
Returns
RecordDoubleClick(String)
This event will be triggered when double click on record.
Declaration
public GanttBuilder RecordDoubleClick(string recordDoubleClick)
Parameters
| Type |
Name |
Description |
| System.String |
recordDoubleClick |
|
Returns
Render()
Declaration
public HtmlString Render()
Returns
| Type |
Description |
| System.Web.HtmlString |
|
RenderBaseline(Boolean)
If renderBaseline is set to true, then baselines are rendered for tasks.
Declaration
public GanttBuilder RenderBaseline(bool renderBaseline = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
renderBaseline |
|
Returns
ResizeStart(String)
Triggers when column resize starts.
Declaration
public GanttBuilder ResizeStart(string resizeStart)
Parameters
| Type |
Name |
Description |
| System.String |
resizeStart |
|
Returns
ResizeStop(String)
Triggers when column resize ends.
Declaration
public GanttBuilder ResizeStop(string resizeStop)
Parameters
| Type |
Name |
Description |
| System.String |
resizeStop |
|
Returns
Resizing(String)
Triggers on column resizing.
Declaration
public GanttBuilder Resizing(string resizing)
Parameters
| Type |
Name |
Description |
| System.String |
resizing |
|
Returns
ResourceFields(GanttResourceFields)
Defines mapping properties to find resource values such as id, name, unit and group from resource collection.
Declaration
public GanttBuilder ResourceFields(GanttResourceFields resourceFields)
Parameters
Returns
ResourceFields(Action<GanttResourceFieldsBuilder>)
Declaration
public GanttBuilder ResourceFields(Action<GanttResourceFieldsBuilder> resourceFields)
Parameters
Returns
ResourceIDMapping(String)
Defines mapping property to get resource id value from resource collection.
Declaration
public GanttBuilder ResourceIDMapping(string resourceIDMapping)
Parameters
| Type |
Name |
Description |
| System.String |
resourceIDMapping |
|
Returns
ResourceNameMapping(String)
Defines mapping property to get resource name value from resource collection.
Declaration
public GanttBuilder ResourceNameMapping(string resourceNameMapping)
Parameters
| Type |
Name |
Description |
| System.String |
resourceNameMapping |
|
Returns
Resources(Object)
Defines resource collection assigned for projects.
Declaration
public GanttBuilder Resources(object resources)
Parameters
| Type |
Name |
Description |
| System.Object |
resources |
|
Returns
RowDataBound(String)
This will be triggered before the row element is appended to the Grid element.
Declaration
public GanttBuilder RowDataBound(string rowDataBound)
Parameters
| Type |
Name |
Description |
| System.String |
rowDataBound |
|
Returns
RowDeselected(String)
Triggers when a selected row is deselected.
Declaration
public GanttBuilder RowDeselected(string rowDeselected)
Parameters
| Type |
Name |
Description |
| System.String |
rowDeselected |
|
Returns
RowDeselecting(String)
Triggers before deselecting the selected row.
Declaration
public GanttBuilder RowDeselecting(string rowDeselecting)
Parameters
| Type |
Name |
Description |
| System.String |
rowDeselecting |
|
Returns
RowDrag(String)
Triggers when row elements are dragged (moved) continuously.
Declaration
public GanttBuilder RowDrag(string rowDrag)
Parameters
| Type |
Name |
Description |
| System.String |
rowDrag |
|
Returns
RowDragStart(String)
Triggers when row element’s drag(move) starts.
Declaration
public GanttBuilder RowDragStart(string rowDragStart)
Parameters
| Type |
Name |
Description |
| System.String |
rowDragStart |
|
Returns
RowDragStartHelper(String)
Triggers when row element’s before drag(move).
Declaration
public GanttBuilder RowDragStartHelper(string rowDragStartHelper)
Parameters
| Type |
Name |
Description |
| System.String |
rowDragStartHelper |
|
Returns
RowDrop(String)
Triggers when row elements are dropped on the target row.
Declaration
public GanttBuilder RowDrop(string rowDrop)
Parameters
| Type |
Name |
Description |
| System.String |
rowDrop |
|
Returns
RowHeight(Int32)
Defines height value for grid rows and chart rows in Gantt.
Declaration
public GanttBuilder RowHeight(int rowHeight)
Parameters
| Type |
Name |
Description |
| System.Int32 |
rowHeight |
|
Returns
RowSelected(String)
Triggers after row selection occurs.
Declaration
public GanttBuilder RowSelected(string rowSelected)
Parameters
| Type |
Name |
Description |
| System.String |
rowSelected |
|
Returns
RowSelecting(String)
Triggers before row selection occurs.
Declaration
public GanttBuilder RowSelecting(string rowSelecting)
Parameters
| Type |
Name |
Description |
| System.String |
rowSelecting |
|
Returns
SearchSettings(GanttSearchSettings)
Configures the search settings for Gantt.
{% codeBlock src='gantt/searchSettings/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder SearchSettings(GanttSearchSettings searchSettings)
Parameters
Returns
SearchSettings(Action<GanttSearchSettingsBuilder>)
Declaration
public GanttBuilder SearchSettings(Action<GanttSearchSettingsBuilder> searchSettings)
Parameters
Returns
SegmentData(Object)
Defines segment collection assigned for tasks.
Declaration
public GanttBuilder SegmentData(object segmentData)
Parameters
| Type |
Name |
Description |
| System.Object |
segmentData |
|
Returns
SelectedRowIndex(Int32)
The selectedRowIndex allows you to select a row at initial rendering.
You can also get the currently selected row index.
Declaration
public GanttBuilder SelectedRowIndex(int selectedRowIndex)
Parameters
| Type |
Name |
Description |
| System.Int32 |
selectedRowIndex |
|
Returns
SelectionSettings(GanttSelectionSettings)
Configures the selection settings.
{% codeBlock src='gantt/selectionSettings/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder SelectionSettings(GanttSelectionSettings selectionSettings)
Parameters
Returns
SelectionSettings(Action<GanttSelectionSettingsBuilder>)
Declaration
public GanttBuilder SelectionSettings(Action<GanttSelectionSettingsBuilder> selectionSettings)
Parameters
Returns
ShowColumnMenu(Boolean)
If showColumnMenu set to true, then it will enable the column menu options in each columns.
Declaration
public GanttBuilder ShowColumnMenu(bool showColumnMenu = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showColumnMenu |
|
Returns
ShowInlineNotes(Boolean)
To show notes column cell values inside the cell or in tooltip.
Declaration
public GanttBuilder ShowInlineNotes(bool showInlineNotes = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showInlineNotes |
|
Returns
ShowOverAllocation(Boolean)
It enables to render the overallocation container for resource view Gantt.
Declaration
public GanttBuilder ShowOverAllocation(bool showOverAllocation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showOverAllocation |
|
Returns
SortSettings(GanttSortSettings)
Configures the sort settings of the Gantt.
{% codeBlock src='gantt/sortSettings/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder SortSettings(GanttSortSettings sortSettings)
Parameters
Returns
SortSettings(Action<GanttSortSettingsBuilder>)
Declaration
public GanttBuilder SortSettings(Action<GanttSortSettingsBuilder> sortSettings)
Parameters
Returns
SplitterResized(String)
Triggers when splitter resizing action completed.
Declaration
public GanttBuilder SplitterResized(string splitterResized)
Parameters
| Type |
Name |
Description |
| System.String |
splitterResized |
|
Returns
SplitterResizeStart(String)
Triggers when splitter resizing starts.
Declaration
public GanttBuilder SplitterResizeStart(string splitterResizeStart)
Parameters
| Type |
Name |
Description |
| System.String |
splitterResizeStart |
|
Returns
SplitterResizing(String)
Triggers when splitter bar was dragging.
Declaration
public GanttBuilder SplitterResizing(string splitterResizing)
Parameters
| Type |
Name |
Description |
| System.String |
splitterResizing |
|
Returns
SplitterSettings(GanttSplitterSettings)
Configures the splitter settings for Gantt.
{% codeBlock src='gantt/splitterSettings/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder SplitterSettings(GanttSplitterSettings splitterSettings)
Parameters
Returns
SplitterSettings(Action<GanttSplitterSettingsBuilder>)
Declaration
public GanttBuilder SplitterSettings(Action<GanttSplitterSettingsBuilder> splitterSettings)
Parameters
Returns
TaskbarEdited(String)
This will be triggered taskbar was dragged and dropped on new position.
Declaration
public GanttBuilder TaskbarEdited(string taskbarEdited)
Parameters
| Type |
Name |
Description |
| System.String |
taskbarEdited |
|
Returns
TaskbarEditing(String)
This event will be triggered when taskbar was in dragging state.
Declaration
public GanttBuilder TaskbarEditing(string taskbarEditing)
Parameters
| Type |
Name |
Description |
| System.String |
taskbarEditing |
|
Returns
TaskbarHeight(Nullable<Int32>)
Defines height of taskbar element in Gantt.
Declaration
public GanttBuilder TaskbarHeight(int? taskbarHeight)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.Int32> |
taskbarHeight |
|
Returns
TaskbarTemplate(String)
The task bar template that renders customized child task bars from the given template.
Declaration
public GanttBuilder TaskbarTemplate(string taskbarTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
taskbarTemplate |
|
Returns
TaskFields(GanttTaskFields)
Defines mapping properties to find task values such as id, start date, end date, duration and progress values from data source.
{% codeBlock src='gantt/taskFields/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder TaskFields(GanttTaskFields taskFields)
Parameters
Returns
TaskFields(Action<GanttTaskFieldsBuilder>)
Declaration
public GanttBuilder TaskFields(Action<GanttTaskFieldsBuilder> taskFields)
Parameters
Returns
TaskMode(ScheduleMode)
Specifies task schedule mode for a project.
Declaration
public GanttBuilder TaskMode(ScheduleMode taskMode)
Parameters
Returns
TaskType(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 GanttBuilder TaskType(TaskType taskType)
Parameters
Returns
TimelineSettings(GanttTimelineSettings)
Configures timeline settings of Gantt.
Defines default timeline modes or customized top tier mode and bottom tier mode or single tier only.
{% codeBlock src='gantt/timelineSettings/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder TimelineSettings(GanttTimelineSettings timelineSettings)
Parameters
Returns
TimelineSettings(Action<GanttTimelineSettingsBuilder>)
Declaration
public GanttBuilder TimelineSettings(Action<GanttTimelineSettingsBuilder> timelineSettings)
Parameters
Returns
Timezone(String)
By default, task schedule dates are calculated with system time zone.If Gantt chart assigned with specific time zone,
then schedule dates are calculated as given time zone date value.
Declaration
public GanttBuilder Timezone(string timezone)
Parameters
| Type |
Name |
Description |
| System.String |
timezone |
|
Returns
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 GanttBuilder Toolbar(object toolbar)
Parameters
| Type |
Name |
Description |
| System.Object |
toolbar |
|
Returns
Triggers when toolbar item was clicked.
Declaration
public GanttBuilder ToolbarClick(string toolbarClick)
Parameters
| Type |
Name |
Description |
| System.String |
toolbarClick |
|
Returns
Enables or disables default tooltip of Gantt element and defines customized tooltip for Gantt elements.
{% codeBlock src='gantt/tooltipSettings/index.md' %}{% endcodeBlock %}
Declaration
public GanttBuilder TooltipSettings(GanttTooltipSettings tooltipSettings)
Parameters
Returns
Declaration
public GanttBuilder TooltipSettings(Action<GanttTooltipSettingsBuilder> tooltipSettings)
Parameters
Returns
TreeColumnIndex(Int32)
To define expander column index in Grid.
Declaration
public GanttBuilder TreeColumnIndex(int treeColumnIndex)
Parameters
| Type |
Name |
Description |
| System.Int32 |
treeColumnIndex |
|
Returns
UpdateOffsetOnTaskbarEdit(Boolean)
Specifies whether to update offset value on a task for all the predecessor edit actions.
Declaration
public GanttBuilder UpdateOffsetOnTaskbarEdit(bool UpdateOffsetOnTaskbarEdit = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
UpdateOffsetOnTaskbarEdit |
|
Returns
ValidateManualTasksOnLinking(Boolean)
If validateManualTasksOnLinking is set to true,
it enables date validation while connecting manually scheduled tasks with predecessor
Declaration
public GanttBuilder ValidateManualTasksOnLinking(bool validateManualTasksOnLinking = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
validateManualTasksOnLinking |
|
Returns
ViewType(ViewType)
Defines the view type of the Gantt.
Declaration
public GanttBuilder ViewType(ViewType viewType)
Parameters
Returns
Width(Double)
Defines the width of the Gantt component container.
Declaration
public GanttBuilder Width(double width)
Parameters
| Type |
Name |
Description |
| System.Double |
width |
|
Returns
Width(String)
Defines the width of the Gantt component container.
Declaration
public GanttBuilder Width(string width)
Parameters
| Type |
Name |
Description |
| System.String |
width |
|
Returns
WorkUnit(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 GanttBuilder WorkUnit(WorkUnit workUnit)
Parameters
Returns
WorkWeek(String[])
Defines workweek of project.
Declaration
public GanttBuilder WorkWeek(string[] workWeek)
Parameters
| Type |
Name |
Description |
| System.String[] |
workWeek |
|
Returns
ZoomingLevels(Object)
Configure zooming levels of Gantt Timeline
Declaration
public GanttBuilder ZoomingLevels(object zoomingLevels)
Parameters
| Type |
Name |
Description |
| System.Object |
zoomingLevels |
|
Returns
