[Overview][Constants][Types][Classes][Procedures and functions][Index] | Reference for unit 'EditBtn' (#lcl)

# TTimeEdit

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Implements a control used to edit time values.

## Declaration

Source position: editbtn.pas line 727

`type TTimeEdit = class(TCustomEditButton)`
`protected`
`function GetDefaultGlyphName; override;` |  | Gets the name of the default glyph resource used for the Button on the control.
`function Is12HourMode;` |  | Indicates whether the effective TimeFormat for the control reflects 12-hour clock values with AM and PM designations.
`function UsedFormatSettings;` |  | Gets the effective format settings used to format the value for the time edit control.
`function UsedTimeAMString;` |  | Gets the suffix used for an ante meridiem (before midday) time value in the control.
`function UsedTimeFormat;` |  | Gets the effective short time format used for the Time value in the control.
`function UsedTimePMString;` |  | Gets the suffix used for a post meridiem (after midday) time value in the control.
`function UsedTimeSeparator;` |  | Gets the effective time separator character used in the short time format settings.
`procedure ButtonClick; override;` |  | Performs actions needed when the Button for the control is clicked.
`procedure EditDblClick; override;` |  | Implements the OnDblClick event handler for the Edit in the control.
`procedure EditEditingDone; override;` |  | Implements the OnEditingDone event handler for the Edit in the control.
`public`
`constructor Create(); override;` |  | Constructor for the class instance.
`function ValidTimeFormat();` |  | Indicates whether the specified value is a valid time format for the TTimeEdit control.
`property Time: TDateTime; [rw]` |  | Represents the time value in the control.
`property Button: TSpeedButton;` |  | TSpeedButton instance used on the edit control.
`property DroppedDown: Boolean; [r]` |  | Indicates if the popup dialog for the control is visible.
`published`
`property DefaultNow: Boolean; [rw]` |  | Indicates the current time is used for an empty time value.
`property OnAcceptTime: TAcceptTimeEvent; [rw]` |  | Event handler signalled to validate and accept/reject the time value for the control.
`property OnCustomTime: TCustomTimeEvent; [rw]` |  | Event handler signalled to get an arbitrary time value for the control.
`property ReadOnly: Boolean;` |  | Indicates whether the value for the control can be changed.
`property ButtonCaption: TCaption;` |  | Contains the caption used for the Button on the edit control.
`property ButtonCursor: TCursor;` |  | Cursor shape displayed when the mouse hovers over the Button in the control.
`property ButtonHint: TTranslateString;` |  | Text displayed in the pop-up hint window when the mouse hovers over the button.
`property ButtonOnlyWhenFocused: Boolean;` |  | ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control.
`property ButtonWidth: Integer;` |  | Width for the TSpeedButton on the edit control.
`property Action: TBasicAction;` |  | The Action associated with the control.
`property Align: TAlign;` |  | Specifies the placement of the control on its Parent control.
`property Alignment: TAlignment;` |  | Indicates the text alignment used for the control value.
`property Anchors: TAnchors;` |  | 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;` |  | Indicates if the text in the control is automatically selected when focus is received.
`property BidiMode: TBiDiMode;` |  | Indicates whether text controls use in bi-directional reading.
`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 case conversion used for a value entered in the control.
`property Color: TColor;` |  | The background color for 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.
`property Glyph: TBitmap;` |  | 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: TImageIndex;` |  | 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.
`property DragMode: TDragMode;` |  | Determines how a drag operation is started for the control.
`property EchoMode: TEchoMode;` |  | Indicates if characters entered in the control value are hidden, displayed, or obscured.
`property Enabled: Boolean;` |  | Determines whether the control responds to mouse or keyboard input.
`property Flat: Boolean;` |  | When True, the SpeedButton has a flat appearance rather than a three-dimensional one.
`property FocusOnButtonClick: Boolean;` |  | Indicates if the focus is changed to the Edit control after the Button is clicked.
`property Font: TFont;` |  | The font to be used for text display in this control.
`property MaxLength: Integer;` |  | Maximum number of characters allowed in the editor for the control.
`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;` |  | Indicates if the Font from the Parent control is used in the control.
`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;` |  | PopupMenu for the control.
`property ShowHint: Boolean;` |  | Enables Hint display for the control.
`property SimpleLayout: Boolean; [rw]` |  | Indicates if the dialog uses a layout with 30 minute intervals between values.
`property Spacing: Integer;` |  | Specifies the number of pixels reserved between the Edit and Button controls when Button is visible.
`property TabStop: Boolean;` |  | Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`property TabOrder: TTabOrder;` |  | Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`property TimeAMString: string; [rw]` |  | Specifies the value displayed for a 12-hour time value prior to midday (Noon).
`property TimeFormat: string; [rw]` |  | Specifies the time format used to generate the display Text for the time edit control.
`property TimeSeparator: string; [rw]` |  | Specifies the separator character used to delimit time parts in the format settings applied to the control.
`property TimePMString: string; [rw]` |  | Specifies the value displayed for a 12-hour time value after midday (Noon).
`property Visible: Boolean;` |  | Allows the control, and all of its children, to be displayed or hidden.
`property Text: TCaption;` |  | Contains the formatted text used to represent the Time value for the control.
`property TextHint: TTranslateString;` |  | Default hint text shown when the Text property is empty for the grouped edit control.
`property OnButtonClick: TNotifyEvent;` |  | OnButtonClick - event handler for a mouse click on the SpeedButton.
`property OnChange: TNotifyEvent;` |  | Event handler signalled when the value for the control is changed.
`property OnChangeBounds: TNotifyEvent;` |  | Event handler signalled when the Bounds for the control have been changed.
`property OnClick: TNotifyEvent;` |  | Notification handler for mouse clicks.
`property OnDblClick: TNotifyEvent;` |  | Event handler signalled when a mouse double click occurs in the control.
`property OnContextPopup: TContextPopupEvent;` |  | Invoked when a context-sensitive pop-up menu is requested.
`property OnEditingDone: TNotifyEvent;` |  | Event handler signalled when editing is completed for the control.
`property OnEnter: TNotifyEvent;` |  | Event handler signalled when the control receives focus.
`property OnExit: TNotifyEvent;` |  | Event handler signalled when the control loses focus.
`property OnKeyDown: TKeyEvent;` |  | Event handler signalled for key down keyboard events.
`property OnKeyPress: TKeyPressEvent;` |  | Event handler signalled for character data entered by the user.
`property OnKeyUp: TKeyEvent;` |  | 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 signalled when the mouse pointer is moved in 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 signalled for a downward movement of the mouse wheel.
`property OnMouseWheelUp: TMouseWheelUpDownEvent;` |  | Event handler signalled for an 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.
`end;`

## Inheritance

`TTimeEdit` |  | Implements a control used to edit time values.
`TCustomEditButton` |  | TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button.
`TCustomAbstractGroupedEdit` |  | Implements a grouped edit control.
`TCustomControl` |  | The base class for windowed controls which paint themselves.
`TWinControl` |  | Implements a windowed control which can contain other child controls.
`TControl` |  | The base class for visible controls.
`TLCLComponent` |  | The base class for LCL components which have an associated widget.
`TComponent`
?
`TObject`

## Description

TTimeEdit is a TCustomEditButton descendant which implements a control used to edit a time value. TTimeEdit provides the Edit and Button properties defined in the ancestor class, and a dialog that is executed to select a time value when the Button is clicked. The dialog allows selection of Hour and Minute values from a drop-down list. Enable DirectInput to enter a time value that includes additional time parts (like Seconds and Milliseconds).

The Time value in the control is represented using the TDateTime type; only the time portion of the value is significant.

Use TimeFormat and TimeSeparator to override the default format settings used to generate the display Text for the time edit control.

## Version info

Modified in LCL version 4.0 to include additional properties and methods.

## See also

TTimeEdit.Time |  | Represents the time value in the control.
TTimeEdit.Text |  | Contains the formatted text used to represent the Time value for the control.
TTimeEdit.TimeFormat |  | Specifies the time format used to generate the display Text for the time edit control.
TTimeEdit.TimeSeparator |  | Specifies the separator character used to delimit time parts in the format settings applied to the control.
TCustomEditButton |  | TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button.