[Properties (by Name)] [Methods (by Name)] [Events (by Name)]
Implements a control with an edit box for a date value, with an attached speed button to display a date selection (calendar) dialog.
Source position: editbtn.pas line 574
type TDateEdit = class(TCustomEditButton) |
||
protected |
||
class procedure WSRegisterClass; override; |
|
Registers the class reference used to create new instances of the class. |
function GetDefaultGlyphName; override; |
|
Gets the default glyph name displayed on the Button for the control. |
procedure ButtonClick; override; |
|
Implements the handler executed when the Button for the control is clicked. |
procedure EditDblClick; override; |
|
Performs actions needed when the Edit in the control is double clicked. |
procedure EditEditingDone; override; |
|
Implement the OnEditingDone event handler for the Edit in the control. |
procedure SetDirectInput(); override; |
|
Sets the value in the DirectInput property. |
procedure RealSetText(); override; |
|
Sets the value for the control. |
procedure SetDateMask; virtual; |
|
Applies a mask to the Edit control suitable for the DateOrder in the control. |
procedure Loaded; override; |
|
Performs actions needed when the component has finished loading in the LCL streaming mechanism. |
public |
||
constructor Create(); override; |
|
Create - constructor for TDateEdit: calls inherited Create and sets defaults. |
function GetDateFormat; |
|
GetDateFormat - returns the format for the date. |
property AutoSelected: Boolean; |
|
Indicates if the current text selection was performed automatically. |
property Date: TDateTime; [rw] |
|
Contains the TDateTime value for the control. |
property Button: TSpeedButton; |
|
Button is the TSpeedButton that is attached to the grouped edit control. |
property DroppedDown: Boolean; [r] |
|
Indicates the dialog for control is visible when True. |
published |
||
property CalendarDisplaySettings: TDisplaySettings; [rw] |
|
CalendarDisplaySettings - governs how the calendar dialog is displayed. |
property OnAcceptDate: TAcceptDateEvent; [rw] |
|
OnAcceptDate - event handler for accepting the date selected in the calendar dialog. |
property OnCustomDate: TCustomDateEvent; [rw] |
|
OnCustomDate - event handler for inserting a custom date. |
property ReadOnly: Boolean; |
|
Indicates if the value for the control can be changed. |
property DefaultToday: Boolean; [rw] |
|
DefaultToday - if True, the current date is offered as the default date (value is False by default). |
property DateOrder: TDateOrder; [rw] |
|
Controls the display order for Year, Month, and Day parts of the date value. |
property DateFormat: string; [rw] |
|
Specifies the editing format used for the date value in the control. |
property ButtonOnlyWhenFocused: Boolean; |
|
ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control. |
property ButtonCaption: TCaption; |
|
Contains the caption used for the Button on the grouped edit control. |
property ButtonCursor: TCursor; |
|
Cursor shape displayed when the mouse hovers over the Button in the control. |
property ButtonHint: string; |
|
ButtonHint is the hint that pops up when the mouse hovers over the button. |
property ButtonWidth: Integer; |
|
ButtonWidth is the width for the TSpeedButton used in the grouped edit control. |
property Action: TBasicAction; |
|
The Action associated with the control. |
|
Specifies the placement of the control on its Parent control. |
|
|
The set of anchor definitions for this control. |
|
property AutoSize: Boolean; |
|
Allows automatic adjustment of the size for the control, according to its content. |
property AutoSelect: Boolean; |
|
Enables auto-selection of text when focused. |
property BidiMode: TBiDiMode; |
|
Customization (of text controls) in bidirectional reading environments. |
property BorderSpacing: TControlBorderSpacing; |
|
Determines the inner and outer border spacing for this control. |
property BorderStyle: TBorderStyle; |
|
Indicates the border style displayed around the control. |
property CharCase: TEditCharCase; |
|
Controls the character case applied to values entered in the control. |
property Color: TGraphicsColor; |
|
The background color of the control. |
property Constraints: TSizeConstraints; |
|
Contains the minimum and maximum Width and Height for the control. |
property DirectInput: Boolean; |
|
Indicates if text can be entered directly into the BaseEditor control. |
|
Glyph - the small graphic image on the SpeedButton, which ought to indicate its function. |
|
property NumGlyphs: Integer; |
|
NumGlyphs - the number of available glyphs. |
property Images: TCustomImageList; |
|
Contains the Images that can be displayed on the Button for the grouped edit control. |
property ImageIndex: Integer; |
|
Ordinal position in Images for the bitmap displayed on the Button control. |
property ImageWidth: Integer; |
|
Specifies the width of the image displayed on the Button control. |
|
Allows the user to drag the control. |
|
|
Indicates if characters entered in the control value are hidden, displayed, or obscured. |
|
property Enabled: Boolean; |
|
Determines whether the control reacts on mouse or keyboard input. |
property Flat: Boolean; |
|
Flat - if True, SpeedButton appears flat rather than three-dimensional. |
property FocusOnButtonClick: Boolean; |
|
Indicates if the focus is changed to the Edit control after the Button is clicked. |
|
The font to be used for text display in this control. |
|
property Layout: TLeftRight; |
|
Controls the alignment of the edit control and its associate. |
property MaxLength: Integer; |
|
The maximum length of the value entered in Text, or 0 (zero) for unlimited length. |
property OnButtonClick: TNotifyEvent; |
|
OnButtonClick - event handler for a mouse click on the SpeedButton. |
property OnChange: TNotifyEvent; |
|
Event handler signalled when the text for the control is changed. |
property OnChangeBounds: TNotifyEvent; |
|
Event handler signalled when the Bounds of the control have been changed. |
property OnClick: TNotifyEvent; |
|
Notification handler for mouse clicks. |
property OnContextPopup: TContextPopupEvent; |
|
Invoked when a context-sensitive pop-up menu is requested. |
property OnDblClick: TNotifyEvent; |
|
Event Handler for double mouse clicks. |
property OnEditingDone: TNotifyEvent; |
|
Event handler signalled when editing is done. |
property OnEnter: TNotifyEvent; |
|
Handler for control receiving the focus. |
property OnExit: TNotifyEvent; |
|
Handler for control loosing the focus; This is a good place for checking the finished user input. |
|
Handler for keyboard key pressed. |
|
property OnKeyPress: TKeyPressEvent; |
|
Handler for a character entered by the user. |
|
Event handler signalled when a key up event has occurred for the control. |
|
property OnMouseDown: TMouseEvent; |
|
Event handler signalled when a mouse down event is handled for the control. |
property OnMouseEnter: TNotifyEvent; |
|
Event handler signalled when the mouse pointer has entered the control. |
property OnMouseLeave: TNotifyEvent; |
|
Event handler signalled when the mouse pointer has left the control. |
property OnMouseMove: TMouseMoveEvent; |
|
Event handler for mouse movement within the control. |
property OnMouseUp: TMouseEvent; |
|
Event handler signalled when a mouse up event is handled for the control. |
property OnMouseWheel: TMouseWheelEvent; |
|
Event handler for mouse wheel turned. |
property OnMouseWheelDown: TMouseWheelUpDownEvent; |
|
Event handler for downward movement of mouse wheel. |
property OnMouseWheelUp: TMouseWheelUpDownEvent; |
|
Event handler for upward movement of the mouse wheel. |
property OnResize: TNotifyEvent; |
|
Notification handler for a resize of the control. |
property OnUTF8KeyPress: TUTF8KeyPressEvent; |
|
Handler for a character entered by the user. |
property ParentBidiMode: Boolean; |
|
Indicates whether the BiDiMode settings in the Parent control are used. |
property ParentColor: Boolean; |
|
Use the Color from the Parent control, when enabled. |
property ParentFont: Boolean; |
|
If True, the Font of the control will be the same as the one from the Parent. Default is True. |
property ParentShowHint: Boolean; |
|
If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True. |
property PopupMenu: TPopupMenu; |
|
A context-sensitive menu that pops up when the right mouse button is clicked over this control. |
property ShowHint: Boolean; |
|
Enables Hint display for the control. |
property TabStop: Boolean; |
|
Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys. |
|
Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key. |
|
property Spacing: Integer; |
|
Specifies the number of pixels reserved between the Edit and Button controls when Button is visible. |
property Visible: Boolean; |
|
Allows the control, and all of its children, to be displayed or hidden. |
|
The character string associated with the control. |
|
property TextHint: string; |
|
Contains the hint text displayed for the grouped edit control. |
end; |
|
Implements a control with an edit box for a date value, with an attached speed button to display a date selection (calendar) dialog. |
|
| | ||
|
TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button. |
|
| | ||
|
Implements a grouped edit control. |
|
| | ||
|
The base class for windowed controls which paint themselves. |
|
| | ||
|
Implements a windowed control which can contain other child controls. |
|
| | ||
|
The base class for visible controls. |
|
| | ||
|
The base class for LCL components which have an associated widget. |
|
| | ||
TObject |
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 implements a Calendar dialog to select a date value when the Button is clicked. The value 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.
|
TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button. |