ITimeEditSettings.OutOfRangeNotificationText Property

Specifies the notification message displayed when a user selects a time value outside the permitted time range.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

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

Property Value

Type	Default	Description
String	null	A notification text.

Remarks

The time editor implements the MinTime and MaxTime properties that specify the range of available time values. The editor shows a notification message each time a user tries to navigate to a time value outside the range. The default notification text is “The selected time value should be between {MinTime} and {MaxTime}.“.

Use the OutOfRangeNotificationText property to customize notification text at runtime. To specify the notification text in markup, use the DxTimeEditSettings.OutOfRangeNotificationText 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.OutOfRangeNotificationText="Game time can end from 9 am to 9 pm.";
      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.OutOfRangeNotificationText="Game time can end from 9 am to 9 pm.";
  }
  

• 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.OutOfRangeNotificationText="Game time can end from 9 am to 9 pm.";
  }