Back to Devexpress

CalendarControlBase.ShowTodayButton Property

windowsforms-devexpress-dot-xtraeditors-dot-controls-dot-calendarcontrolbase-97eed25d.md

latest2.7 KB
Original Source

CalendarControlBase.ShowTodayButton Property

Gets or sets the visibility of the Today button.

Namespace : DevExpress.XtraEditors.Controls

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

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

Property Value

TypeDefaultDescription
Booleantrue

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.

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

See Also

TodayDate

ShowTodayButton

TodayClick

PerformTodayClick()

CalendarControlBase Class

CalendarControlBase Members

DevExpress.XtraEditors.Controls Namespace