Class GanttModel<T>

Class that defines Gantt model details.

Inheritance
System.Object
GanttModel<T>
Implements
System.IEquatable<GanttModel<T>>
Namespace: Syncfusion.Blazor.Gantt
Assembly: Syncfusion.Blazor.dll
Syntax
public class GanttModel<T> : Object, IEquatable<GanttModel<T>>
Type Parameters
Name Description
T

Constructors

GanttModel()

Declaration
public GanttModel()

Properties

ActionBegin

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

Declaration
public ActionBeginArgs<T> ActionBegin { get; set; }
Property Value
Type Description
ActionBeginArgs<T>

ActionComplete

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

Declaration
public ActionCompleteArgs<T> ActionComplete { get; set; }
Property Value
Type Description
ActionCompleteArgs<T>

ActionFailure

Triggers when actions are failed.

Declaration
public FailureEventArgs ActionFailure { get; set; }
Property Value
Type Description
FailureEventArgs

AddDialogFields

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.

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

AllowExcelExport

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

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

AllowFiltering

Enables or disables filtering support in Gantt.

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

AllowKeyboard

Enables or disables the key board interaction of Gantt.

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

AllowPdfExport

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

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

AllowReordering

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 bool AllowReordering { get; set; }
Property Value
Type Description
System.Boolean

AllowResizing

If allowResizing is set to true, Gantt columns can be resized.

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

AllowRowDragAndDrop

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

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

AllowSelection

If allowSelection is set to true, it allows selection of (highlight row) Gantt chart rows by clicking it.

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

AllowSorting

If allowSorting is set to true, it allows sorting of gantt chart tasks when column header is clicked.

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

AllowUnscheduledTasks

Enables or disables rendering of unscheduled tasks in Gantt.

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

AutoFocusTasks

Enables or disables the focusing the task bar on click action.

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

BaselineColor

Defines the baseline bar color.

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

BeforeTooltipRender

Triggers before tooltip get rendered.

Declaration
public EventCallback<object> BeforeTooltipRender { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

CellEdit

This will be triggered a cell get begins to edit.

Declaration
public EventCallback<object> CellEdit { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

CellSelected

Triggers after a cell is selected.

Declaration
public CellSelectEventArgs<T> CellSelected { get; set; }
Property Value
Type Description
CellSelectEventArgs<T>

CellSelecting

Triggers before any cell selection occurs.

Declaration
public EventCallback<object> CellSelecting { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

CollapseAllParentTasks

If collapseAllParentTasks set to true, then root tasks are rendered with collapsed state.

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

Collapsed

This will be triggered after the row getting collapsed.

Declaration
public EventCallback<object> Collapsed { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Collapsing

This will be triggered before the row getting collapsed.

Declaration
public EventCallback<object> Collapsing { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

ColumnMenuClick

Triggers when click on column menu.

Declaration
public ColumnMenuClickEventArgs ColumnMenuClick { get; set; }
Property Value
Type Description
ColumnMenuClickEventArgs

ColumnMenuItems

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

Columns

Defines column collection displayed in grid If the columns declaration was empty then columns are automatically populated from taskSettings value.

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

ConnectorLineBackground

Defines background color of dependency lines.

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

ConnectorLineWidth

Defines width of dependency lines.

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

ContextMenuClick

Triggers when click on context menu.

Declaration
public ContextMenuClickEventArgs<T> ContextMenuClick { get; set; }
Property Value
Type Description
ContextMenuClickEventArgs<T>

ContextMenuItems

contextMenuItems defines both built-in and custom context menu items.

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

ContextMenuOpen

Triggers before context menu opens.

Declaration
public ContextMenuOpenEventArgs<T> ContextMenuOpen { get; set; }
Property Value
Type Description
ContextMenuOpenEventArgs<T>

Created

Triggers when the component is created.

Declaration
public EventCallback<object> Created { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

DataBound

Triggers when data source is populated in the Grid.

Declaration
public EventCallback<object> DataBound { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

DataSource

It is used to render Gantt chart rows and tasks. dataSource value was defined as array of JavaScript objects or instances of DataManager.

Declaration
public IEnumerable<T> DataSource { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<T>

DateFormat

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 string DateFormat { get; set; }
Property Value
Type Description
System.String

DayWorkingTime

Defines customized working time of project.

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

Destroyed

Triggers when the component is destroyed.

Declaration
public EventCallback<object> Destroyed { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

DisableHtmlEncode

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

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

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 DurationUnit DurationUnit { get; set; }
Property Value
Type Description
DurationUnit

EditDialogFields

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.

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

EditSettings

Configures edit settings of Gantt.

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

EnableContextMenu

If enableContextMenu is set to true, Enable context menu in Gantt.

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

EnablePersistence

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

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

EnablePredecessorValidation

If enablePredecessorValidation is set to true, it allows to validate the predecessor link.

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

EnableRtl

Enable or disable rendering component in right to left direction.

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

EndEdit

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

Declaration
public EventCallback<object> EndEdit { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

EventMarkers

Defines events and status of project throughout the timeline.

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

Expanded

This will be triggered after the row getting expanded.

Declaration
public EventCallback<object> Expanded { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Expanding

This will be triggered before the row getting expanded.

Declaration
public EventCallback<object> Expanding { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

FilterSettings

Configures the filter settings for Gantt.

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

GridLines

Configures the grid lines in tree grid and gantt chart.

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

HeaderCellInfo

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

Declaration
public HeaderCellInfoEventArgs HeaderCellInfo { get; set; }
Property Value
Type Description
HeaderCellInfoEventArgs

Height

Defines the height of the Gantt component container.

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

HighlightWeekends

If highlightWeekends set to true, then all weekend days are highlighted in week - day timeline mode.

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

Holidays

Defines holidays presented in project timeline.

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

IncludeWeekend

Defines weekend days are considered as working day or not.

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

LabelSettings

Defines the right, left and inner task labels in task bar.

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

Load

Triggered before the Gantt control gets rendered.

Declaration
public EventCallback<object> Load { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

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

MilestoneTemplate

The milestone template that renders customized milestone task from the given template.

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

ParentTaskbarTemplate

The parent task bar template that renders customized parent task bars from the given template.

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

ProjectEndDate

Defines end date of the project, if projectEndDate value not set then it will be calculated from data source.

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

ProjectStartDate

Defines start date of the project, if projectStartDate value not set then it will be calculated from data source.

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

Query

Defines the external Query that will be executed along with data processing.

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

QueryCellInfo

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

Declaration
public EventCallback<object> QueryCellInfo { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

QueryTaskbarInfo

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

Declaration
public EventCallback<object> QueryTaskbarInfo { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

RenderBaseline

If renderBaseline is set to true, then baselines are rendered for tasks.

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

ResourceFields

Defines mapping properties to find resource values such as id, name, unit and group from resource collection.

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

ResourceIDMapping

Defines mapping property to get resource id value from resource collection.

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

ResourceNameMapping

Defines mapping property to get resource name value from resource collection.

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

Resources

Defines resource collection assigned for projects.

Declaration
public IEnumerable<T> Resources { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<T>

RowDataBound

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

Declaration
public EventCallback<object> RowDataBound { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

RowDeselected

Triggers when a selected row is deselected.

Declaration
public EventCallback<object> RowDeselected { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

RowHeight

Defines height value for grid rows and chart rows in Gantt.

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

RowSelected

Triggers after a row is selected.

Declaration
public EventCallback<object> RowSelected { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

RowSelecting

Triggers before row selection occurs.

Declaration
public EventCallback<object> RowSelecting { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

SearchSettings

Configures the search settings for Gantt.

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

SelectedRowIndex

The selectedRowIndex allows you to select a row at initial rendering. You can also get the currently selected row index.

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

SelectionSettings

Configures the selection settings.

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

ShowColumnMenu

If showColumnMenu set to true, then it will enable the column menu options in each columns.

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

SortSettings

Configures the sort settings of the Gantt.

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

SplitterResized

Triggers when splitter resizing action completed.

Declaration
public EventCallback<object> SplitterResized { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

SplitterResizeStart

Triggers when splitter resizing starts.

Declaration
public ResizeEventArgs SplitterResizeStart { get; set; }
Property Value
Type Description
ResizeEventArgs

SplitterResizing

Triggers when splitter bar was dragging.

Declaration
public ResizingEventArgs SplitterResizing { get; set; }
Property Value
Type Description
ResizingEventArgs

SplitterSettings

Configures the splitter settings for Gantt.

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

TaskbarEdited

This will be triggered taskbar was dragged and dropped on new position.

Declaration
public EventCallback<object> TaskbarEdited { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

TaskbarEditing

This event will be triggered when taskbar was in dragging state.

Declaration
public EventCallback<object> TaskbarEditing { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

TaskbarHeight

Defines height of taskbar element in Gantt.

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

TaskbarTemplate

The task bar template that renders customized child task bars from the given template.

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

TaskFields

Defines mapping properties to find task values such as id, start date, end date, duration and progress values from data source.

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

TaskMode

Specifies task schedule mode for a project.

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

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

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 TimelineSettingsModel TimelineSettings { get; set; }
Property Value
Type Description
TimelineSettingsModel

Timezone

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 string Timezone { get; set; }
Property Value
Type Description
System.String

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

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

ToolbarClick

Triggers when toolbar item was clicked.

Declaration
public ClickEventArgs ToolbarClick { get; set; }
Property Value
Type Description
ClickEventArgs

TooltipSettings

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

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

TreeColumnIndex

To define expander column index in Grid.

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

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

ViewType

Defines the view type of the Gantt.

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

Width

Defines the width of the Gantt component container.

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

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

WorkWeek

Defines workweek of project.

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

Methods

Equals(GanttModel<T>)

Returns boolean value by comparing GanttModel

Declaration
public bool Equals(GanttModel<T> ganttModel)
Parameters
Type Name Description
GanttModel<T> ganttModel
Returns
Type Description
System.Boolean

Equals(Object)

Returns boolean value by comparing object

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

GetHashCode()

Returns hashcode for current object

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

Implements

System.IEquatable<>