IDateEditSettings.ScrollPickerFormat Property

Specifies a scroll picker’s date format.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue("ddd MMM yyyy")]
[Parameter]
string ScrollPickerFormat { get; set; }

Property Value

Type	Default	Description
String	"ddd MMM yyyy"	The date format.

Remarks

When the date picker is displayed as a scroll picker, use the ScrollPickerFormat property to change a date format at runtime. To specify the scroll picker’s date format in markup, use the DxDateEditSettings.ScrollPickerFormat property.

Date editor supports the following format specifiers:

• Day format specifiers
• Month format specifiers
• Year format specifiers

The IDateEditSettings interface allows you to get and customize settings of a date 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 dateEditSettings = e.Grid.GetColumnEditSettings<IDateEditSettings>("HireDate");
  if(dateEditSettings != null) {
      e.Grid.BeginUpdate();
      dateEditSettings.ScrollPickerFormat = "yyyy MMMM d";
      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 IDateEditSettings dateEditSettings)
          dateEditSettings.ScrollPickerFormat = "yyyy MMMM d";
  }
  

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

  void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
      if(e.EditSettings is IDateEditSettings dateEditSettings)
          dateEditSettings.ScrollPickerFormat = "yyyy MMMM d";
  }