Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridEditSettings

    Show / Hide Table of Contents

    Class GridEditSettings

    Configures grid edit settings.

    Inheritance
    System.Object
    GridEditSettings
    Namespace: Syncfusion.Blazor.Grids
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class GridEditSettings : OwningComponentBase

    Constructors

    GridEditSettings()

    Declaration
    public GridEditSettings()

    Properties

    AllowAdding

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

    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 Grid.

    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, Grid will not allow editing of a record on double click.

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

    AllowNextRowEdit

    If allowNextRowEdit is set to true, editing is done to next row. By default allowNextRowEdit is set to false.

    Declaration
    public bool AllowNextRowEdit { 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 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 grid.

    Mode

    Defines the mode to edit. The available editing modes are:

    • NormalDefault. Editing is done in an inline form. Edit form is rendered inline as one of the table rows.
    • DialogEditing is done in a Dialog/Pop component.
    • BatchEnables cell editing. Multiple cells can be edited, added or deleted and saved.
    Declaration
    public EditMode Mode { get; set; }
    Property Value
    Type Description
    EditMode

    NewRowPosition

    Defines the position of adding a new row. The available position are:

    • TopDefault. Add form is placed at the first row of the grid.
    • BottomAdd form is placed at the last row of the grid
    Declaration
    public NewRowPosition NewRowPosition { get; set; }
    Property Value
    Type Description
    NewRowPosition

    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 content and edit elements for the edit dialog.

    Declaration
    public RenderFragment<object> Template { 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 grid.

    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()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved