CalendarControlBase.ShowTodayButton Property

Gets or sets the visibility of the Today button.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

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

Property Value

Type Default Description
Boolean

true

The visibility of the Today button.

Remarks

A click on the Today button assigns Today's date to the CalendarControlBase.DateTime property (and therefore the CalendarControlBase.EditValue property). A custom Today date can be specified with the CalendarControlBase.TodayDate property.

The appearance of the Today button is dependent on the calendar display mode specified by the CalendarControlBase.CalendarView property.

The following image demonstrates the CalendarControl in Vista display mode with the Today button hovered over with the mouse cursor.

CalendarControl-TodayButton-Vista

In the image below, the Today button is hovered over with the mouse cursor in the CalendarControl painted in Classic display mode.

CalendarControl-TodayButton-Classic.png

See Also