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

TEditButton

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

Implements a grouped edit control with both an Edit and a Button.

Declaration

Source position: editbtn.pas line 129

type TEditButton = class(TCustomEditButton)

public

  property AutoSelected: Boolean;

  

Indicates if the current text selection was performed automatically.

  property Button: TSpeedButton;

  

TSpeedButton instance used on the edit control.

  property Edit: TEbEdit;

  

Edit is the TEbEdit control used to perform direct input for the value in the grouped edit control.

published

  property NumbersOnly: Boolean;

  

Indicates if the edit control accepts numeric values only.

  property Action: TBasicAction;

  

The Action associated with the control.

  property AutoSelect: Boolean;

  

Enables auto-selection of text when focused.

  property AutoSize: Boolean;

  

Enables automatic adjustment of the size for the control, according to its content.

  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 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;

  

Style for the Border drawn around the control.

  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 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 Cursor: TCursor;

  

Contains the shape for the mouse pointer when the mouse is over the control.

  property DirectInput: Boolean;

  

Indicates if text can be entered directly into the BaseEditor control.

  property EchoMode: TEchoMode;

  

Allows to modify the text display, useful for entering passwords.

  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 Glyph: TBitmap;

  

Glyph - the small graphic image on the SpeedButton, which ought to indicate its function.

  property Hint: TTranslateString;

  

The text to show in the Hint window for the control.

  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 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 NumGlyphs: Integer;

  

NumGlyphs - the number of available glyphs.

  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 OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnDblClick: TNotifyEvent;

  

Event handler signalled when a mouse double click occurs in the control.

  property OnDragDrop: TDragDropEvent;

  

Event handler signalled when an object is dropped onto the control.

  property OnDragOver: TDragOverEvent;

  

Event handler signalled when a control is dragged over the control instance.

  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 OnEndDrag: TEndDragEvent;

  

Event handler signalled for the end of a drag-drop operation.

  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 OnStartDrag: TStartDragEvent;

  

Event handler signalled for the start of a dragging operation.

  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;

  

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 PasswordChar: Char;

  

Allows obfuscation of the displayed text, showing all characters as PasswordChar.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control.

  property ReadOnly: Boolean;

  

Indicates if the user is prevented from changing the value for the Text in the control.

  property ShowHint: Boolean;

  

Enables Hint display for the control.

  property Spacing: Integer;

  

Specifies the number of pixels reserved between the Edit and Button controls when Button is visible.

  property TabOrder: TTabOrder;

  

Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.

  property Text: TCaption;

  

The text displayed and edited for the control.

  property TextHint: TTranslateString;

  

Default hint text shown when the Text property is empty for the control.

  property Visible: Boolean;

  

Allows the control, and all of its children, to be displayed or hidden.

end;

Inheritance

TEditButton

  

Implements a grouped edit control with both an Edit and a Button.

|

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,IUnknown,IInterfaceComponentReference

|

TPersistent,IFPObserved

|

TObject

Description

TEditButton implements a grouped edit control with both an Edit and a Button. TEditButton is derived from the TCustomEditButton class, and sets the visibility for properties declared in the ancestor classes.

See also

TCustomEditButton

  

TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button.

TCustomEditButton.Edit

  

Edit is the TEbEdit control used to perform direct input for the value in the grouped edit control.

TCustomEditButton.Button

  

TSpeedButton instance used on the edit control.

TCustomAbstractGroupedEdit

  

Implements a grouped edit control.


Version 3.2 Generated 2024-02-25 Home