Class GanttTooltipSettings<TValue>

Configures Gantt Tooltip settings collection.

Inheritance
object
ComponentBase
GanttTooltipSettings<TValue>
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Gantt
Assembly: Syncfusion.Blazor.dll
Syntax
public class GanttTooltipSettings<TValue> : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender
Type Parameters
Name Description
TValue

Specifies the type of GanttTooltipSettings.

Constructors

GanttTooltipSettings()

Declaration
public GanttTooltipSettings()

Properties

BaselineTemplate

Gets or sets the template for the baseline tooltip element.

Declaration
[Parameter]
public RenderFragment<TValue> BaselineTemplate { get; set; }
Property Value
Type Description
RenderFragment<TValue>

This property gets or sets the template for the baseline tooltip element. Default value is null.
Remarks

The RenderFragment type allows you to define a template that can be used to format the baseline tooltip element. The template should accept a single parameter of type TValue and return a RenderFragment.

ConnectorLineTemplate

Gets or sets the template for the dependency line tooltip.

Declaration
[Parameter]
public RenderFragment<TValue> ConnectorLineTemplate { get; set; }
Property Value
Type Description
RenderFragment<TValue>

This property gets or sets the template for the dependency line tooltip. Default value is null.
Remarks

The RenderFragment type allows you to define a template that can be used to format the dependency line tooltip. The template should accept a single parameter of type TValue and return a RenderFragment.

EditingTemplate

Gets or sets a template that appears on tooltip while editing taskbar.

Declaration
[Parameter]
public RenderFragment<TValue> EditingTemplate { get; set; }
Property Value
Type
RenderFragment<TValue>
Remarks

The parameters passed to the templates can be accessed using implicit parameter named context. The context is of type TValue of Gantt.

Examples
<GanttTooltipSettings ShowTooltip="true" TValue="TaskData"> 
      <EditingTemplate> 
          @{ 
               <div>Start Date: @context.StartDate</div> 
           } 
       </EditingTemplate> 
   </GanttTooltipSettings>

IndicatorTemplate

Gets or sets a template that defines the appearance of the tooltip that appears when the mouse is over a Gantt indicator. GanttIndicator is passed as context to the template.

Declaration
[Parameter]
public RenderFragment<object> IndicatorTemplate { get; set; }
Property Value
Type Description
RenderFragment<object>

The template content, represented as RenderFragment . The default value is null.
Examples
<SfGantt DataSource="@TaskCollection">  
    <GanttTooltipSettings ShowTooltip="true"> 
        <IndicatorTemplate>  
            @{ 
                var indicator = context as GanttIndicator;  
                <div>
                    <img src="~/ganttindicator.png"> @indicator.Tooltip 
                </div> 
            }  
        </IndicatorTemplate>  
    </GanttTooltipSettings>  
</SfGantt>

ManualTaskbarTemplate

Gets or sets the template for the tooltip of manual taskbar elements.

Declaration
[Parameter]
public RenderFragment<TValue> ManualTaskbarTemplate { get; set; }
Property Value
Type Description
RenderFragment<TValue>

This property gets or sets the template for the tooltip of manual taskbar elements. Default value is null.
Remarks

The RenderFragment type allows you to define a template that can be used to format the tooltip of manual taskbar elements. The template should accept a single parameter of type TValue and return a RenderFragment.

ShowTooltip

Gets or sets a value indicating whether the tooltip should be shown in Gantt Chart.

Declaration
[Parameter]
public bool ShowTooltip { get; set; }
Property Value
Type Description
bool

true if need to render tooltip; otherwise, false. The default value is true.
Remarks

This property is not applicable for the timeline header cells tooltip. To control the visibility of the timeline cell tooltip, use the ShowTooltip property in GanttTimelineSettings.

Examples
    <SfGantt DataSource="@TaskCollection"> 
<GanttTooltipSettings ShowTooltip="true"></GanttTooltipSettings> 
    </SfGantt>
See Also

ShowTooltipOnEditing

Gets or sets whether to enable or disable the editing tooltip in gantt chart.

Declaration
[Parameter]
public bool ShowTooltipOnEditing { get; set; }
Property Value
Type Description
bool

true if need to render editing tooltip; otherwise, false. The default value is true.
Remarks

Displays the respective content values like start date, end date, duration, progress, etc., in editing tooltip

See Also

TaskbarTemplate

Gets or sets the template for the tooltip of taskbar elements.

Declaration
[Parameter]
public RenderFragment<TValue> TaskbarTemplate { get; set; }
Property Value
Type Description
RenderFragment<TValue>

This property gets or sets the template for the tooltip of taskbar elements. Default value is null.
Remarks

The RenderFragment type allows you to define a template that can be used to format the tooltip of taskbar elements. The template should accept a single parameter of type TValue and return a RenderFragment.

TimelineCellTemplate

Gets or sets a template that defines the appearance of the tooltip that appears when the mouse is over a timeline cell. Cell value as type string is passed as context to the template.

Declaration
[Parameter]
public RenderFragment<object> TimelineCellTemplate { get; set; }
Property Value
Type Description
RenderFragment<object>

The template element, represented as RenderFragment . The default value is null.
Examples
<SfGantt DataSource="@TaskCollection">  
    <GanttTimelineSettings ShowTooltip="true"></GanttTimelineSettings>
    <GanttTooltipSettings> 
        <TimelineCellTemplate>  
            @{ 
                var indicator = context as string;  
                <div> 
                    <img src="~/ganttheader.png"> @timelineCell  
                </div> 
            }  
        </TimelineCellTemplate> 
    </GanttTooltipSettings>  
</SfGantt>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Triggers during the initial rendering of the component.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides

OnParametersSetAsync()

Called by the framework when component parameters have been set. Executes logic that depends on the updated parameter values.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements