Skip to main content

ITextEditSettings Interface

Declares common settings for editors with support for text input.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

public interface ITextEditSettings :
    IEditSettings

Remarks

The ITextEditSettings interface allows you to get and customize settings of editors with support for text input. You can get editor settings in the following ways. Note that you can cast settings to the base ITextEditSettings interface or to an editor-specific interface.

  • Call the GetColumnEditSettings method to get editor settings of the column bound to the specified data source field.

    Important

    You need to enclose your code between BeginUpdate and EndUpdate method calls to change values of Grid component parameters outside the Grid component markup. Otherwise, an exception occurs.

    var firstNameEditSettings = e.Grid.GetColumnEditSettings<ITextEditSettings>("FirstName");
    // or var firstNameEditSettings = e.Grid.GetColumnEditSettings<ITextBoxSettings>("FirstName");
    if(firstNameEditSettings != null) {
        e.Grid.BeginUpdate();
        firstNameEditSettings.ShowValidationIcon = true;
        e.Grid.EndUpdate();
    }
    
  • Handle the CustomizeFilterRowEditor event to customize a cell editor in the filter row.
    void Grid_CustomizeFilterRowEditor(GridCustomizeFilterRowEditorEventArgs e) {
        if(e.EditSettings is ITextEditSettings firstNameEditSettings)
        // or if(e.EditSettings is ITextBoxSettings firstNameEditSettings)
            firstNameEditSettings.ShowValidationIcon = true;
    }
    
  • Handle the CustomizeDataRowEditor event to customize a cell editor in a data row.
    void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
        if(e.EditSettings is ITextEditSettings firstNameEditSettings)
        // or if(e.EditSettings is ITextBoxSettings firstNameEditSettings)
            firstNameEditSettings.ShowValidationIcon = true;
    }
    
See Also