IDateEditSettings.WeekNumberRule Property

Specifies the first week of the year.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v23.2.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(WeekNumberRule.Default)]
[Parameter]
WeekNumberRule WeekNumberRule { get; set; }

Property Value

Type	Default	Description
WeekNumberRule	Default	An enumeration value.

Available values:

Name	Description
Default	Specified by the system’s CalendarWeekRule property.
FirstDay	The week that contains the 1st of January.
FirstFullWeek	The first full week.
FirstFourDayWeek	The first week that has a majority (4 or more) of its days in January.

Remarks

Date editor displays week numbers on the left side of the drop-down calendar. Use the WeekNumberRule property to change the first week of the year at runtime. To specify the first week of the year in markup, use the DxDateEditSettings.WeekNumberRule 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.WeekNumberRule = WeekNumberRule.FirstFullWeek;
      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.WeekNumberRule = WeekNumberRule.FirstFullWeek;
  }
  

• 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.WeekNumberRule = WeekNumberRule.FirstFullWeek;
  }