Skip to main content

ITextEditSettings.NullText Property

Specifies the editor’s prompt text when the editor’s value is null.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(null)]
[Parameter]
string NullText { get; set; }

Property Value

Type Default Description
String null

The prompt text.

Remarks

When the editor’s value is null, the editor displays a prompt text. Use the NullText property to change the text at runtime. To specify the text in markup, use the DxTextEditSettings.NullText property.

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 productEditSettings = e.Grid.GetColumnEditSettings<ITextEditSettings>("ProductID");
    // or var productEditSettings = e.Grid.GetColumnEditSettings<ISpinEditSettings>("ProductID");
    if(productEditSettings != null) {
        e.Grid.BeginUpdate();
        productEditSettings.NullText="Type the ID";
        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 productEditSettings)
        // or if(e.EditSettings is ISpinEditSettings productEditSettings)
            productEditSettings.NullText="Type the ID";
    }
    
  • Handle the CustomizeDataRowEditor event to customize a cell editor in a data row.
    void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
        if(e.EditSettings is ITextEditSettings productEditSettings)
        // or if(e.EditSettings is ISpinEditSettings productEditSettings)
            productEditSettings.NullText="Type the ID";
    }
    
See Also