Skip to main content
All docs
V25.1
  • DxTreeListDataColumn.EditSettings Property

    Allows you to customize the editor associated with this column.

    Namespace: DevExpress.Blazor

    Assembly: DevExpress.Blazor.v25.1.dll

    NuGet Package: DevExpress.Blazor

    Declaration

    [Parameter]
    public RenderFragment EditSettings { get; set; }

    Property Value

    Type Description
    RenderFragment

    Cell editor settings.

    Remarks

    The TreeList component generates and configures cell editors for columns based on associated data types. The component automatically displays column editors in the filter row and in data rows during edit operations. You can also place these editors in the edit form or pop-up edit form.

    Blazor TreeList Filter Row

    Declare an object that contains editor settings in the <EditSettings> tag. This is how you can customize the default editor or replace it with another editor. If the editor does not support the associated data type, the TreeList replaces it with a read-only text box.

    The table below list classes that define cell editor settings and the corresponding data types:

    Editor Settings

    Generated for Data Types

    Supported Data Types

    DxCheckBoxSettings[1]

    Boolean

    All data types

    DxComboBoxSettings

    Enum

    All data types

    DxDateEditSettings

    DateOnly, DateTime, DateTimeOffset

    DateOnly, DateTime, DateTimeOffset

    DxMaskedInputSettings

    Never generated

    Numeric, String, TimeSpan, TimeOnly,
    DateTime, DateOnly, DateTimeOffset

    DxMemoSettings

    Never generated

    String

    DxSpinEditSettings

    Numeric

    Numeric

    DxTextBoxSettings

    String

    String

    DxTimeEditSettings

    TimeOnly

    TimeOnly, TimeSpan, DateTime

    Handle the TreeList’s CustomizeFilterRowEditor event to customize editors in the filter row. The CustomizeDataRowEditor event allows you to customize editors displayed in data rows, edit forms, or pop-up edit forms. At runtime, call the GetColumnEditSettings<T>(String) to access and customize editor settings.

    In the following code snippet, the Task column’s markup contains the DxTextBoxSettings object that customizes the automatically generated editor.

    @inject EmployeeTaskService EmployeeTaskService
    
    <DxTreeList Data="TreeListData" KeyFieldName="Id" ParentKeyFieldName="ParentId" ShowFilterRow="true">
        <Columns>
            <DxTreeListDataColumn FieldName="Name" Caption="Task" Width="40%">
                <EditSettings>
                    <DxTextBoxSettings NullText="Type a search string"
                                       ClearButtonDisplayMode="DataEditorClearButtonDisplayMode.Never" />
                </EditSettings>
            </DxTreeListDataColumn>
            <DxTreeListDataColumn FieldName="EmployeeName"  />
            <DxTreeListDataColumn FieldName="StartDate" />
            <DxTreeListDataColumn FieldName="DueDate" />
        </Columns>
    </DxTreeList>
    
    @code {
        List<EmployeeTask> TreeListData { get; set; }
    
        protected override void OnInitialized() {
            TreeListData = EmployeeTaskService.GenerateData();
        }
    }
    

    Modified Editors

    Footnotes
    1. The TreeList replaces a checkbox editor with a combo box in the filter row.

    See Also