TDBCalendar class

In unit DBCtrls

TDBCalendar - a data-aware version of TCalendar, for selecting a date to store in a database field.

Declaration

pascal

TDBCalendar = class(TCalendar)

Inheritance

Description

TDBCalendar is a TCalendar descendant which implements a data-aware calendar control used to select a date and store its value in a database field. TDBCalendar, like its ancestor, displays a calendar which can be used to navigate through years, months, and days to select the Date value for the control. When Date has been assigned, it is stored in the field identified by the name in DataField.

Use Field to access the definition and metadata for the field where the Date value is stored.

Use DataSource to assign the component with the dataset where the Date value is stored.

Use DisplaySettings to control the visual appearance and content displayed on the calendar control.

Use the OnYearChanged event to perform action required when the navigation arrows in the calendar are used to change the year in the Date value.

Internally, a TFieldDataLink class instance is used to maintain the association between the control, the datasource, and the field. In addition, support for using standard actions is provided in the ExecuteAction and UpdateAction methods.

Properties

`Field`	public	Provides access to the field definition for the data-aware control.
`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.
`DataField`	published	Contains the name of the field with the value for the control.
`DataSource`	published	Provides access to the dataset with content for the control.
`Date`	published	Date value for the control as a String type.
`ReadOnly`	published	Indicates if the control cannot modify the field in the linked dataset.
`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.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragMode`	published	Determines how a drag operation is started for the control.
`ParentDoubleBuffered`	published	Value for the DoubleBuffered property in a Parent control.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Methods

`Notification`	protected	Handles the notification when a component on the control is added or removed.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`EditingDone`	public	Performs actions needed when the user has finished editing.
`ExecuteAction`	public	Provides support for TBasicAction in the control.
`UpdateAction`	public	Updates the specified action to reflect the current state in the linked dataset.

Events

`OnClick`	published	Notification handler for mouse clicks.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnDayChanged`	published	Event handler signalled when the day number in DateTime has been changed using the calendar control.
`OnMonthChanged`	published	Event handler signalled when the month number in DateTime has been changed using the calendar control.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.
`OnYearChanged`	published	Event handler signalled when the year number in DateTime has been changed using the calendar control.