IComboBoxSettings.ValueFieldName Property

Specifies the name of the data source field that contains combo box values.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue("")]
[Parameter]
string ValueFieldName { get; set; }

Property Value

Type	Default	Description
String	String.Empty	A field name.

Remarks

Use the ValueFieldName property to change the field that supplies values at runtime. To specify the field name in markup, use the DxComboBoxSettings.ValueFieldName 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>("CategoryId");
  if(comboBoxSettings != null) {
      e.Grid.BeginUpdate();
      comboBoxSettings.ValueFieldName = "CategoryId";
      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.ValueFieldName = "CategoryId";
  }
  

• 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.ValueFieldName = "CategoryId";
  }