CalendarControl Xojo Plugin

DesktopCalendarControl Control

Calendar plugin control for Xojo.

This version of the control is for new style Xojo DesktopWindow class.

DesktopUIControl
   DesktopCalendarControl

control DesktopCalendarControl

Properties

AutoLocalizeUse this property to let the operating system attempt to localize the day- and month names.
BackColorUse this property to set the BackColor of the Calendar.
BrowseModeIf set to true then selection will not change when flipping month or year and extra button to jump to current selection is added when your selection is not on the on screen month or year.
CancelEventActionUse this property to cancel a events internal action.
ClickableOutOfBoundsUse this property to let to specify if out of bounds days should be clickable. If out of bounds days are clickable then a click on them will let the calendar shift to next or previous month.
DarkHeaderLinuxIf set to true then header is drawn dark on Linux systems instead of light. (Default true)
DarkHeaderWindowsIf set to true then header is drawn dark on Windows systems instead of light. (Default true)
DebugDataSizeUsed for internal quality control of the plugin.
DisabledSpecialDayColorSets or gets the color for disabled/inactive special days.
DrawFrameDMWindowsUse this property to specify if the Calendar control should be drawn with a frame around it or not on Windows platform when in dark mode. (Default false)
DrawFrameLinuxUse this property to specify if the Calendar control should be drawn with a frame around it or not on Linux platform. (Default false)
DrawFrameMacUse this property to specify if the Calendar control should be drawn with a frame around it or not on Mac platform. (Default true)
DrawFrameWindowsUse this property to specify if the Calendar control should be drawn with a frame around it or not on Windows platform when not in dark mode. (Default false)
DrawOutOfBoundsUse this property to let the calendar draw days from previous and next months onto the current month as gray shaded text.
Enabled (Inherited) Determines if the control should be enabled when the owning window is opened.
FirstDayOfWeekUse this property to specify the first day of the week.
FridayEnabledUse this property to disable the given weekday.
FridaySpecialUse this property to set the given day as special. Special week days are show as either red, with red header or both, depending on the setting defined in the SpecialWDayStyle property.
Handle (Inherited) Returns a handle to the control.
Height (Inherited) The height (in points) of the control.
HideYearArrowsUse this property to hide the year arrows.
Index (Inherited) If the control is used in a control set, this specifies the control's index in the set.
InitMaxDayUse this property to set the initial setting for the MaxDate property.
InitMaxMonthUse this property to set the initial setting for the MaxDate property.
InitMaxYearUse this property to set the initial setting for the MaxDate property.
InitMinDayUse this property to set the initial setting for the MinDate property.
InitMinMonthUse this property to set the initial setting for the MinDate property.
InitMinYearUse this property to set the initial setting for the MinDate property.
InitSelectedDayUse this property to set the initial setting for the SelectedDate property.
InitSelectedMonthUse this property to set the initial setting for the SelectedDate property.
InitSelectedYearUse this property to set the initial setting for the SelectedDate property.
Left (Inherited) The left side of the control in local coordinates (relative to the window)
MarkStyleUse this property to define how marked days should be displayed.
MarkedDaysUse this property to define Marked days. Marked days will have a red mark under the text.
MaxDateUse this property to set the minimum date.
MinDateUse this property to set the minimum date.
MondayEnabledUse this property to disable the given weekday.
MondaySpecialUse this property to set the given day as special. Special week days are show as either red, with red header or both, depending on the setting defined in the SpecialWDayStyle property.
MonthOnScreenWhen in Browsing mode this property will return the number of the month currently on the screen. This property should not be confused with which month is actually selected.
OSXDrawWeekBarsUse this property to turn off drawing week bars on OS X.
RectangularBodyLinuxIf set to true then the body of the control is fully rectangular on Linux systems instead of having rounded corners.
RectangularBodyWindowsIf set to true then the body of the control is fully rectangular on Linux systems instead of having rounded corners.
SaturdayEnabledUse this property to disable the given weekday.
SaturdaySpecialUse this property to set the given day as special. Special week days are show as either red, with red header or both, depending on the setting defined in the SpecialWDayStyle property.
SelectedDateUse this property to set the selected date.
SelectionColorSets the color for the selection when in light mode.
SelectionDMColorSets the color for the selection when in dark mode.
SizeModeSets the size of the control (Design mode only property)
SpecialDayColorSets or gets the color for special days.
SpecialDaysUse this property to define special days. Special days get drawn with red text.
SpecialWDayStyleUse this property to decide on appearance of special week days.
SundayEnabledUse this property to disable the given weekday.
SundaySpecialUse this property to set the given day as special. Special week days are show as either red, with red header or both, depending on the setting defined in the SpecialWDayStyle property.
ThursdayEnabledUse this property to disable the given weekday.
ThursdaySpecialUse this property to set the given day as special. Special week days are show as either red, with red header or both, depending on the setting defined in the SpecialWDayStyle property.
Top (Inherited) The top of the control in local coordinates (relative to the window).
TuesdayEnabledUse this property to disable the given weekday.
TuesdaySpecialUse this property to set the given day as special. Special week days are show as either red, with red header or both, depending on the setting defined in the SpecialWDayStyle property.
UseBackColorUse this property to let the calendar control use the color specified by the BackColor property as a back color.
UseSelectionColorIf set to true then Selection color will be used from the SelectionColor and SelectionDMColor properties.
UseSpecialDayColorSet this property to true to override the default color scheme for special days.
Visible (Inherited) Determines whether the control is visible when its owning window is opened. The default is True: the control is visible.
WednesdayEnabledUse this property to disable the given weekday.
WednesdaySpecialUse this property to set the given day as special. Special week days are show as either red, with red header or both, depending on the setting defined in the SpecialWDayStyle property.
Width (Inherited) The width (in points) of the control.
Window (Inherited) The control's parent window.
YearOnScreenWhen in Browsing mode this property will return the number of the year currently on the screen. This property should not be confused with which year is actually selected.

Methods

BrowseToWhen in Browse mode then this method will trigger from code browsing to a given year and month.
BrowseToSelectionWhen in Browse mode then this method will trigger from code Browsing to current selection.
Close (Inherited) Closes a control.
DayNameUse this property if you want to specify your own names for the days.
MonthNameUse this property if you want to specify your own names for the month.
ReloadEventsReloads events if having used AddHandler to subscribe events.
SetFocus (Inherited) If applicable, sets the focus to the DesktopUIControl. KeyDown events are directed to the control.

Events

Closing (Inherited) The control is about to close.
ConstructContextualMenu (Inherited) This event is called when it is appropriate to display a contextual menu for the control.
ContextualMenuItemSelected (Inherited) Fires when a contextual menuitem selectedItem was selected but the MenuItemSelected event and the MenuHandler for the DesktopMenuItem did not handle the menu selection.
DayClickedThis event will fire always when a day gets clicked with the mouse. This event is fired regardless if the day was previously selected or not.
DayDoubleClickedThis event will fire always when a day gets clicked with the mouse. This event is fired regardless if the day was previously selected or not.
DragEnter (Inherited) Fires when the passed DragItem enters the DesktopUIControl.
DragExit (Inherited) Fires when the passed DragItem exits the DesktopUIControl.
DragOver (Inherited) Fires when the DragItem is over the DesktopUIControl.
DropObject (Inherited) The item represented by Obj has been dropped on the control.
KeyDown (Inherited) The user has pressed the Key passed while the control has the focus.
KeyUp (Inherited) Fires when the passed Key is released in the control that has the focus.
MouseDownThis event is fired when the Mouse is clicked within the control.
MouseDrag (Inherited) The mouse button was pressed inside the control and moved (dragged) at the location local to the control passed in to x, y. The user has moved the mouse inside the control while the mouse button is held down. This event handler receives parameters that indicate where the mouse is in coordinates local to the control.
MouseEnter (Inherited) The mouse has entered the area of the control.
MouseExitThis event will fire when the Mouse Exists the control.
MouseMove (Inherited) The mouse has moved within the control to the coordinates passed. The coordinates are local to the control, not to the window.
MouseUp (Inherited) The mouse button was released. Use the x and y parameters to determine if the mouse button was released within the control's boundaries.
MouseWheel (Inherited) The mouse wheel has been moved.
QueryDayEnabledUse this event to customize which days are to be disabled.
SelectedChangedThis event will fire always when the selected date has changed.
YearFieldClickedThis event will fire always when the year arrows are clicked.

Constants

Version = 10.0

Supported Platforms:

  • macOS Intel 32 bit
  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 32 bit
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 32 bit
  • Linux 64 bit
  • Linux ARM 32 bit
  • Linux ARM 64 bit