IDateEditSettings.OutOfRangeNotificationText Property

Specifies the notification message displayed in the scroll picker mode when a user selects a date outside the permitted date range.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v23.2.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 date editor implements the MinDate and MaxDate properties that specify a range of available dates. In scroll picker mode, the editor shows a notification message each time a user tries to navigate to a date that is outside the range. The default notification text is “The selected date should be between {MinDate} and {MaxDate}“.

Use the OutOfRangeNotificationText property to customize notification text at runtime. To specify the notification text in markup, use the DxDateEditSettings.OutOfRangeNotificationText property.

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.OutOfRangeNotificationText = "Please select a date in the current month (" + DateTime.Today.ToString("MMM", CultureInfo.InvariantCulture) + ").";
      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.OutOfRangeNotificationText = "Please select a date in the current month (" + DateTime.Today.ToString("MMM", CultureInfo.InvariantCulture) + ").";
  }
  

• 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.OutOfRangeNotificationText = "Please select a date in the current month (" + DateTime.Today.ToString("MMM", CultureInfo.InvariantCulture) + ").";
  }