Class TreeGridEditSettings

Configures Tree Grid edit settings.

Inheritance

System.Object

TreeGridEditSettings

Namespace: Syncfusion.Blazor.TreeGrid

Assembly: Syncfusion.Blazor.dll

Syntax

public class TreeGridEditSettings : OwningComponentBase

Constructors

TreeGridEditSettings()

Declaration

public TreeGridEditSettings()

Properties

AllowAdding

Gets or sets a value indicating whether new records can be added to the TreeGrid.

Declaration

public bool AllowAdding { get; set; }

Property Value

Type	Description
System.Boolean	true if records can be added; otherwise, false.

AllowDeleting

Gets or sets a value indicating whether existing records can be deleted from the TreeGrid.

Declaration

public bool AllowDeleting { get; set; }

Property Value

Type	Description
System.Boolean	true if records can be deleted; otherwise, false.

AllowEditing

Gets or sets a value indicating whether values can be updated in the existing record.

Declaration

public bool AllowEditing { get; set; }

Property Value

Type	Description
System.Boolean	true if editing is allowed; otherwise, false.

AllowEditOnDblClick

Gets or sets a value indicating whether TreeGrid allows editing of a record on double click.

Declaration

public bool AllowEditOnDblClick { get; set; }

Property Value

Type	Description
System.Boolean	true if editing is allowed on double click; otherwise, false. The default is true.

Dialog

Gets or sets the dialog parameters to edit.

Declaration

public DialogSettings Dialog { get; set; }

Property Value

Type	Description
DialogSettings	An instance of DialogSettings representing the dialog parameters.

FooterTemplate

Gets or sets the custom footer content for the edit dialog.

Declaration

public RenderFragment<object> FooterTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>	A Microsoft.AspNetCore.Components.RenderFragment<> representing the footer template content.

Remarks

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

HeaderTemplate

Gets or sets the custom header content for the edit dialog.

Declaration

public RenderFragment<object> HeaderTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>	A Microsoft.AspNetCore.Components.RenderFragment<> representing the header template content.

Remarks

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

Mode

Gets or sets the mode to edit the TreeGrid.

Declaration

public EditMode Mode { get; set; }

Property Value

Type	Description
EditMode	One of the EditMode enumeration values that specifies the editing mode. The default is Cell.

NewRowPosition

Gets or sets the row position for new records.

Declaration

public RowPosition NewRowPosition { get; set; }

Property Value

Type	Description
RowPosition	One of the RowPosition enumeration values that defines the row position. The default is Top.

ShowConfirmDialog

Gets or sets a value indicating whether a confirm dialog is shown when batch changes are saved or discarded.

Declaration

public bool ShowConfirmDialog { get; set; }

Property Value

Type	Description
System.Boolean	true if confirm dialog is shown; otherwise, false. The default is true.

ShowDeleteConfirmDialog

Gets or sets a value indicating whether a confirm dialog shows for the delete action, allowing cancellation of the delete command.

Declaration

public bool ShowDeleteConfirmDialog { get; set; }

Property Value

Type	Description
System.Boolean	true if confirm dialog is shown for delete action; otherwise, false.

Template

Gets or sets the custom edit elements for the dialog template.

Declaration

public RenderFragment<object> Template { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>	A Microsoft.AspNetCore.Components.RenderFragment<> representing the template for custom edit elements.

Validator

Gets or sets the custom validator component for the built-in EditForm.

Declaration

public RenderFragment<object> Validator { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>	A Microsoft.AspNetCore.Components.RenderFragment<> representing the validator component.

Remarks

Use this to override built-in validation components. The parameters passed to the templates can be accessed using an implicit parameter named context. The context is of type ValidatorTemplateContext.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

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

OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.