ITimeEditSettings.ScrollPickerFormat Property

Specifies the scroll picker’s time format.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[Parameter]
string ScrollPickerFormat { get; set; }

Property Value

Type	Description
String	The format pattern.

Remarks

The default scroll picker format depends on the current culture. Use the ScrollPickerFormat property to change a time format pattern at runtime. The pattern consists of format specifiers and separators that define the order and composition of visible scroll picker columns (hour, minute, second, and period of the day).

The time editor’s scroll picker supports the following time format specifiers:

• h and hh for hours
• m and mm for minutes
• s and ss for seconds
• t and tt for a day period
• A space character to delimit format specifiers

To specify the scroll picker’s format in markup, use the DxTimeEditSettings.ScrollPickerFormat property.

The ITimeEditSettings interface allows you to get and customize settings of a time 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 timeEditSettings = e.Grid.GetColumnEditSettings<ITimeEditSettings>("StartTime");
  if(timeEditSettings != null) {
      e.Grid.BeginUpdate();
      timeEditSettings.ScrollPickerFormat="tt hh mm";
      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 ITimeEditSettings timeEditSettings)
          timeEditSettings.ScrollPickerFormat="tt hh mm";
  }
  

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

  void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
      if(e.EditSettings is ITimeEditSettings timeEditSettings)
          timeEditSettings.ScrollPickerFormat="tt hh mm";
  }