Xceed Toolkit for .NET Maui v2.0 Documentation
Xceed.Maui.Toolkit Assembly / Xceed.Maui.Toolkit Namespace / Calendar Class
Members Example


In This Topic
    Calendar Class
    In This Topic
    By default, this control displays all of the days within a specific month of a chosen year.
    Object Model
    Calendar ClassCalendarBlackoutDatesCollection ClassCalendarDateRange ClassCalendarSelectedDatesCollection Class
    Syntax
    'Usage
     
    
    Dim instance As Calendar
    Remarks

    The selected month can easily be changed with the Up & Down RepeatButtons or by clicking on the month's name, which will allow the user to choose from one of the 12 months in the year.

    There are also 5 CalendarSelectionModes which can be used for selecting dates; they allow to choose values ranging from a single date to mutiple CalendarDateRanges.

    Furthermore, single dates or CalendarDateRanges can be blacked out to make sure that they are not selected by the user. This is done via the CalendarBlackoutDatesCollection class.

    Note that when needed, the CalendarMode can be changed to display the months in a year or the years in a decade.

    Example

    The following code would display this control:

    <xctk:Calendar SelectionMode="Range"
                   SelectedDate="2024-04-29"
                   Margin="20"
                   BorderBrush="Yellow"
                   BorderThickness="2"
                   WidthRequest="260"
                   HeightRequest="300"/>
    Inheritance Hierarchy

    System.Object
       Microsoft.Maui.Controls.BindableObject
          Microsoft.Maui.Controls.Element
             Microsoft.Maui.Controls.NavigableElement
                Microsoft.Maui.Controls.VisualElement
                   Microsoft.Maui.Controls.View
                      Microsoft.Maui.Controls.Compatibility.Layout
                         Microsoft.Maui.Controls.TemplatedView
                            Xceed.Maui.Toolkit.Control
                               Xceed.Maui.Toolkit.Calendar

    Public Constructors
     NameDescription
    Public Constructor  
    Top
    Public Fields
    Protected Fields
     NameDescription
    Protected Field (Inherited from Microsoft.Maui.Controls.View)
    Top
    Public Properties
     NameDescription
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyGets or sets the Brush that will be used to paint the Control's background. (Inherited from Xceed.Maui.Toolkit.Control)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public PropertyGets the CalendarBlackoutDatesCollection.  
    Public PropertyGets or sets the Brush that will be used to paint the Control's Border. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyGets or sets the thickness of this Control's Border. (Inherited from Xceed.Maui.Toolkit.Control)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyGets or sets the Style that will be used by the CalendarButtons.  
    Public PropertyGets or sets the Style that will be used by the CalendarDayButtons.  
    Public PropertyGets or sets the Style that will be used by the Button acting as a header in the Calendar.  
    Public PropertyGets or sets the Style that will be used by the RepeatButton allowing to navigate to the next month, year or decade.  
    Public PropertyGets or sets the Style that will be used by the RepeatButton allowing to navigate to the previous month, year or decade.  
    Public Property (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public Property (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public Property (Inherited from Microsoft.Maui.Controls.Element)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Public PropertyGets or sets the radius for the 4 corners of this Control.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public PropertyGets or sets the date that is currently displayed on the Calendar.  
    Public PropertyGets or sets the CalendarMode.  
    Public Property (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyGets or sets the day of the week which will be used as the first day in every row of the Calendar.  
    Public PropertyGets or sets the first date that will appear in the Calendar.  
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyGets or sets the FontAttributes that will be applied to the Control's textual Content.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyGets or sets the font family that will be used to display the Control's textual Content.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyGets or sets the font size that will determine the scale of the Control's textual Content.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.View)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyGets or sets how the Control's Content is aligned horizontally. (Inherited from Xceed.Maui.Toolkit.Control)
    Public Property (Inherited from Microsoft.Maui.Controls.View)
    Public Property (Inherited from Microsoft.Maui.Controls.Element)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyGets or sets if the date corresponding to Today is highlighted in the Calendar.  
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyGets or sets the last date that will appear in the Calendar.  
    Public Property (Inherited from Microsoft.Maui.Controls.View)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyGets or sets if the Control's VisualStates are overridden or not. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyGets or sets the amount of padding added around the Control.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public Property (Inherited from Microsoft.Maui.Controls.Element)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyGets or sets a specific date in the Calendar.  
    Public Property

    Gets the CalendarSelectectDatesCollection.

     
    Public PropertyGets or sets the CalendarSelectionMode.  
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public Property (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public Property (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyGets or sets the text's Color. (Inherited from Xceed.Maui.Toolkit.Control)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyGets or sets how the Control's Content is aligned vertically. (Inherited from Xceed.Maui.Toolkit.Control)
    Public Property (Inherited from Microsoft.Maui.Controls.View)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Property (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    Protected Properties
    Public Methods
     NameDescription
    Public Method (Inherited from Microsoft.Maui.Controls.Element)
    Public Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Method (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodOverloaded.  (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodOverloaded.  (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public Method (Inherited from Microsoft.Maui.Controls.Element)
    Public Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public Method (Inherited from Microsoft.Maui.Controls.View)
    Public Method (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public Method (Inherited from Microsoft.Maui.Controls.Element)
    Public Method (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public Method (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public Method (Inherited from Microsoft.Maui.Controls.Element)
    Public Method (Inherited from Microsoft.Maui.Controls.Element)
    Public Method (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Public Method (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public Method (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodOverloaded.  (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    Protected Methods
     NameDescription
    Protected Method (Inherited from Microsoft.Maui.Controls.BindableObject)
    Protected Method (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected Internal Method (Inherited from Microsoft.Maui.Controls.View)
    Protected Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected Internal Method (Inherited from Microsoft.Maui.Controls.View)
    Protected Method (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected Method (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected Method (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodOverridden.   
    Protected Method (Inherited from Microsoft.Maui.Controls.View)
    Protected Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodOverloaded.  (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected Method (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected Method  
    Protected Method  
    Protected Method  
    Protected Method  
    Protected Method (Inherited from Xceed.Maui.Toolkit.Control)
    Protected Method (Inherited from Xceed.Maui.Toolkit.Control)
    Protected Method (Inherited from Xceed.Maui.Toolkit.Control)
    Protected Method (Inherited from Microsoft.Maui.Controls.Element)
    Protected Method (Inherited from Microsoft.Maui.Controls.Element)
    Protected Method  
    Protected Method  
    Protected Method (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected Method (Inherited from Microsoft.Maui.Controls.Element)
    Protected Method (Inherited from Microsoft.Maui.Controls.Element)
    Protected Method (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Protected Method (Inherited from Xceed.Maui.Toolkit.Control)
    Protected Method (Inherited from Microsoft.Maui.Controls.BindableObject)
    Protected Method  
    Protected Method  
    Protected Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected Method (Inherited from Xceed.Maui.Toolkit.Control)
    Protected Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected Method (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected Method (Inherited from Microsoft.Maui.Controls.BindableObject)
    Protected Method (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Top
    Public Events
     NameDescription
    Public Event (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public Event (Inherited from Microsoft.Maui.Controls.Element)
    Public Event (Inherited from Microsoft.Maui.Controls.Element)
    Public Event (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Event (Inherited from Microsoft.Maui.Controls.Element)
    Public Event (Inherited from Microsoft.Maui.Controls.Element)
    Public EventThis event is raised when the DisplayedDate is modified.  
    Public EventThis event is raised when the DisplayMode is modified.  
    Public Event (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Event (Inherited from Microsoft.Maui.Controls.Element)
    Public Event (Inherited from Microsoft.Maui.Controls.Element)
    Public Event (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public Event (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Event (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Event (Inherited from Microsoft.Maui.Controls.Element)
    Public Event (Inherited from Microsoft.Maui.Controls.Element)
    Public Event (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public Event (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public EventThis event is raised when the SelectedDate is modified.  
    Public EventThis event is raised when the SelectionMode is modified.  
    Public Event (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Event (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public Event (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also