Class GanttSelectionSettings

Configures Gantt Selection settings collection.

Inheritance

System.Object

GanttSelectionSettings

Namespace: Syncfusion.Blazor.Gantt

Assembly: Syncfusion.Blazor.dll

Syntax

public class GanttSelectionSettings : ComponentBase

Constructors

GanttSelectionSettings()

Declaration

public GanttSelectionSettings()

Properties

AllowDragSelection

Gets or sets whether to enable selection of multiple rows and cells by dragging mouse.

Declaration

public bool AllowDragSelection { get; set; }

Property Value

Type	Description
System.Boolean	true if the row and cell selection enabled when dragging mouse. Otherwise, false. The default value is false.

Remarks

To perform drag selection in grid part of Blazor Gantt, set Type as Multiple.

Examples

In the below code example, enabled AllowDragSelection property

<SfGantt @ref="Gantt">
    <GanttSelectionSettings AllowDragSelection = "true" Type="Syncfusion.Blazor.Grids.SelectionType.Multiple"></GanttSelectionSettings>
</SfGantt>

CellSelectionMode

Gets or sets the selection mode of the cell.

Declaration

public CellSelectionMode CellSelectionMode { get; set; }

Property Value

Type	Description
CellSelectionMode	The selection mode of the cell. The default value is Flow.

Remarks

Use this property to set the selection mode of the cell. The CellSelectionMode enumeration is used to set the possible values of this property. The default value of this property is CellSelectionMode.Flow.

EnableToggle

Gets or sets a value indicating whether the user can perform a toggle action on the selection row. If 'enableToggle' set to true, then the user can able to perform toggle for the selected row.

Declaration

public bool EnableToggle { get; set; }

Property Value

Type	Description
System.Boolean	If true, the user can perform a toggle action on the selected row. If false, the user cannot perform a toggle action on the selected row. The default value is false.

Remarks

When true, the user can toggle the selected row by clicking on it. The toggle action will change the selected row's state, typically visually highlighting or changing the row's appearance in some way. When false, the user cannot perform the toggle action and the selected row remains in its default state.

Mode

Gets or sets the selection mode for the Gantt chart control.

Declaration

public SelectionMode Mode { get; set; }

Property Value

Type	Description
SelectionMode	A SelectionMode value that specifies the selection mode. The default value is Row.

Remarks

This property determines how the user can select elements in the Gantt control. When the SelectionMode is set to Row, the control allows the user to select entire rows of data. When the SelectionMode is set to Cell, the control allows the user to select individual cells. When the SelectionMode is set to Both, the control allows the user to select both rows and cells.

PersistSelection

Gets or sets a value indicating whether the Gantt selection should be persisted on all operations. If 'persistSelection' set to true, then the Gantt selection is persisted on all operations.

Declaration

public bool PersistSelection { get; set; }

Property Value

Type	Description
System.Boolean	true if the Gantt selection should be persisted on all operations; otherwise, false. The default value is false.

Remarks

This property determines whether the Gantt control should keep the user's selection even if the user performs other operations on the control, such as sorting or filtering the data. When PersistSelection is set to true, the selection will be maintained even when the control is updated or refreshed. When PersistSelection is set to false, the selection will be lost when the control is updated or refreshed.

Type

Gets or sets the selection type for the component. They are Single: Allows selection of only a row or a cell. Multiple: Allows selection of multiple rows or cells.

Declaration

public SelectionType Type { get; set; }

Property Value

Type	Description
SelectionType	SingleAllows selection of only one row or one cell at a time. This is the default selection type.

Remarks

When the selection type is set to Single, the user can select only one row or one cell at a time. When the selection type is set to Multiple, the user can select multiple rows or cells at a time. The default selection type is Single.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type
System.Threading.Tasks.Task