TCalendarDialog class

In unit ExtDlgs

TCalendarDialog - a popup calendar dialog that allows a date to be selected and returned to the main program.

Declaration

pascal

TCalendarDialog = class(TExtCommonDialog)

Inheritance

Description

TCalendarDialog is a TExtCommonDialog descendant which implements a calendar dialog used to select a date from a TCalendar control. It provides a Date property that contains the date used when selecting a date using the Calendar control displayed in the dialog.

TCalendarDialog creates and configures a TForm instance that is displayed in the Execute method for the dialog. The form uses the Title, DialogPosition, DisplaySettings, and Date properties assigned in the class. A new TCalendar control is created for the form, and stored in the Calendar property. Methods which implement the event handlers for the calendar control are also assigned. The form instance is displayed modally, and the modal result is captured in the UserChoice property. Date is updated when a calendar date is selected while the form is active.

Properties

`Left`	public	Contains the left coordinate for the dialog.
`Top`	public	Contains the top coordinate for the dialog.
`Date`	published	The selected Date for the calendar dialog.
`DisplaySettings`	published	The user-specified settings determining the appearance of the calendar on the dialog.
`FirstDayOfWeek`	published	Indicates the day of the week used in the first column for the calendar control on the dialog.
`OKCaption`	published	Caption displayed on the OK button.
`CancelCaption`	published	Caption displayed on the Cancel button for the calendar dialog form.

Methods

`WSRegisterClass`	protected	Registers this component class with the current WidgetSet.
`GetNewDate`	protected	Gets the date value from the Calendar on the dialog form.
`CalendarDblClick`	protected	Implements the event handler signalled for a double click on the calendar control in the dialog.
`DefaultTitle`	protected	Gets the default value for the Title property used as the Caption for the calendar dialog form.
`Create`	public	Constructor for the class instance.
`Execute`	public	Creates and displays the form for the calendar dialog, and captures the results.

Events

`OnDayChanged`	published	Event handler signalled when the day number in Date has been changed.
`OnMonthChanged`	published	Event handler signalled when a month number in Date has been changed.
`OnYearChanged`	published	Event handler signalled when the year number in Date has been changed.
`OnChange`	published	Event handler signalled when the value in Date has been changed.