Class GanttSortSettings

Configures the sort settings of the Gantt.

Inheritance

object

ComponentBase

GanttSortSettings

Implements

IComponent

IHandleEvent

IHandleAfterRender

Inherited Members

ComponentBase.Assets

ComponentBase.AssignedRenderMode

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.OnAfterRender(bool)

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.OnInitialized()

ComponentBase.OnParametersSet()

ComponentBase.RendererInfo

ComponentBase.SetParametersAsync(ParameterView)

ComponentBase.ShouldRender()

ComponentBase.StateHasChanged()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.Gantt

Assembly: Syncfusion.Blazor.dll

Syntax

public class GanttSortSettings : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender

Constructors

GanttSortSettings()

Declaration

public GanttSortSettings()

Properties

AllowUnsort

Gets or sets a value indicating whether sort the gantt by clicking on the sorted column header.

Declaration

[Parameter]
public bool AllowUnsort { get; set; }

Property Value

Type	Description
bool	A boolean value that is set to true by default, which means the user can sort the Gantt in any order by clicking on the sorted column header.

Remarks

Set this property to false to prevent the user from getting the Gantt in an unsorted state by clicking on the sorted column header.

Columns

Gets or sets the columns to sort at the initial rendering of the Gantt control and allows the user to get the currently sorted columns.

Declaration

[Parameter]
public List<GanttSortDescriptor> Columns { get; set; }

Property Value

Type	Description
List<GanttSortDescriptor>	A list of GanttSortDescriptor objects that defines the columns to sort at the initial rendering of the Gantt control.

Remarks

To specify columns for initial sorting, create one or more GanttSortDescriptor objects and add them to the Columns list. The sort order of the columns is determined by the order in which they are added to the list. To get the currently sorted columns, retrieve the Columns list and examine the properties of the GanttSortDescriptor objects it contains.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

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

ComponentBase.OnInitializedAsync()

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

ComponentBase.OnParametersSetAsync()

UpdateChildProperties(string, object)

Updates the specified property of the component with the given value. Currently supports updating the Columns property.

Declaration

public void UpdateChildProperties(string key, object value)

Parameters

Type	Name	Description
string	key	The name of the property to update.
object	value	The value to assign to the property.

Implements

IComponent

IHandleEvent

IHandleAfterRender