menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridEditSettings - API Reference

    Show / Hide Table of Contents

    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

    If AllowAdding is set to true, new records can be added to the TreeGrid.

    Declaration
    public bool AllowAdding { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowDeleting

    If AllowDeleting is set to true, existing record can be deleted from the TreeGrid.

    Declaration
    public bool AllowDeleting { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowEditing

    If AllowEditing is set to true, values can be updated in the existing record.

    Declaration
    public bool AllowEditing { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowEditOnDblClick

    If AllowEditOnDblClick is set to false, TreeGrid will not allow editing of a record on double click.

    Declaration
    public bool AllowEditOnDblClick { get; set; }
    Property Value
    Type Description
    System.Boolean

    Dialog

    Defines the dialog params to edit.

    Declaration
    public DialogSettings Dialog { get; set; }
    Property Value
    Type Description
    DialogSettings

    FooterTemplate

    Defines the custom footer for the edit dialog.

    Declaration
    public RenderFragment<object> FooterTemplate { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>
    Remarks

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

    HeaderTemplate

    Defines the custom header for the edit dialog.

    Declaration
    public RenderFragment<object> HeaderTemplate { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>
    Remarks

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

    Mode

    Defines the mode to edit. The available editing modes are: Cell Row Dialog Batch.

    Declaration
    public EditMode Mode { get; set; }
    Property Value
    Type Description
    EditMode

    NewRowPosition

    Defines the row position for new records. The available row positions are: Top Bottom Above Below Child.

    Declaration
    public RowPosition NewRowPosition { get; set; }
    Property Value
    Type Description
    RowPosition

    ShowConfirmDialog

    If ShowConfirmDialog is set to false, confirm dialog does not show when batch changes are saved or discarded.

    Declaration
    public bool ShowConfirmDialog { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowDeleteConfirmDialog

    If ShowDeleteConfirmDialog is set to true, confirm dialog will show delete action. You can also cancel delete command.

    Declaration
    public bool ShowDeleteConfirmDialog { get; set; }
    Property Value
    Type Description
    System.Boolean

    Template

    Defines 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>

    Validator

    Defines the custom validator component for the built-in EditForm. Use this to override built-in validation components.

    Declaration
    public RenderFragment<object> Validator { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>
    Remarks

    The parameters passed to the templates can be accessed using 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.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved