CalendarControlBase.HighlightTodayCellWhenSelected Property

Gets or sets how the cell that displays today date should be painted upon selection. You may choose between the 'Today cell' and 'selected cell' highlight styles.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

[DefaultValue(true)]
[DXCategory("Behavior")]
public bool HighlightTodayCellWhenSelected { get; set; }
<DefaultValue(True)>
<DXCategory("Behavior")>
Public Property HighlightTodayCellWhenSelected As Boolean

Property Value

Type Default Description
Boolean

true

true, to apply the 'today cell' appearance; otherwise, false.

Remarks

Depending on the HighlightTodayCellWhenSelected property value, you can get one of the following behaviors.

  • If this property equals true, the cell that corresponds to the current date will be painted as a 'Today cell' even upon selection. This also means the cell should not be highlighted at all if the CalendarControlBase.HighlightTodayCell property is set to DefaultBoolean.False.
  • When the HighlightTodayCellWhenSelected property is set to false, a selected Today cell will be highlighted in the same manner as any other regular selected cell. In this scenario, the 'Today cell' has its unique appearance only when not selected.
See Also