TDateEdit class

In unit EditBtn

Implements a control with an edit box for a date value and an attached speed button to display a date selection (calendar) dialog.

Declaration

pascal

TDateEdit = class(TCustomEditButton)

Inheritance

Descends from it: TDBDateEdit

Description

TDateEdit is a TCustomEditButton descendant which implements a grouped edit control for entering a date value. The control uses an Edit and a Button, as defined in the ancestor class, and displays a pop-up Calendar dialog to select a date value when the Button is clicked. The selected date is stored in the Date property as a TDateTime value.

TDateEdit provides additional properties which are used to configure the Edit and Button controls and the dialog executed when Button is clicked.

TDateEdit has an overridden ButtonClick method which displays the pop-up Calendar dialog. This method includes logic to set the minimum and maximum date values for the native calendar control on the dialog. For the Windows platform, the value limits are September 14, 1752 and December 31, 9999. This functionality is not supported for all platforms. Specifically, GTK2 and GTK3 do not support the minimum and maximum date values on their native calendar controls.

Properties

`AutoSelected`	public	Indicates if the current text selection was performed automatically.
`Date`	public	Contains the TDateTime value for the control.
`Button`	public	TSpeedButton instance used on the edit control.
`DroppedDown`	public	Indicates the calendar dialog for the control is visible when True.
`CalendarDisplaySettings`	published	Display or behavior options enabled in the pop-up calendar dialog for the control.
`ReadOnly`	published	Indicates whether the value for the control can be changed.
`DefaultToday`	published	True to use the current system date when a Date value is not available.
`DateOrder`	published	Controls the display order for Year, Month, and Day parts of the Date value.
`DateFormat`	published	Specifies the format string used for the date value in the control.
`MinDate`	published	Smallest date value allowed in the date edit control.
`MaxDate`	published	Largest date value allowed in the date edit control.
`ButtonOnlyWhenFocused`	published	ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control.
`ButtonCaption`	published	Contains the caption used for the Button on the edit control.
`ButtonCursor`	published	Cursor shape displayed when the mouse hovers over the Button in the control.
`ButtonHint`	published	Text displayed in the pop-up hint window when the mouse hovers over the button.
`ButtonWidth`	published	Width for the TSpeedButton on the edit control.
`Action`	published	The Action associated with the control.
`Align`	published	Specifies the placement of the control on its Parent control.
`Alignment`	published	Indicates the text alignment used for the control value.
`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.
`AutoSelect`	published	Enables auto-selection of text when focused.
`BidiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`BorderStyle`	published	Indicates the border style displayed around the control.
`CharCase`	published	Controls the character case applied to values entered in the control.
`Color`	published	The background color for the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DirectInput`	published	Indicates if text can be entered directly into the BaseEditor control.
`Glyph`	published	Glyph - the small graphic image on the SpeedButton, which ought to indicate its function.
`NumGlyphs`	published	NumGlyphs - the number of available glyphs.
`Images`	published	Contains the Images that can be displayed on the Button for the grouped edit control.
`ImageIndex`	published	Ordinal position in Images for the bitmap displayed on the Button control.
`ImageWidth`	published	Specifies the width of the image displayed on the Button control.
`DragMode`	published	Determines how a drag operation is started for the control.
`EchoMode`	published	Indicates if characters entered in the control value are hidden, displayed, or obscured.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`Flat`	published	When True, the SpeedButton has a flat appearance rather than a three-dimensional one.
`FocusOnButtonClick`	published	Indicates if the focus is changed to the Edit control after the Button is clicked.
`Font`	published	The font to be used for text display in this control.
`Layout`	published	Controls the alignment of the edit control and its associate.
`MaxLength`	published	The maximum length of the value entered in Text, or 0 (zero) for unlimited length.
`ParentBidiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`ParentColor`	published	Use the Color from the Parent control, when enabled.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`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.
`TabStop`	published	Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`Spacing`	published	Specifies the number of pixels reserved between the Edit and Button controls when Button is visible.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.
`Text`	published	String with the text or caption for the control.
`TextHint`	published	Default hint text shown when the Text property is empty for the grouped edit control.

Methods

`WSRegisterClass`	protected	Registers the class reference used to create new instances of the class.
`GetDefaultGlyphName`	protected	Gets the name of the default glyph resource used for the Button on the control.
`ButtonClick`	protected	Displays a pop-up calendar dialog when the Button for the grouped edit control is clicked.
`EditDblClick`	protected	Performs actions needed when the Edit in the control is double clicked.
`EditEditingDone`	protected	Implements the OnEditingDone event handler for the Edit in the control.
`SetDirectInput`	protected	Sets the value in the DirectInput property.
`RealSetText`	protected	Sets the value for text in the control.
`SetDateMask`	protected	Applies an EditMask based on the DateOrder for the control.
`Loaded`	protected	Performs actions needed when the component has finished loading in the LCL streaming mechanism.
`DoDateRangeCheck`	protected	Signals the OnDateRangeCheck event handler (when assigned).
`Create`	public	Constructor for the class instance.
`GetDateFormat`	public	Gets the FormatDateTime-compatible format specification used for the current DateOrder in the control.

Events

`OnAcceptDate`	published	Event handler signalled to accept or reject a new date value selected using the calendar dialog for the control.
`OnCustomDate`	published	OnCustomDate - event handler for inserting a custom date.
`OnDateRangeCheck`	published	Event handler signalled prior to validating and range checking a date value.
`OnButtonClick`	published	OnButtonClick - event handler for a mouse click on the SpeedButton.
`OnChange`	published	Event handler signalled when the text for the control is changed.
`OnChangeBounds`	published	Event handler signalled when the Bounds for the control have been changed.
`OnClick`	published	Notification handler for mouse clicks.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnEditingDone`	published	Event handler signalled when editing is completed for 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.
`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.
`OnResize`	published	Notification handler for a resize of the control.
`OnUTF8KeyPress`	published	Handler for a character entered by the user.