TCalendar class

In unit Calendar

TCalendar allows selection of a date from a calendar display.

Declaration

pascal

TCalendar = class(TCustomCalendar)

Inheritance

Descends from it: TDBCalendar

Description

TCalendar is a TCustomCalendar descendant which implements the graphic control used to select a date value from from the familiar monthly calendar layout. It includes Date and DateTime properties with the selected date as a String or a TDateTime value.

TCalendar / TCustomCalendar act as a wrapper for the native calendar control on a given platform. The range of dates allowed in a native calendar control varies by platform. Starting in LCL version 3.0, TCustomCalendar includes MinDate and MaxDate properties which can used to limit the dates displayed on the calendar to a specified minimum and maximum date. Setting Date or DateTime to a value outside the allowed range (when used) causes an EInvalidDate exception to be raised.

Please note that MinDate and MaxDate are not supported on all platforms; they are not implemented for GTK2 and GTK3 because the native calendar control does not implement or enforce them.

DisplaySettings can be used to control the visual layout and behavior for the calendar. This includes the first day of the week for the calendar layout as well as use of headings, days names, and week numbers.

Use the OnChange, OnDayChanged, OnMonthChanged, and OnYearChanged event handlers to perform actions needed when the date or its component values have been modified on the calendar control.

Changes made to properties in the control are applied to the widgetset class instance (the native calendar control) when its handle has been allocated.

Properties

`Align`	published	Specifies the placement of the control on its Parent control.
`Anchors`	published	The set of anchor definitions for this control.
`AutoSize`	published	Allows automatic adjustment of the size for the control, according to its content.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DateTime`	published	Native data type used for a date value on the calendar control.
`DisplaySettings`	published	DisplaySettings contains options which control the appearance or behavior for the calendar control.
`DoubleBuffered`	published	When enabled, it reduces flicker when the control is painted.
`FirstDayOfWeek`	published	Indicates the day of the week displayed as the first column in the calendar grid.
`Hint`	published	The text to show in the Hint window for the control.
`MinDate`	published	Smallest date value that can entered or selected using the calendar control.
`MaxDate`	published	Largest date value that can entered or selected using the calendar control.
`ParentDoubleBuffered`	published	Value for the DoubleBuffered property in a Parent control.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`ShowHint`	published	Enables Hint display for the control.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TabStop`	published	Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Events

`OnChange`	published	Event handler signalled when the calendar control has been changed.
`OnChangeBounds`	published	Event handler signalled when the Bounds for the control have been changed.
`OnClick`	published	Notification handler for mouse clicks.
`OnDayChanged`	published	Event handler signalled when the day number in DateTime has been changed using the calendar control.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnKeyDown`	published	Event handler signalled for key down keyboard events.
`OnKeyPress`	published	Event handler signalled for character data entered by the user.
`OnKeyUp`	published	Event handler signalled when a key up event has occurred for the control.
`OnMonthChanged`	published	Event handler signalled when the month number in DateTime has been changed using the calendar control.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnMouseWheelHorz`	published	Event handler signalled for a horizontal movement of the mouse wheel.
`OnMouseWheelLeft`	published	Event handler signalled for a leftward movement of the mouse wheel.
`OnMouseWheelRight`	published	Event handler signalled for a rightward movement of the mouse wheel.
`OnResize`	published	Notification handler for a resize of the control.
`OnUTF8KeyPress`	published	Handler for a character entered by the user.
`OnYearChanged`	published	Event handler signalled when the year number in DateTime has been changed using the calendar control.