IComboBoxSettings.EditFormat Property

Specifies the format pattern applied to the value of the focused combo box editor.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

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

Property Value

Type	Default	Description
String	null	The format pattern.

Remarks

Use the EditFormat property to change the format the focused editor’s edit value at runtime. To specify the format in markup, use the DxComboBoxSettings.EditFormat property.

The IComboBoxSettings interface allows you to get and customize settings of a combo box editor at runtime. You can get editor settings in the following ways:

• 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 comboBoxSettings = e.Grid.GetColumnEditSettings<IComboBoxSettings>("UnitPrice");
  if(comboBoxSettings != null) {
      e.Grid.BeginUpdate();
      comboBoxSettings.EditFormat = "F";
      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 IComboBoxSettings comboBoxSettings)
          comboBoxSettings.EditFormat = "F";
  }
  

• Handle the CustomizeDataRowEditor event to customize a cell editor in a data row.

  void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
      if(e.EditSettings is IComboBoxSettings comboBoxSettings)
          comboBoxSettings.EditFormat = "F";
  }