CalendarProperties.ShowTodayButton Property

Gets or sets a value that specifies whether the Today button is displayed within the calendar’s footer.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v20.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue(true)]
public bool ShowTodayButton { get; set; }

VB.NET

<DefaultValue(True)>
Public Property ShowTodayButton As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true, if the button is visible, otherwise, false.

Remarks

Use the ShowTodayButton property to specify whether the Today button is visible within the calendar. The appearance of this button can be customized by using the ASPxCalendar.ButtonStyle property.

Note

The ShowTodayButton property synchronizes its value with the editor’s ASPxCalendar.ShowTodayButton property.

Example

This section of the Custom Day Rendering online demo illustrates how to customize the ASPxCalendar settings.

ASPX

...
<dxe:ASPxCalendar ID="clndWeatherForecast" runat="server" 
             OnDayRender="OnCalendarDayRender" ShowClearButton="False" 
             ShowTodayButton="False" ShowWeekNumbers="False" Font-Size="8pt" 
             Font-Names="Trebuchet MS" ForeColor="#07519A" 
             ClientInstanceName="Calendar" SkinID="None" 
             EnableViewState="False" BackColor="White">
             <ButtonStyle BackColor="#EBF3FB" Width="80px" Cursor="pointer">
                 <HoverStyle BackColor="#E2ECF8" />
                 <PressedStyle BackColor="#C4DCF4" />
                 <Border BorderWidth="1px" BorderStyle="Solid" BorderColor="#AACCEE" />
             </ButtonStyle>
             <PrevMonthImage Height="17px" Width="19px" AlternateText="Previous month" 
             Url="Images/CustomDayRendering/Elements/leftSingleArrow.png" />
             <NextMonthImage Height="17px" Width="19px" AlternateText="Next  month" 
             Url="Images/CustomDayRendering/Elements/rightSingleArrow.png" />
             <BorderRight BorderStyle="None" />
             <DayHeaderStyle Font-Size="12pt">
              <BorderBottom BorderWidth="1px" BorderStyle="Solid" BorderColor="#AACCEE" />
              <BorderRight BorderWidth="1px" BorderStyle="Solid" BorderColor="#AACCEE" />
             </DayHeaderStyle>
             <MonthGridPaddings Padding="0px" />
             <Border BorderStyle="Solid" BorderColor="#AACCEE" BorderWidth="1px" />
             <NextYearImage Height="17px" Width="19px" AlternateText="Next year" 
             Url="Images/CustomDayRendering/Elements/rightDoubleArrow.png" />
             <HeaderStyle Spacing="5px" HorizontalAlign="Center" Font-Size="16pt" 
             BackColor="#EBF3FB" ForeColor="#51A8DF">
                 <Paddings PaddingTop="3px" PaddingRight="5px" PaddingBottom="3px" 
                 PaddingLeft="5px" />
                 <BackgroundImage Repeat="RepeatX" VerticalPosition="bottom" 
                 ImageUrl="Images/CustomDayRendering/Elements/headerBg.png" />
                 <Border BorderWidth="1px" BorderStyle="Solid" BorderColor="#AACCEE" />
                 <BorderTop BorderStyle="None" />
                 <BorderLeft BorderStyle="None" />
             </HeaderStyle>
             <FastNavFooterStyle Spacing="5px" HorizontalAlign="Center" BackColor="#EBF3FB">
                 <Paddings Padding="10px" />
                 <Border BorderWidth="1px" BorderStyle="Solid" BorderColor="#AACCEE" />
                 <BorderTop BorderStyle="None" />
             </FastNavFooterStyle>
             <FastNavMonthStyle Font-Italic="False" Cursor="pointer">
                 <Paddings PaddingTop="5px" PaddingRight="2px" PaddingBottom="5px" 
                 PaddingLeft="2px" />
                 <HoverStyle BackColor="#E2ECF8">
                     <Border BorderWidth="1px" BorderStyle="Solid" BorderColor="#AACCEE" />
                 </HoverStyle>
                 <SelectedStyle BackColor="#C4DCF4" />
             </FastNavMonthStyle>
             <DayOtherMonthStyle ForeColor="#C9DEF4">
             <BackgroundImage ImageUrl="Images/CustomDayRendering/Elements/otherMonthDayBg.png" />
             </DayOtherMonthStyle>
             <PrevYearImage Height="17px" Width="19px" AlternateText="Previous year" 
             Url="Images/CustomDayRendering/Elements/leftDoubleArrow.png" />
             <DayStyle VerticalAlign="Top" Cursor="default">
                 <Paddings Padding="3px" />
                 <Border BorderWidth="1px" BorderStyle="Solid" BorderColor="#AACCEE" />
                 <BorderTop BorderStyle="None" />
                 <BorderLeft BorderStyle="None" />
             </DayStyle>
             <FastNavPrevYearImage Height="17px" Width="19px" AlternateText="Previous year" 
             Url="Images/CustomDayRendering/Elements/leftSingleArrow.png" />
             <FastNavYearStyle Cursor="pointer">
                 <Paddings PaddingTop="2px" Padding="4px" />
                 <HoverStyle BackColor="#E2ECF8">
                     <Border BorderWidth="1px" BorderStyle="Solid" BorderColor="#AACCEE" />
                 </HoverStyle>
                 <SelectedStyle BackColor="#C4DCF4" />
             </FastNavYearStyle>
             <BorderBottom BorderStyle="None" />
             <FastNavNextYearImage Height="17px" Width="19px" AlternateText="Next year" 
             Url="Images/CustomDayRendering/Elements/rightSingleArrow.png" />
             <DaySelectedStyle BackColor="#E2ECF8" />
             <FastNavStyle MonthYearSpacing="8px" HorizontalAlign="Center" VerticalAlign="Top" 
              Font-Size="12pt" Font-Bold="False" 
                 BackColor="#EBF3FB" ImageSpacing="12px">
                 <Paddings Padding="10px" />
                 <Border BorderWidth="1px" BorderStyle="Solid" BorderColor="#AACCEE" />
             </FastNavStyle>
         </dxe:ASPxCalendar>
...

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowTodayButton property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

mvc-responsive-web-application/CS/MvcResponsiveWebApplication/Models/Scheduler/SchedulerHelper.cs#L85

settings.DateNavigatorExtensionSettings.Width = Unit.Percentage(100);
settings.DateNavigatorExtensionSettings.Properties.ShowTodayButton = true;
settings.DateNavigatorExtensionSettings.Properties.EnableChangeVisibleDateGestures = DevExpress.Utils.DefaultBoolean.True;