ITimeEditSettings.Format Property

Specifies the pattern used to format time editor values.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

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

Property Value

Type	Default	Description
String	null	The format pattern. If it is not set, the long time format is applied.

Remarks

At runtime, use the Format property to format the time editor value when the editor is focused, and use the DisplayFormat to format the value when the editor is unfocused. If the DisplayFormat property is not set, the Format property affects both edit and display values.

Refer to the Standard Date and Time Format Strings and Custom Date and Time Format Strings help topics for more information about supported formats.

To specify the value format in markup, use the DxTimeEditSettings.Format 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.Format="h: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.Format="h: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.Format="h:mm";
  }