TCustomCalendar class

In unit Calendar

Implements the base class for TCalendar.

Declaration

pascal

TCustomCalendar = class(TWinControl)

Inheritance

Descends from it: TCalendar

Description

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

TCustomCalendar acts 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

`Date`	public	String representation for the date value on the calendar control.
`DateTime`	public	Native data type used for a date value on the calendar control.
`DisplaySettings`	public	DisplaySettings contains options which control the appearance or behavior for the calendar control.
`FirstDayOfWeek`	public	Indicates the day of the week displayed as the first column in the calendar grid.
`MaxDate`	public	Largest date value that can entered or selected using the calendar control.
`MinDate`	public	Smallest date value that can entered or selected using the calendar control.

Methods

`WSRegisterClass`	protected	Registers this component class with the current WidgetSet.
`LMChanged`	protected	Handles the LCL LM_CHANGED message received when the calendar control is updated.
`LMMonthChanged`	protected	Handles the LCL LM_MONTHCHANGED message received when the month has been changed using the calendar control.
`LMYearChanged`	protected	Handles the LCL LM_YEARCHANGED message received when the year number has been changed on the calendar control.
`LMDayChanged`	protected	Handles the LCL LM_DAYCHANGED message received when the day number has been changed on the calendar control.
`GetControlClassDefaultSize`	protected	Gets the default dimensions for a new instance of the control.
`Loaded`	protected	Performs actions when the component has finished loading during LCL component streaming.
`InitializeWnd`	protected	Copies cached control properties to the newly created widget.
`DestroyWnd`	protected	Destroys the interface object (widget).
`Create`	public	Constructor for the class instance.
`HitTest`	public	Indicates where a mouse click occurred in the calendar control.
`GetCalendarView`	public	Gets the current view for the Calendar.

Events

`OnChange`	public	Event handler signalled when the calendar control has been changed.
`OnDayChanged`	public	Event handler signalled when the day number in DateTime has been changed using the calendar control.
`OnMonthChanged`	public	Event handler signalled when the month number in DateTime has been changed using the calendar control.
`OnYearChanged`	public	Event handler signalled when the year number in DateTime has been changed using the calendar control.