Skip to main content

ISpinEditSettings.Increment Property

Specifies the change step value for a spin editor.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(null)]
[Parameter]
object Increment { get; set; }

Property Value

Type Default Description
Object null

The change step value. The value type should match the data type of values in the corresponding column.

Remarks

The Increment property specifies the value added to/subtracted from the editor’s value each time a user does the following:

  • Clicks the increment or decrement spin button.
  • Rotates the mouse wheel while the editor is focused.
  • Press the Up Arrow or Down Arrow key while the editor is focused.

Use the Increment property to specify the change step value at runtime. To specify this value in markup, use the DxSpinEditSettings.Increment property.

The ISpinEditSettings interface allows you to get and customize settings of a spin 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 spinEditSettings = e.Grid.GetColumnEditSettings<ISpinEditSettings>("UnitPrice");
    if(spinEditSettings != null) {
        e.Grid.BeginUpdate();
        spinEditSettings.Increment="0.1M";
        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 ISpinEditSettings spinEditSettings)
            spinEditSettings.Increment="0.1M";
    }
    
  • Handle the CustomizeDataRowEditor event to customize a cell editor in a data row.
    void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
        if(e.EditSettings is ISpinEditSettings spinEditSettings)
            spinEditSettings.Increment="0.1M";
    }
    
See Also