Class GanttSearchSettings

Configures the search settings for Gantt.

Inheritance

System.Object

GanttSearchSettings

Namespace: Syncfusion.Blazor.Gantt

Assembly: Syncfusion.Blazor.dll

Syntax

public class GanttSearchSettings : ComponentBase

Constructors

GanttSearchSettings()

Declaration

public GanttSearchSettings()

Properties

Fields

Specifies the columns to be searched at initial rendering of the Gantt chart component. You can also get the columns that were currently filtered.

Declaration

public string[] Fields { get; set; }

Property Value

Type	Description
System.String[]	An array of strings representing the fields to be searched when the Gantt is initially rendered.

Remarks

Use this property to set the initial columns to be searched in the Gantt. By default, all columns are searched. The Fields property can also be used to retrieve the currently filtered columns.

HierarchyMode

Defines the search types of hierarchical data. The available options are, Parent: Shows the searched record with parent record. Child: Shows the searched record with child record. Both : shows the searched record with both parent and child record. None : Shows only searched record.

Declaration

public FilterHierarchyMode HierarchyMode { get; set; }

Property Value

Type	Description
FilterHierarchyMode	A value from the FilterHierarchyMode enum that specifies how the search should be performed on hierarchical data.

Remarks

Use this property to set the search mode for hierarchical data.

IgnoreAccent

Gets or sets a value indicating whether diacritic characters or accents are ignored while filtering.

Declaration

public bool IgnoreAccent { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false. If set to true, diacritic characters or accents will be ignored while filtering.

Remarks

If IgnoreAccent is set to true, filtering will ignore diacritic characters or accents, which means that the filter will consider two strings that differ only by diacritic characters or accents to be the same. This property is supported by remote data alone. When the IgnoreAccent property is set to true, the IgnoreAccent key will be sent to the server and the operation should be handled at the user level.

IgnoreCase

Gets or sets a value indicating whether the comparison should ignore the case of characters during filtering.

Declaration

public bool IgnoreCase { get; set; }

Property Value

Type	Description
System.Boolean	true if the comparison should be case-insensitive; otherwise, false. The default value is true.

Key

A key word for searching the Gantt chart content.

Declaration

public string Key { get; set; }

Property Value

Type	Description
System.String	A string value representing the keyword used for searching. The default value is an empty string.

Remarks

This property specifies a keyword that is used to filter the Gantt content. The search operation is case-insensitive, so it can match any part of the content. To match exact text, use the Equals operator along with this property.

Operator

Defines the operator to search records.

Declaration

public Operator Operator { get; set; }

Property Value

Type	Description
Operator	The default value for this property is 'Operator.Contains'.

Remarks

This property determines the type of search operation to be performed while filtering records. The 'Contains' operator matches records that have the search value anywhere in the specified field. Other supported operators include 'Equals', 'StartsWith' and 'EndsWith'.

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