Class SfGantt<TValue>

Blazor Gantt chart is a project management tool which is used for scheduling and managing projects. It allows us to manage tasks, task relationships, and resources in a project.

Inheritance
System.Object
BaseComponent
SfGantt<TValue>
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.Blazor.Gantt
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfGantt<TValue> : BaseComponent, IDisposable, IGantt, IBaseComponent
Type Parameters
Name Description
TValue

Constructors

SfGantt()

Declaration
public SfGantt()

Properties

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<GanttAddDialogField> AddDialogFields { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GanttAddDialogField>

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

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

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

ContextMenuItems

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

Declaration
public object ContextMenuItems { get; set; }
Property Value
Type Description
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<TValue> DataSource { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TValue>

DataSourceChanged

DataSourceChanged

Declaration
public EventCallback<IEnumerable<TValue>> DataSourceChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Collections.Generic.IEnumerable<TValue>>

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<GanttDayWorkingTime> DayWorkingTime { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GanttDayWorkingTime>

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<GanttEditDialogField> EditDialogFields { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GanttEditDialogField>

EditSettings

Configures edit settings of Gantt.

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

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

EventMarkers

Defines events and status of project throughout the timeline.

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

FilterSettings

Configures the filter settings for Gantt.

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

GridLines

Configures the grid lines in tree grid and gantt chart.

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

Height

Defines the height of the Gantt component container.

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

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<GanttHoliday> Holidays { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GanttHoliday>

HtmlAttributes

HtmlAttributes.

Declaration
public Dictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ID

To get Gantt ID

Declaration
public override string ID { get; set; }
Property Value
Type Description
System.String
Overrides
Syncfusion.Blazor.BaseComponent.ID

IncludeWeekend

Defines weekend days are considered as working day or not.

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

jsProperty

To get jsProperty

Declaration
protected override string jsProperty { get; set; }
Property Value
Type Description
System.String
Overrides

LabelSettings

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

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

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

ModelType

Defines ModelType

Declaration
public override Type ModelType { get; set; }
Property Value
Type Description
System.Type
Overrides
Syncfusion.Blazor.BaseComponent.ModelType

nameSpace

To get Gantt namespace

Declaration
protected override string nameSpace { get; set; }
Property Value
Type Description
System.String
Overrides

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 Nullable<DateTime> ProjectEndDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

ProjectStartDate

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

Declaration
public Nullable<DateTime> ProjectStartDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Query

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

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

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

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

SearchSettings

Configures the search settings for Gantt.

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

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

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

SplitterSettings

Configures the splitter settings for Gantt.

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

TaskbarHeight

Defines height of taskbar element in Gantt.

Declaration
public Nullable<int> TaskbarHeight { get; set; }
Property Value
Type Description
System.Nullable<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 GanttTaskFields TaskFields { get; set; }
Property Value
Type Description
GanttTaskFields

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

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

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

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

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

AddPredecessor(Double, String)

To add dependency for Task.

Declaration
public Task AddPredecessor(double id, string predecessorString)
Parameters
Type Name Description
System.Double id
System.String predecessorString
Returns
Type Description
System.Threading.Tasks.Task

AddRecord(Object, Nullable<RowPosition>, Nullable<Double>)

Method to add record.

Declaration
public Task AddRecord(object data = null, Nullable<RowPosition> rowPosition = null, Nullable<double> rowIndex = null)
Parameters
Type Name Description
System.Object data
System.Nullable<RowPosition> rowPosition
System.Nullable<System.Double> rowIndex
Returns
Type Description
System.Threading.Tasks.Task

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

CancelEdit()

Cancels edited state.

Declaration
public Task CancelEdit()
Returns
Type Description
System.Threading.Tasks.Task

ChangeTaskMode(Object)

To change the mode of a record.

Declaration
public Task ChangeTaskMode(object data)
Parameters
Type Name Description
System.Object data
Returns
Type Description
System.Threading.Tasks.Task

ClearFiltering()

Clears all the filtered columns in Gantt.

Declaration
public Task ClearFiltering()
Returns
Type Description
System.Threading.Tasks.Task

ClearSelection()

Deselects the current selected rows and cells.

Declaration
public Task ClearSelection()
Returns
Type Description
System.Threading.Tasks.Task

ClearSorting()

Clears all the sorted columns of the Gantt.

Declaration
public Task ClearSorting()
Returns
Type Description
System.Threading.Tasks.Task

CollapseAll()

Method to collapse all the rows of Gantt.

Declaration
public Task CollapseAll()
Returns
Type Description
System.Threading.Tasks.Task

CollapseByID(Double)

Collapse the record by id value.

Declaration
public Task CollapseByID(double id)
Parameters
Type Name Description
System.Double id
Returns
Type Description
System.Threading.Tasks.Task

CollapseByIndex(Double)

Collapse the record by index value.

Declaration
public Task CollapseByIndex(double index)
Parameters
Type Name Description
System.Double index
Returns
Type Description
System.Threading.Tasks.Task

ConvertToMilestone(String)

Method to convert task data to milestone data.

Declaration
public Task ConvertToMilestone(string id)
Parameters
Type Name Description
System.String id
Returns
Type Description
System.Threading.Tasks.Task

CsvExport(Object, Nullable<Boolean>, Object, Nullable<Boolean>)

Export Gantt data to CSV file.

Declaration
public Task CsvExport(object excelExportProperties = null, Nullable<bool> isMultipleExport = null, object workbook = null, Nullable<bool> isBlob = null)
Parameters
Type Name Description
System.Object excelExportProperties
System.Nullable<System.Boolean> isMultipleExport
System.Object workbook
System.Nullable<System.Boolean> isBlob
Returns
Type Description
System.Threading.Tasks.Task

DeleteRecord(Object)

Method to delete record.

Declaration
public Task DeleteRecord(object taskDetail)
Parameters
Type Name Description
System.Object taskDetail
Returns
Type Description
System.Threading.Tasks.Task

EnableItems(Object, Boolean)

Enables or disables ToolBar items.

Declaration
public Task EnableItems(object items, bool isEnable)
Parameters
Type Name Description
System.Object items
System.Boolean isEnable
Returns
Type Description
System.Threading.Tasks.Task

ExcelExport(Object, Nullable<Boolean>, Object, Nullable<Boolean>)

Export Gantt data to Excel file(.xlsx).

Declaration
public Task ExcelExport(object excelExportProperties = null, Nullable<bool> isMultipleExport = null, object workbook = null, Nullable<bool> isBlob = null)
Parameters
Type Name Description
System.Object excelExportProperties
System.Nullable<System.Boolean> isMultipleExport
System.Object workbook
System.Nullable<System.Boolean> isBlob
Returns
Type Description
System.Threading.Tasks.Task

ExpandAll()

Method to expand all the rows of Gantt.

Declaration
public Task ExpandAll()
Returns
Type Description
System.Threading.Tasks.Task

ExpandByID(Double)

Expand the record by task id.

Declaration
public Task ExpandByID(double id)
Parameters
Type Name Description
System.Double id
Returns
Type Description
System.Threading.Tasks.Task

ExpandByIndex(Double)

Expand the record by index value.

Declaration
public Task ExpandByIndex(double index)
Parameters
Type Name Description
System.Double index
Returns
Type Description
System.Threading.Tasks.Task

FilterByColumn(String, String, Object, String, Nullable<Boolean>, Nullable<Boolean>)

Filters TreeGrid row by column name with the given options.

Declaration
public Task FilterByColumn(string fieldName, string filterOperator, object filterValue, string predicate = null, Nullable<bool> matchCase = null, Nullable<bool> ignoreAccent = null)
Parameters
Type Name Description
System.String fieldName
System.String filterOperator
System.Object filterValue
System.String predicate
System.Nullable<System.Boolean> matchCase
System.Nullable<System.Boolean> ignoreAccent
Returns
Type Description
System.Threading.Tasks.Task

FitToProject()

To show all project task in available chart width

Declaration
public Task FitToProject()
Returns
Type Description
System.Threading.Tasks.Task

GetDurationString(Double, String)

Get duration value as string combined with duration and unit values.

Declaration
public Task<string> GetDurationString(double duration, string durationUnit)
Parameters
Type Name Description
System.Double duration
System.String durationUnit
Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetFormatedDate(DateTime, String)

Get formated date in Gantt validations

Declaration
public Task<string> GetFormatedDate(DateTime date, string format = null)
Parameters
Type Name Description
System.DateTime date
System.String format
Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetGanttColumns()

Gets the Gantt columns.

Declaration
public Task<List<ColumnModel>> GetGanttColumns()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ColumnModel>>

GetGridColumns()

Gets the columns from the TreeGrid.

Declaration
public Task<List<ColumnModel>> GetGridColumns()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ColumnModel>>

GetJSNamespace()

Returns a NameSpace object of the specified type

Declaration
public string GetJSNamespace()
Returns
Type Description
System.String

GetRecordByID(String)

Method to get record by id value.

Declaration
public Task<IGanttData<TValue>> GetRecordByID(string id)
Parameters
Type Name Description
System.String id
Returns
Type Description
System.Threading.Tasks.Task<IGanttData<TValue>>

GetRowByID(Object)

Method to get the row element by task id.

Declaration
public Task<DOM> GetRowByID(object id)
Parameters
Type Name Description
System.Object id
Returns
Type Description
System.Threading.Tasks.Task<DOM>

GetRowByIndex(Double)

Method to get chart row value by index.

Declaration
public Task<DOM> GetRowByIndex(double index)
Parameters
Type Name Description
System.Double index
Returns
Type Description
System.Threading.Tasks.Task<DOM>

GetTaskbarHeight()

Method to get taskbarHeight.

Declaration
public Task<double> GetTaskbarHeight()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetTaskByUniqueID(String)

Method to get task by uniqueId value.

Declaration
public Task<IGanttData<TValue>> GetTaskByUniqueID(string id)
Parameters
Type Name Description
System.String id
Returns
Type Description
System.Threading.Tasks.Task<IGanttData<TValue>>

GetWorkString(Double, String)

Get work value as string combined with work and unit values.

Declaration
public Task<string> GetWorkString(double work, string workUnit)
Parameters
Type Name Description
System.Double work
System.String workUnit
Returns
Type Description
System.Threading.Tasks.Task<System.String>

HideColumn(Object, String)

Hides a column by column name.

Declaration
public Task HideColumn(object keys, string hideBy = null)
Parameters
Type Name Description
System.Object keys
System.String hideBy
Returns
Type Description
System.Threading.Tasks.Task

HideSpinner()

Method used to hide spinner.

Declaration
public Task HideSpinner()
Returns
Type Description
System.Threading.Tasks.Task

Indent()

To indent the level of selected task to the hierarchical Gantt task.

Declaration
public Task Indent()
Returns
Type Description
System.Threading.Tasks.Task

NextTimeSpan(String)

To update timeline at end point with one unit.

Declaration
public Task NextTimeSpan(string mode = null)
Parameters
Type Name Description
System.String mode
Returns
Type Description
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task
Overrides

OnHybridAfterRender(Boolean)

OnHybridAfterRender

Declaration
protected Task OnHybridAfterRender(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task

OnHybridInitialized()

Receive its initial parameters from its parent in the render tree

Declaration
protected Task OnHybridInitialized()
Returns
Type Description
System.Threading.Tasks.Task

OnHybridParametersSet()

Incoming values have been assigned to properties

Declaration
protected Task OnHybridParametersSet()
Returns
Type Description
System.Threading.Tasks.Task

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

OpenAddDialog()

Method to open Add dialog.

Declaration
public Task OpenAddDialog()
Returns
Type Description
System.Threading.Tasks.Task

OpenEditDialog(Nullable<Double>)

Method to open Edit dialog.

Declaration
public Task OpenEditDialog(Nullable<double> taskId = null)
Parameters
Type Name Description
System.Nullable<System.Double> taskId
Returns
Type Description
System.Threading.Tasks.Task

Outdent()

To outdent the level of selected task from the hierarchical Gantt task.

Declaration
public Task Outdent()
Returns
Type Description
System.Threading.Tasks.Task

PdfExport(PdfExportProperties, Nullable<Boolean>, Object)

Export Gantt data to PDF document.

Declaration
public Task PdfExport(PdfExportProperties pdfExportProperties = null, Nullable<bool> isMultipleExport = null, object pdfDoc = null)
Parameters
Type Name Description
PdfExportProperties pdfExportProperties
System.Nullable<System.Boolean> isMultipleExport
System.Object pdfDoc
Returns
Type Description
System.Threading.Tasks.Task

PreviousTimeSpan(String)

To update timeline at start point with one unit.

Declaration
public Task PreviousTimeSpan(string mode = null)
Parameters
Type Name Description
System.String mode
Returns
Type Description
System.Threading.Tasks.Task

RemovePredecessor(Double)

To remove dependency from task.

Declaration
public Task RemovePredecessor(double id)
Parameters
Type Name Description
System.Double id
Returns
Type Description
System.Threading.Tasks.Task

RemoveSortColumn(String)

To remove sorted records of particular column.

Declaration
public Task RemoveSortColumn(string columnName)
Parameters
Type Name Description
System.String columnName
Returns
Type Description
System.Threading.Tasks.Task

ReorderColumns(Object, String)

Changes the TreeGrid column positions by field names.

Declaration
public Task ReorderColumns(object fromFName, string toFName)
Parameters
Type Name Description
System.Object fromFName
System.String toFName
Returns
Type Description
System.Threading.Tasks.Task

ReorderRows(Object, Double, String)

Reorder the rows based on given indexes and position

Declaration
public Task ReorderRows(object fromIndexes, double toIndex, string position)
Parameters
Type Name Description
System.Object fromIndexes
System.Double toIndex
System.String position
Returns
Type Description
System.Threading.Tasks.Task

ScrollToDate(String)

To move horizontal scroll bar of Gantt to specific date.

Declaration
public Task ScrollToDate(string date)
Parameters
Type Name Description
System.String date
Returns
Type Description
System.Threading.Tasks.Task

ScrollToTask(String)

To move horizontal scroll bar of Gantt to specific task id.

Declaration
public Task ScrollToTask(string taskId)
Parameters
Type Name Description
System.String taskId
Returns
Type Description
System.Threading.Tasks.Task

Search(String)

Method to perform search action in Gantt.

Declaration
public Task Search(string keyVal)
Parameters
Type Name Description
System.String keyVal
Returns
Type Description
System.Threading.Tasks.Task

SelectCell(Object, Nullable<Boolean>)

Selects a cell by the given index.

Declaration
public Task SelectCell(object cellIndex, Nullable<bool> isToggle = null)
Parameters
Type Name Description
System.Object cellIndex
System.Nullable<System.Boolean> isToggle
Returns
Type Description
System.Threading.Tasks.Task

SelectCells(Object)

Selects a collection of cells by row and column indexes.

Declaration
public Task SelectCells(object rowCellIndexes)
Parameters
Type Name Description
System.Object rowCellIndexes
Returns
Type Description
System.Threading.Tasks.Task

SelectRow(Double, Nullable<Boolean>)

Selects a row by given index.

Declaration
public Task SelectRow(double index, Nullable<bool> isToggle = null)
Parameters
Type Name Description
System.Double index
System.Nullable<System.Boolean> isToggle
Returns
Type Description
System.Threading.Tasks.Task

SelectRows(Object)

Selects a collection of rows by indexes.

Declaration
public Task SelectRows(object records)
Parameters
Type Name Description
System.Object records
Returns
Type Description
System.Threading.Tasks.Task

SetScrollTop(Double)

To set scroll top for chart scroll container.

Declaration
public Task SetScrollTop(double scrollTop)
Parameters
Type Name Description
System.Double scrollTop
Returns
Type Description
System.Threading.Tasks.Task

SetSplitterPosition(Object, String)

Method to set splitter position.

Declaration
public Task SetSplitterPosition(object value, string type)
Parameters
Type Name Description
System.Object value
System.String type
Returns
Type Description
System.Threading.Tasks.Task

ShowColumn(Object, String)

Shows a column by its column name.

Declaration
public Task ShowColumn(object keys, string showBy = null)
Parameters
Type Name Description
System.Object keys
System.String showBy
Returns
Type Description
System.Threading.Tasks.Task

ShowSpinner()

Method used to show spinner.

Declaration
public Task ShowSpinner()
Returns
Type Description
System.Threading.Tasks.Task

SortColumn(String, SortDirection, Nullable<Boolean>)

Sorts a column with the given options.

Declaration
public Task SortColumn(string columnName, SortDirection direction, Nullable<bool> isMultiSort = null)
Parameters
Type Name Description
System.String columnName
SortDirection direction
System.Nullable<System.Boolean> isMultiSort
Returns
Type Description
System.Threading.Tasks.Task

UpdateChartScrollOffset(Double, Double)

To set scroll left and top in chart side.

Declaration
public Task UpdateChartScrollOffset(double left, double top)
Parameters
Type Name Description
System.Double left
System.Double top
Returns
Type Description
System.Threading.Tasks.Task

updateChildProperties(String, Object)

Incoming values have been assigned to child properties

Declaration
public void updateChildProperties(string key, object value)
Parameters
Type Name Description
System.String key
System.Object value

UpdateDataSource(Object, Object)

Method to update data source.

Declaration
public Task UpdateDataSource(object dataSource, object args)
Parameters
Type Name Description
System.Object dataSource
System.Object args
Returns
Type Description
System.Threading.Tasks.Task

UpdatePredecessor(Double, String)

To modify current dependency values of Task by task id.

Declaration
public Task UpdatePredecessor(double id, string predecessorString)
Parameters
Type Name Description
System.Double id
System.String predecessorString
Returns
Type Description
System.Threading.Tasks.Task

UpdateProjectDates(DateTime, DateTime, Boolean, String)

To validate project start date and end date.

Declaration
public Task UpdateProjectDates(DateTime startDate, DateTime endDate, bool isTimelineRoundOff, string isFrom = null)
Parameters
Type Name Description
System.DateTime startDate
System.DateTime endDate
System.Boolean isTimelineRoundOff
System.String isFrom
Returns
Type Description
System.Threading.Tasks.Task

UpdateRecordByID(Object)

Method to update record by ID.

Declaration
public Task UpdateRecordByID(object data)
Parameters
Type Name Description
System.Object data
Returns
Type Description
System.Threading.Tasks.Task

UpdateRecordByIndex(Double, Object)

Method to update record by Index.

Declaration
public Task UpdateRecordByIndex(double index, object data)
Parameters
Type Name Description
System.Double index
System.Object data
Returns
Type Description
System.Threading.Tasks.Task

UpdateTaskId(Object, Object)

To update existing taskId with new unique Id.

Declaration
public Task UpdateTaskId(object currentId, object newId)
Parameters
Type Name Description
System.Object currentId
System.Object newId
Returns
Type Description
System.Threading.Tasks.Task

ZoomIn()

To perform Zoom in action on Gantt timeline.

Declaration
public Task ZoomIn()
Returns
Type Description
System.Threading.Tasks.Task

ZoomOut()

To perform zoom out action on Gantt timeline.

Declaration
public Task ZoomOut()
Returns
Type Description
System.Threading.Tasks.Task

Explicit Interface Implementations

IGantt.GanttTemplates

GanttTemplates.

Declaration
GanttTemplates IGantt.GanttTemplates { get; set; }
Returns
Type Description
GanttTemplates

Implements

System.IDisposable