Class QueryBuilderShowButtons

Configures the visibility of buttons within the Syncfusion.Blazor.QueryBuilder component, allowing you to show or hide buttons for managing rules and groups.

Inheritance

System.Object

QueryBuilderShowButtons

Namespace: Syncfusion.Blazor.QueryBuilder

Assembly: Syncfusion.Blazor.dll

Syntax

public class QueryBuilderShowButtons : OwningComponentBase

Remarks

This component allows for fine-grained control over the user interface by enabling or disabling specific buttons, such as those for deleting, inserting, or locking rules and groups.

Examples

The following example demonstrates how to customize the visibility of buttons in the Syncfusion.Blazor.QueryBuilder.

<SfQueryBuilder>
    <QueryBuilderShowButtons RuleDelete="false" GroupDelete="false"></QueryBuilderShowButtons>
</SfQueryBuilder>

Constructors

QueryBuilderShowButtons()

Declaration

public QueryBuilderShowButtons()

Properties

CloneGroup

Gets or sets a value indicating whether the clone button for groups is visible.

Declaration

public bool CloneGroup { get; set; }

Property Value

Type	Description
System.Boolean	`true` to show the clone button for groups; otherwise, `false`. The default value is `false`.

Remarks

This button allows users to duplicate an entire group of rules, including all nested rules and subgroups.

CloneRule

Gets or sets a value indicating whether the clone button for rules is visible.

Declaration

public bool CloneRule { get; set; }

Property Value

Type	Description
System.Boolean	`true` to show the clone button for rules; otherwise, `false`. The default value is `false`.

Remarks

This button allows users to duplicate an existing rule, making it easier to create similar rules.

GroupDelete

Gets or sets a value indicating whether the delete button for groups is visible.

Declaration

public bool GroupDelete { get; set; }

Property Value

Type	Description
System.Boolean	`true` to show the delete button for groups; otherwise, `false`. The default value is `true`.

Remarks

When set to false, the delete button for all groups in the Query Builder will be hidden, preventing users from deleting groups.

GroupInsert

Gets or sets a value indicating whether the insert button for groups is visible.

Declaration

public bool GroupInsert { get; set; }

Property Value

Type	Description
System.Boolean	`true` to show the insert button for groups; otherwise, `false`. The default value is `true`.

Remarks

When set to false, the button for inserting new groups is hidden, preventing users from adding new groups.

LockGroup

Gets or sets a value indicating whether the lock button for groups is visible.

Declaration

public bool LockGroup { get; set; }

Property Value

Type	Description
System.Boolean	`true` to show the lock button for groups; otherwise, `false`. The default value is `false`.

Remarks

This button allows users to lock entire groups of rules, preventing any changes to a group and its nested rules.

LockRule

Gets or sets a value indicating whether the lock button for rules is visible.

Declaration

public bool LockRule { get; set; }

Property Value

Type	Description
System.Boolean	`true` to show the lock button for rules; otherwise, `false`. The default value is `false`.

Remarks

This button allows users to lock individual rules, preventing any modifications.

RuleDelete

Gets or sets a value indicating whether the delete button for rules is visible.

Declaration

public bool RuleDelete { get; set; }

Property Value

Type	Description
System.Boolean	`true` to show the delete button for rules; otherwise, `false`. The default value is `true`.

Remarks

When set to false, the delete button for all rules is hidden, preventing users from removing rules.

Methods

Dispose(Boolean)

Releases the unmanaged resources used by the component and optionally releases the managed resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	`true` to release both managed and unmanaged resources; `false` to release only unmanaged resources.

OnInitializedAsync()

Initializes the component and updates the parent Syncfusion.Blazor.QueryBuilder with the specified button visibility settings.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task that represents the asynchronous initialization process.