RadzenGantt<TItem> Class

RadzenGantt<TItem>linkLink to this section

Displays tasks in a split view: hierarchical rows on the left and a timeline with task bars on the right.

Declaration

public RadzenGantt<TItem>()

AllowAlternatingRowslinkLink to this section

Gets or sets whether alternating rows are shown.

Declaration

public bool AllowAlternatingRows { get; set; }

Property Value

AllowColumnPickinglinkLink to this section

Enables column picking. Default is false.

Declaration

public bool AllowColumnPicking { get; set; }

Property Value

AllowColumnReorderlinkLink to this section

Enables column reordering. Default is false.

Declaration

public bool AllowColumnReorder { get; set; }

Property Value

AllowColumnResizelinkLink to this section

Enables column resizing. Default is false.

Declaration

public bool AllowColumnResize { get; set; }

Property Value

AllowFilterDateInputlinkLink to this section

Gets or sets whether filter date input is allowed.

Declaration

public bool AllowFilterDateInput { get; set; }

Property Value

AllowFilteringlinkLink to this section

Enables filtering in the left pane grid. Default is true.

Declaration

public bool AllowFiltering { get; set; }

Property Value

AllowMultiColumnSortinglinkLink to this section

Enables multi-column sorting. Default is false.

Declaration

public bool AllowMultiColumnSorting { get; set; }

Property Value

AllowPaginglinkLink to this section

Enables paging in the left pane grid. Default is false.

Declaration

public bool AllowPaging { get; set; }

Property Value

AllowRowSelectOnRowClicklinkLink to this section

Gets or sets whether row selection is allowed on row click.

Declaration

public bool AllowRowSelectOnRowClick { get; set; }

Property Value

AllowSortinglinkLink to this section

Enables sorting in the left pane grid. Default is true.

Declaration

public bool AllowSorting { get; set; }

Property Value

AllowVirtualizationlinkLink to this section

Enables row virtualization. Default is false.

Declaration

public bool AllowVirtualization { get; set; }

Property Value

AndOperatorTextlinkLink to this section

And operator text.

Declaration

public string AndOperatorText { get; set; }

Property Value

ApplyFilterTextlinkLink to this section

Apply filter text.

Declaration

public string ApplyFilterText { get; set; }

Property Value

BaselineEndPropertylinkLink to this section

Property name for the baseline (planned) end date.

Declaration

public string BaselineEndProperty { get; set; }

Property Value

BaselineStartPropertylinkLink to this section

Property name for the baseline (planned) start date. When set together with BaselineEndProperty, a secondary bar is rendered behind the actual bar showing planned vs actual.

Declaration

public string BaselineStartProperty { get; set; }

Property Value

CellClicklinkLink to this section

Cell click callback.

Declaration

public EventCallback<DataGridCellMouseEventArgs<TItem>> CellClick { get; set; }

Property Value

CellContextMenulinkLink to this section

Cell context menu callback.

Declaration

public EventCallback<DataGridCellMouseEventArgs<TItem>> CellContextMenu { get; set; }

Property Value

CellDoubleClicklinkLink to this section

Cell double click callback.

Declaration

public EventCallback<DataGridCellMouseEventArgs<TItem>> CellDoubleClick { get; set; }

Property Value

CellRenderlinkLink to this section

Cell render callback.

Declaration

public Action<DataGridCellRenderEventArgs<TItem>> CellRender { get; set; }

Property Value

ClearFilterTextlinkLink to this section

Clear filter text.

Declaration

public string ClearFilterText { get; set; }

Property Value

ColumnReorderedlinkLink to this section

Column reordered callback.

Declaration

public EventCallback<DataGridColumnReorderedEventArgs<TItem>> ColumnReordered { get; set; }

Property Value

ColumnReorderinglinkLink to this section

Column reordering callback.

Declaration

public EventCallback<DataGridColumnReorderingEventArgs<TItem>> ColumnReordering { get; set; }

Property Value

ColumnResizedlinkLink to this section

Column resized callback.

Declaration

public EventCallback<DataGridColumnResizedEventArgs<TItem>> ColumnResized { get; set; }

Property Value

ColumnslinkLink to this section

Optional columns definition for the left pane.

Declaration

public RenderFragment Columns { get; set; }

Property Value

ContainsTextlinkLink to this section

Contains text.

Declaration

public string ContainsText { get; set; }

Property Value

DatalinkLink to this section

Task items.

Declaration

public IEnumerable<TItem> Data { get; set; }

Property Value

DayWidthPxlinkLink to this section

Day cell width in pixels.

Declaration

public int DayWidthPx { get; set; }

Property Value

DensitylinkLink to this section

Gets or sets the density.

Declaration

public Density Density { get; set; }

Property Value

DependencieslinkLink to this section

Optional task dependencies to draw connecting lines using object references. For database scenarios, prefer DependencyData with property-name-based binding.

Declaration

public IEnumerable<GanttDependency<TItem>> Dependencies { get; set; }

Property Value

DependencyDatalinkLink to this section

Collection of dependency items (any POCO with predecessor/successor ID properties). Use together with DependencyFromProperty, DependencyToProperty, and optionally DependencyTypeProperty. When set, takes priority over Dependencies.

Declaration

public IEnumerable<object> DependencyData { get; set; }

Property Value

DependencyFromPropertylinkLink to this section

Property name on DependencyData items that holds the predecessor task ID (must match values of IdProperty on the task items).

Declaration

public string DependencyFromProperty { get; set; }

Property Value

DependencyToPropertylinkLink to this section

Property name on DependencyData items that holds the successor task ID (must match values of IdProperty on the task items).

Declaration

public string DependencyToProperty { get; set; }

Property Value

DependencyTypePropertylinkLink to this section

Optional property name on DependencyData items that holds the dependency type. When not set, all dependencies default to FinishToStart.

Declaration

public string DependencyTypeProperty { get; set; }

Property Value

DoesNotContainTextlinkLink to this section

Does not contain text.

Declaration

public string DoesNotContainText { get; set; }

Property Value

EditModelinkLink to this section

Gets or sets the edit mode.

Declaration

public DataGridEditMode EditMode { get; set; }

Property Value

EmptyTextlinkLink to this section

Gets or sets the empty text.

Declaration

public string EmptyText { get; set; }

Property Value

EndPropertylinkLink to this section

Property name used for task end date.

Declaration

public string EndProperty { get; set; }

Property Value

EndsWithTextlinkLink to this section

Ends with text.

Declaration

public string EndsWithText { get; set; }

Property Value

EqualsTextlinkLink to this section

Equals text.

Declaration

public string EqualsText { get; set; }

Property Value

ExpandModelinkLink to this section

Gets or sets the expand mode for hierarchical data.

Declaration

public DataGridExpandMode ExpandMode { get; set; }

Property Value

FilterlinkLink to this section

Column filter callback.

Declaration

public EventCallback<DataGridColumnFilterEventArgs<TItem>> Filter { get; set; }

Property Value

FilterCaseSensitivitylinkLink to this section

Gets or sets the filter case sensitivity.

Declaration

public FilterCaseSensitivity FilterCaseSensitivity { get; set; }

Property Value

FilterClearedlinkLink to this section

Column filter cleared callback.

Declaration

public EventCallback<DataGridColumnFilterEventArgs<TItem>> FilterCleared { get; set; }

Property Value

FilterModelinkLink to this section

Gets or sets the filter mode.

Declaration

public FilterMode FilterMode { get; set; }

Property Value

FilterPopupRenderModelinkLink to this section

Gets or sets the filter popup render mode.

Declaration

public PopupRenderMode FilterPopupRenderMode { get; set; }

Property Value

FilterTextlinkLink to this section

Filter text.

Declaration

public string FilterText { get; set; }

Property Value

FooterCellRenderlinkLink to this section

Footer cell render callback.

Declaration

public Action<DataGridCellRenderEventArgs<TItem>> FooterCellRender { get; set; }

Property Value

GotoFirstPageOnSortlinkLink to this section

Whether to go to the first page on sort. Default is false.

Declaration

public bool GotoFirstPageOnSort { get; set; }

Property Value

GreaterThanOrEqualsTextlinkLink to this section

Greater than or equals text.

Declaration

public string GreaterThanOrEqualsText { get; set; }

Property Value

GreaterThanTextlinkLink to this section

Greater than text.

Declaration

public string GreaterThanText { get; set; }

Property Value

GridLineslinkLink to this section

Gets or sets the grid lines.

Declaration

public DataGridGridLines GridLines { get; set; }

Property Value

HeaderCellRenderlinkLink to this section

Header cell render callback.

Declaration

public Action<DataGridCellRenderEventArgs<TItem>> HeaderCellRender { get; set; }

Property Value

HeaderDateFormatlinkLink to this section

Date format for the day labels of the Day zoom and the week range labels of the Month zoom. When not set, the short date pattern of Culture without its year part is used, for example M/d for en-US and dd/MM for en-GB.

Declaration

public string HeaderDateFormat { get; set; }

Property Value

HistogramCapacitylinkLink to this section

Optional capacity threshold for the histogram. A capacity line is drawn at this value and columns exceeding it are highlighted as overallocated.

Declaration

public double? HistogramCapacity { get; set; }

Property Value

HistogramLabellinkLink to this section

Gets or sets the accessible label of the histogram. Defaults to "Workload".

Declaration

public string HistogramLabel { get; set; }

Property Value

HistogramValuePropertylinkLink to this section

Optional numeric property name on task items accumulated by the histogram. When not set, the histogram counts active tasks per time unit.

Declaration

public string HistogramValueProperty { get; set; }

Property Value

IdPropertylinkLink to this section

Property name used as unique task id.

Declaration

public string IdProperty { get; set; }

Property Value

IsEmptyTextlinkLink to this section

Is empty text.

Declaration

public string IsEmptyText { get; set; }

Property Value

IsLoadinglinkLink to this section

Gets or sets whether loading indicator is shown.

Declaration

public bool IsLoading { get; set; }

Property Value

IsNotEmptyTextlinkLink to this section

Is not empty text.

Declaration

public string IsNotEmptyText { get; set; }

Property Value

IsNotNullTextlinkLink to this section

Is not null text.

Declaration

public string IsNotNullText { get; set; }

Property Value

IsNullTextlinkLink to this section

Is null text.

Declaration

public string IsNullText { get; set; }

Property Value

IsValidlinkLink to this section

Returns whether the underlying grid has a valid edit state.

Declaration

public bool IsValid { get; }

Property Value

KeyDownlinkLink to this section

Key down callback.

Declaration

public EventCallback<KeyboardEventArgs> KeyDown { get; set; }

Property Value

LeftPaneWidthlinkLink to this section

Width of the left pane (CSS length).

Declaration

public string LeftPaneWidth { get; set; }

Property Value

LessThanOrEqualsTextlinkLink to this section

Less than or equals text.

Declaration

public string LessThanOrEqualsText { get; set; }

Property Value

LessThanTextlinkLink to this section

Less than text.

Declaration

public string LessThanText { get; set; }

Property Value

LoadSettingslinkLink to this section

Load settings callback.

Declaration

public Action<DataGridLoadSettingsEventArgs> LoadSettings { get; set; }

Property Value

LogicalFilterOperatorlinkLink to this section

Gets or sets the logical filter operator.

Declaration

public LogicalFilterOperator LogicalFilterOperator { get; set; }

Property Value

MarkerslinkLink to this section

Optional vertical date markers rendered on the timeline (e.g. deadlines, milestones, releases).

Declaration

public IEnumerable<GanttMarker> Markers { get; set; }

Property Value

NextTextlinkLink to this section

Tooltip for the "Next" navigation button. Default is "Next".

Declaration

public string NextText { get; set; }

Property Value

NonWorkingDayslinkLink to this section

The days of the week considered non-working. Used when ShowWeekends is true. Defaults to Saturday and Sunday.

Declaration

public IEnumerable<DayOfWeek> NonWorkingDays { get; set; }

Property Value

NotEqualsTextlinkLink to this section

Not equals text.

Declaration

public string NotEqualsText { get; set; }

Property Value

OrOperatorTextlinkLink to this section

Or operator text.

Declaration

public string OrOperatorText { get; set; }

Property Value

PageSizelinkLink to this section

Page size when AllowPaging is enabled.

Declaration

public int PageSize { get; set; }

Property Value

PageSizeChangedlinkLink to this section

Page size changed callback.

Declaration

public EventCallback<int> PageSizeChanged { get; set; }

Property Value

ParentIdPropertylinkLink to this section

Property name used as parent task id.

Declaration

public string ParentIdProperty { get; set; }

Property Value

PickedColumnsChangedlinkLink to this section

Picked columns changed callback.

Declaration

public EventCallback<DataGridPickedColumnsChangedEventArgs<TItem>> PickedColumnsChanged { get; set; }

Property Value

PrevTextlinkLink to this section

Tooltip for the "Previous" navigation button. Default is "Previous".

Declaration

public string PrevText { get; set; }

Property Value

ProgressPropertylinkLink to this section

Property name used for task progress (0..100). Optional.

Declaration

public string ProgressProperty { get; set; }

Property Value

RenderlinkLink to this section

Render callback.

Declaration

public Action<DataGridRenderEventArgs<TItem>> Render { get; set; }

Property Value

ResourceColumnslinkLink to this section

Optional columns definition for the resource grid in the left pane. Use RadzenDataGridColumn<T> with TItem="object". Only used when ViewMode is Resource.

Declaration

public RenderFragment ResourceColumns { get; set; }

Property Value

ResourceDatalinkLink to this section

Collection of resource items. Each item can be any POCO — properties are accessed via ResourceIdProperty and ResourceTextProperty. Only used when ViewMode is Resource.

Declaration

public Collections.IEnumerable ResourceData { get; set; }

Property Value

ResourceIdPropertylinkLink to this section

Property name on ResourceData items that holds the unique resource identifier. Must match values of TaskResourceIdProperty on the task items.

Declaration

public string ResourceIdProperty { get; set; }

Property Value

ResourceParentIdPropertylinkLink to this section

Property name on ResourceData items used for hierarchical parent-child relationships. When set, resources are displayed in a tree structure. Tasks of collapsed descendant resources are rolled up onto the nearest visible ancestor row.

Declaration

public string ResourceParentIdProperty { get; set; }

Property Value

ResourceTextPropertylinkLink to this section

Property name on ResourceData items used for the resource display text. Used as the default column when ResourceColumns is not set.

Declaration

public string ResourceTextProperty { get; set; }

Property Value

ResponsivelinkLink to this section

Gets or sets whether grid is responsive.

Declaration

public bool Responsive { get; set; }

Property Value

RowClicklinkLink to this section

Row click callback.

Declaration

public EventCallback<DataGridRowMouseEventArgs<TItem>> RowClick { get; set; }

Property Value

RowCollapselinkLink to this section

Row collapse callback.

Declaration

public EventCallback<TItem> RowCollapse { get; set; }

Property Value

RowCreatelinkLink to this section

Row create callback.

Declaration

public EventCallback<TItem> RowCreate { get; set; }

Property Value

RowDeselectlinkLink to this section

Row deselect callback.

Declaration

public EventCallback<TItem> RowDeselect { get; set; }

Property Value

RowDoubleClicklinkLink to this section

Row double click callback.

Declaration

public EventCallback<DataGridRowMouseEventArgs<TItem>> RowDoubleClick { get; set; }

Property Value

RowEditlinkLink to this section

Row edit callback.

Declaration

public EventCallback<TItem> RowEdit { get; set; }

Property Value

RowExpandlinkLink to this section

Row expand callback.

Declaration

public EventCallback<TItem> RowExpand { get; set; }

Property Value

RowHeightPxlinkLink to this section

Row height in pixels.

Declaration

public int RowHeightPx { get; set; }

Property Value

RowRenderlinkLink to this section

Row render callback.

Declaration

public Action<RowRenderEventArgs<TItem>> RowRender { get; set; }

Property Value

RowSelectlinkLink to this section

Row select callback.

Declaration

public EventCallback<TItem> RowSelect { get; set; }

Property Value

RowUpdatelinkLink to this section

Row update callback.

Declaration

public EventCallback<TItem> RowUpdate { get; set; }

Property Value

SettingsChangedlinkLink to this section

Settings changed callback.

Declaration

public EventCallback<DataGridSettings> SettingsChanged { get; set; }

Property Value

ShowCellDataAsTooltiplinkLink to this section

Gets or sets whether to show cell data as tooltip.

Declaration

public bool ShowCellDataAsTooltip { get; set; }

Property Value

ShowColumnTitleAsTooltiplinkLink to this section

Gets or sets whether to show column title as tooltip.

Declaration

public bool ShowColumnTitleAsTooltip { get; set; }

Property Value

ShowCriticalPathlinkLink to this section

When true, highlights the critical path — the longest chain of dependent tasks that determines the project end date. Requires Dependencies to be set.

Declaration

public bool ShowCriticalPath { get; set; }

Property Value

ShowEmptyMessagelinkLink to this section

Gets or sets whether empty message is shown.

Declaration

public bool ShowEmptyMessage { get; set; }

Property Value

ShowHeaderlinkLink to this section

Gets or sets whether header is shown.

Declaration

public bool ShowHeader { get; set; }

Property Value

ShowHistogramlinkLink to this section

When enabled, an accumulated workload histogram is displayed below the timeline, synchronized with its horizontal scroll. Each timeline column shows the total of HistogramValueProperty over the tasks active in that time unit, or the task count when no property is set.

Declaration

public bool ShowHistogram { get; set; }

Property Value

ShowMultiColumnSortingIndexlinkLink to this section

Shows multi-column sorting index. Default is false.

Declaration

public bool ShowMultiColumnSortingIndex { get; set; }

Property Value

ShowNavigationlinkLink to this section

Shows the unified Gantt navigation header.

Declaration

public bool ShowNavigation { get; set; }

Property Value

ShowTodayLinelinkLink to this section

When true, draws a vertical line on the timeline at the current date/time.

Declaration

public bool ShowTodayLine { get; set; }

Property Value

ShowUnassignedTaskslinkLink to this section

When enabled, tasks whose resource identifier is null or does not match any ResourceData item are shown in an "Unassigned" row at the bottom. The row item is a GanttUnassignedResource instance — custom ResourceColumns templates can type-check for it. Only used when ViewMode is Resource.

Declaration

public bool ShowUnassignedTasks { get; set; }

Property Value

ShowWeekendslinkLink to this section

When true, shades non-working days (Saturday and Sunday by default) on the timeline.

Declaration

public bool ShowWeekends { get; set; }

Property Value

SortlinkLink to this section

Column sort callback.

Declaration

public EventCallback<DataGridColumnSortEventArgs<TItem>> Sort { get; set; }

Property Value

StartPropertylinkLink to this section

Property name used for task start date.

Declaration

public string StartProperty { get; set; }

Property Value

StartsWithTextlinkLink to this section

Starts with text.

Declaration

public string StartsWithText { get; set; }

Property Value

TaskClicklinkLink to this section

Raised when a task bar is clicked.

Declaration

public EventCallback<TItem> TaskClick { get; set; }

Property Value

TaskMouseEnterlinkLink to this section

Raised when the mouse enters a task bar. Commonly used to show a tooltip.

Declaration

public EventCallback<GanttTaskMouseEventArgs<TItem>> TaskMouseEnter { get; set; }

Property Value

TaskMouseLeavelinkLink to this section

Raised when the mouse leaves a task bar. Commonly used to close a tooltip.

Declaration

public EventCallback<GanttTaskMouseEventArgs<TItem>> TaskMouseLeave { get; set; }

Property Value

TaskMovelinkLink to this section

Raised when a task bar is dragged to a new position on the timeline. The consumer should update the data item's start and end dates.

Declaration

public EventCallback<GanttTaskMovedEventArgs<TItem>> TaskMove { get; set; }

Property Value

TaskRenderlinkLink to this section

Callback to customize the appearance of each task bar. Set CssClass or Attributes to change colors or styles per task.

Declaration

public Action<GanttBarRenderEventArgs<TItem>> TaskRender { get; set; }

Property Value

TaskResizelinkLink to this section

Raised when a task bar edge is dragged to resize the task. The consumer should update the data item's start and/or end date.

Declaration

public EventCallback<GanttTaskMovedEventArgs<TItem>> TaskResize { get; set; }

Property Value

TaskResourceIdPropertylinkLink to this section

Property name on task items (TItem) that holds the assigned resource identifier. The value must match ResourceIdProperty values on ResourceData items.

Declaration

public string TaskResourceIdProperty { get; set; }

Property Value

TaskTemplatelinkLink to this section

Custom template for the content rendered inside each task bar. When set, replaces the default progress bar and label. Receives the task data item as context.

Declaration

public RenderFragment<TItem> TaskTemplate { get; set; }

Property Value

TextPropertylinkLink to this section

Property name used for task title (shown in the first column when no template is provided).

Declaration

public string TextProperty { get; set; }

Property Value

TodayTextlinkLink to this section

Text for the "Today" navigation button. Default is "Today".

Declaration

public string TodayText { get; set; }

Property Value

UnassignedTextlinkLink to this section

Gets or sets the display text of the unassigned tasks row. Defaults to "Unassigned".

Declaration

public string UnassignedText { get; set; }

Property Value

ViewEndlinkLink to this section

Optional explicit timeline end.

Declaration

public DateTime? ViewEnd { get; set; }

Property Value

ViewModelinkLink to this section

Gets or sets the view mode. Defaults to Task. When set to Resource, rows represent resources and task bars are grouped by their assigned resource.

Declaration

public GanttViewMode ViewMode { get; set; }

Property Value

ViewStartlinkLink to this section

Optional explicit timeline start.

Declaration

public DateTime? ViewStart { get; set; }

Property Value

VirtualizationOverscanCountlinkLink to this section

Gets or sets the virtualization overscan count.

Declaration

public int VirtualizationOverscanCount { get; set; }

Property Value

WeeksInViewlinkLink to this section

Number of weeks to render in Week view.

Declaration

public int WeeksInView { get; set; }

Property Value

YearsInViewlinkLink to this section

Number of years to render in the multi-year Years view when ViewStart and ViewEnd are not set. Default is 3.

Declaration

public int YearsInView { get; set; }

Property Value

ZoomLevellinkLink to this section

Timeline zoom.

Declaration

public GanttZoomLevel ZoomLevel { get; set; }

Property Value

ZoomToFitTextlinkLink to this section

Tooltip for the "Zoom to fit" navigation button. Default is "Zoom to fit".

Declaration

public string ZoomToFitText { get; set; }

Property Value

AddContextMenulinkLink to this section

Declaration

protected override Task AddContextMenu()

Returns

BuildRenderTreelinkLink to this section

Declaration

protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)

Parameters

CancelEditRowlinkLink to this section

Cancels edit mode for the specified item.

Declaration

public void CancelEditRow(TItem item)

Parameters

DisposelinkLink to this section

Declaration

public override void Dispose()

EditRowlinkLink to this section

Puts the specified item in edit mode.

Declaration

public Task EditRow(TItem item)

Parameters

Returns

ExpandResourceRowslinkLink to this section

Expands the specified resource rows to show their assigned tasks and child resources. Only applicable when ViewMode is Resource.

Declaration

public Task ExpandResourceRows(Collections.IEnumerable resources)

Parameters

Returns

ExpandRowslinkLink to this section

Expands a range of rows. In resource view mode the resources the items are assigned to (including their ancestors) are expanded instead.

Declaration

public Task ExpandRows(IEnumerable<TItem> items)

Parameters

Returns

GetComponentCssClasslinkLink to this section

Declaration

protected override string GetComponentCssClass()

Returns

InsertAfterRowlinkLink to this section

Inserts a new item after the specified row in edit mode.

Declaration

public Task InsertAfterRow(TItem item, TItem afterItem)

Parameters

Returns

InsertRowlinkLink to this section

Inserts a new item into the grid in edit mode.

Declaration

public Task InsertRow(TItem item)

Parameters

Returns

OnAfterRenderAsynclinkLink to this section

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

OnParametersSetlinkLink to this section

Declaration

protected override void OnParametersSet()

ReloadlinkLink to this section

Reloads the underlying grid data.

Declaration

public Task Reload()

Returns

UpdateRowlinkLink to this section

Updates the specified item and exits edit mode.

Declaration

public Task UpdateRow(TItem item)

Parameters

Returns

ZoomToFitlinkLink to this section

Auto-calculates ViewStart and ViewEnd and selects the best zoom level so that all tasks fit in the visible timeline.

Declaration

public Task ZoomToFit()

Returns