Class TelerikGantt<TItem>

The class for the Telerik Gantt component.

Inheritance
System.Object
BaseComponent
TelerikGantt<TItem>
Inherited Members
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll

Syntax

public class TelerikGantt<TItem> : BaseComponent, IDisposable, IGanttViewContainer, IColumnContainer, IGanttDependencyContainer, IGanttState<TItem>, IPopupEditSettingsContainer
Type Parameters
TItem

Constructors

TelerikGantt()

Declaration
public TelerikGantt()

Properties

AutoGenerateColumns

Declaration
public bool AutoGenerateColumns { get; }
Property Value
System.Boolean

ColumnReorderable

Defines whether the columns of the TreeList can be reordered.

Declaration
public bool ColumnReorderable { get; set; }
Property Value
System.Boolean

ColumnResizable

Defines whether the columns of the TreeList can be resized.

Declaration
public bool ColumnResizable { get; set; }
Property Value
System.Boolean

ConvertedTreeListEditMode

Declaration
protected TreeListEditMode ConvertedTreeListEditMode { get; }
Property Value
TreeListEditMode

Data

Defines the data source of the Gantt.

Declaration
public IEnumerable<TItem> Data { get; set; }
Property Value
System.Collections.Generic.IEnumerable<TItem>

DependenciesSettings

Declaration
public GanttDependencies DependenciesSettings { get; set; }
Property Value
GanttDependencies

DependencyElements

Declaration
public List<DependencyElement> DependencyElements { get; set; }
Property Value
System.Collections.Generic.List<Telerik.Blazor.Components.Gantt.Models.DependencyElement>

EnableLoaderContainer

Defines if a loading indicator displays in the TreeList during long-running operations. The default value is true. The setting has no effect on initial data load.

Declaration
public bool EnableLoaderContainer { get; set; }
Property Value
System.Boolean

EndField

Defines the EndField of the Data. Default value: "End".

Declaration
public string EndField { get; set; }
Property Value
System.String

FilterMenuType

Defines the filter menu type when "FilterMode" is set to "FilterMenu".

Declaration
public FilterMenuType FilterMenuType { get; set; }
Property Value
Telerik.Blazor.FilterMenuType

FilterMode

Defines the Filter Mode of the Component.

Declaration
public GanttFilterMode FilterMode { get; set; }
Property Value
GanttFilterMode

FilterRowDebounceDelay

Time in ms between the last typed symbol and the firing of the internal filter oninput event. Default is 150ms.

Declaration
public int FilterRowDebounceDelay { get; set; }
Property Value
System.Int32

GanttSettings

Defines the container for the Gantt Settings such as GanttPopupEditSettings.

Declaration
public RenderFragment GanttSettings { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

GanttViews

Defines the container for the Gantt views.

Declaration
public RenderFragment GanttViews { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

HasChildrenField

Defines the HasChildren DataField of the DataSource.

Declaration
public string HasChildrenField { get; set; }
Property Value
System.String

Height

Defines the height of the Gantt.

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

IdField

Defines the Id DataField of the DataSource.

Declaration
public string IdField { get; set; }
Property Value
System.String

ItemsField

Defines the Items DataField of the DataSource that contains the child nodes.

Declaration
public string ItemsField { get; set; }
Property Value
System.String

Navigable

Defines whether the Component is navigable using the keyboard.

Declaration
public bool Navigable { get; set; }
Property Value
System.Boolean

OnAdd

Fires when an item is about to be inserted.

Declaration
public EventCallback<GanttAddEventArgs> OnAdd { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GanttAddEventArgs>

OnCollapse

Fires when a row is collapsed.

Declaration
public EventCallback<GanttCollapseEventArgs> OnCollapse { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GanttCollapseEventArgs>

OnCreate

Fires when an item is created.

Declaration
public EventCallback<GanttCreateEventArgs> OnCreate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GanttCreateEventArgs>

OnDelete

Fires when a task is deleted.

Declaration
public EventCallback<GanttDeleteEventArgs> OnDelete { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GanttDeleteEventArgs>

OnEdit

Fires when an item is about to be edited.

Declaration
public EventCallback<GanttEditEventArgs> OnEdit { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GanttEditEventArgs>

OnExpand

Fires when a row is expanded.

Declaration
public EventCallback<GanttExpandEventArgs> OnExpand { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GanttExpandEventArgs>

OnStateChanged

Fires on user interaction that causes changes in the GanttState<TItem>.

Declaration
public EventCallback<GanttStateEventArgs<TItem>> OnStateChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GanttStateEventArgs<TItem>>

OnStateInit

Invoked when the Gantt is initializing for the first time and before its initial render. Hook to this event if you would like to provide an initial state through the State field of its event arguments.

Declaration
public EventCallback<GanttStateEventArgs<TItem>> OnStateInit { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GanttStateEventArgs<TItem>>

OnUpdate

Fires when the Update command is executed.

Declaration
public EventCallback<GanttUpdateEventArgs> OnUpdate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GanttUpdateEventArgs>

ParentIdField

Defines the ParentId DataField of the DataSource.

Declaration
public string ParentIdField { get; set; }
Property Value
System.String

PercentCompleteField

Defines the PercentCompleteField of the Data. Default value: "PercentComplete".

Declaration
public string PercentCompleteField { get; set; }
Property Value
System.String

RangeSnapTo

Determines what the Gantt range calculation is based on.

Declaration
public GanttRangeSnapTo RangeSnapTo { get; set; }
Property Value
GanttRangeSnapTo

RowHeight

Defines the height of each row in the Gantt. Accepts a number and is applied as pixels.

Declaration
public Decimal RowHeight { get; set; }
Property Value
System.Decimal

SelectedView

Declaration
public IGanttView SelectedView { get; }
Property Value
Telerik.Blazor.Components.Gantt.IGanttView

ShowColumnMenu

Specifies if header cells will render a button to display a column menu. Use ShowColumnMenu to disable the menu at column level.

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

ShowTooltip

Defines whether a task tooltip is visible for the tasks in the Timeline.

Declaration
public bool ShowTooltip { get; set; }
Property Value
System.Boolean

Sortable

Defines whether the Component is sortable.

Declaration
public bool Sortable { get; set; }
Property Value
System.Boolean

SortMode

Defines the sort mode.

Declaration
public SortMode SortMode { get; set; }
Property Value
SortMode

StartField

Defines the StartField of the Data. Default value: "Start".

Declaration
public string StartField { get; set; }
Property Value
System.String

TaskElements

Declaration
public List<TaskElement> TaskElements { get; set; }
Property Value
System.Collections.Generic.List<Telerik.Blazor.Components.Gantt.Models.TaskElement>

TaskTemplate

Defines the Template that will be used to render items in the timeline view.

Declaration
public RenderFragment<TItem> TaskTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<TItem>

TitleField

Defines the TitleField of the Data. Default value: "Title".

Declaration
public string TitleField { get; set; }
Property Value
System.String

TooltipTemplate

Specifies the template for the content of the task tooltip. The @context of the template contains the model associated with the item.

Declaration
public RenderFragment<object> TooltipTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

TreeListEditMode

Defines the EditMode of the TreeList section. Supports None, Inline, Popup and Incell editing. The Default Option is Incell.

Declaration
public GanttTreeListEditMode TreeListEditMode { get; set; }
Property Value
GanttTreeListEditMode

TreeListFilterMode

Declaration
protected TreeListFilterMode TreeListFilterMode { get; }
Property Value
TreeListFilterMode

TreeListWidth

Specifies the width of the TreeList panel in pixels or percentages.

Declaration
public string TreeListWidth { get; set; }
Property Value
System.String

TreeListWidthChanged

Triggers when TreeList width has changed.

Declaration
public EventCallback<string> TreeListWidthChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<System.String>

View

The currently selected view of the Gantt. Determines the layout of the timeline view.

Declaration
public GanttView View { get; set; }
Property Value
GanttView

ViewChanged

The handler that will be called when the currently selected view is changed.

Declaration
public EventCallback<GanttView> ViewChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GanttView>

Width

Defines the width of the Gantt.

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

Methods

BuildRenderTree(RenderTreeBuilder)

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

Dispose()

Declaration
public override void Dispose()
Overrides

GetState()

Gets the current state of the Gantt. Includes sorting, filtering, edit items, column state, etc.

Declaration
public GanttState<TItem> GetState()
Returns
GanttState<TItem>

Instance of a GanttState<TItem> class that contains all data.

GetWidgetOptions()

Declaration
protected virtual Dictionary<string, object> GetWidgetOptions()
Returns
System.Collections.Generic.Dictionary<System.String, System.Object>

NavigateToTreeList(TaskElement)

Declaration
protected Task NavigateToTreeList(TaskElement item)
Parameters
Telerik.Blazor.Components.Gantt.Models.TaskElement item

Returns
System.Threading.Tasks.Task

NavigateToView(GanttView)

Declaration
protected void NavigateToView(GanttView view)
Parameters
GanttView view

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
System.Boolean firstRender

Returns
System.Threading.Tasks.Task

Overrides

Rebind()

Processes the available data with applied all data operations. Useful in scenarios where the data might change from an outside source.

Declaration
public void Rebind()

RefreshTimeLine()

Declaration
protected void RefreshTimeLine()

RefreshTreeList()

Declaration
protected void RefreshTreeList()

SetStateAsync(GanttState<TItem>)

Sets the state of the Gantt. Includes sorting, filtering, edit items, column state, etc.

Declaration
public Task SetStateAsync(GanttState<TItem> state)
Parameters
GanttState<TItem> state

Returns
System.Threading.Tasks.Task