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

TButton

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

TButton: Base type for all Buttons. A push button control

Declaration

Source position: stdctrls.pp line 1110

type TButton = class(TCustomButton)

public

  procedure Click; override;

  

Click - a procedure that allows the programmer to simulate a mouse click over the control, and initiates the same Action as that associated with the OnClick event

published

  property Action;

  

The action to be associated with this control

  property Align;

  

Used to align the control to the top, bottom, left or right of its client.

  property Anchors;

  

The set of anchor definitions for this control

  property AutoSize;

  

Whether auto-size is to be used

  property BidiMode;

  

BiDiMode - enabling bi-directional writing

  property BorderSpacing;

  

Determines the border spacing for this control

  property Cancel;

  

Is this the Cancel button? (default setting is False)

  property Caption;

  

Caption - the text-string appearing on the Control, usually used to identify its function

  property Color;

  

Determine the colour for the current control

  property Constraints;

  

Determine Constraints (max and min height and width) for this control

  property Default;

  

Is this the Default button? (default setting is False)

  property DragCursor;

  

DragCursor - the style of cursor to be used during the Drag process

  property DragKind;

  property DragMode;

  

DragMode - whether manual or automatic

  property Enabled;

  

Whether the control is Enabled. If not, it usually appears 'greyed-out'

  property Font;

  

The Font to be used for text in this control

  property ParentBidiMode;

  

ParentBiDiMode - does the control follow the BiDiMode settings of its parent?

  property ModalResult;

  

Determines whether the button closes its modal parent form.

  property OnChangeBounds;

  

Event handler for a change in bounds of the control

  property OnClick;

  

Event Handler for mouse click

  property OnContextPopup;

  

Event handler to supply information when a context-sensitive pop-up menu is required

  property OnDragDrop;

  

Event handler for the Drag-Drop manoeuvre

  property OnDragOver;

  

Event handler for the case when a control is dragged over another control

  property OnEndDrag;

  

Event handler for the end of a dragging process

  property OnEnter;

  

OnEnter - event handler for when the mouse enters the control, and the control receives focus

  property OnExit;

  

OnExit - event handler for when the mouse leaves the control and it loses focus

  property OnKeyDown;

  

OnKeyDown - event handler for instance when key is down while control has focus

  property OnKeyPress;

  

OnKeyPress - event controller for a key being pressed while the control has focus. To properly handle national chars use UTF8KeyPress instead.

  property OnKeyUp;

  

OnKeyUp - event handler for instance when a key is up (not pressed) while the control has focus

  property OnMouseDown;

  

Event handler for when a mouse button is pressed down

  property OnMouseEnter;

  

Event handler for when the mouse enters the area of the current control

  property OnMouseLeave;

  

Event handler for when the mouse leaves the area of the current control

  property OnMouseMove;

  

Event handler for mouse movement within the current control

  property OnMouseUp;

  

Event handler for when the mouse button is released, ie "up"

  property OnResize;

  

Event Handler for resize of control

  property OnStartDrag;

  

Event handler for start of dragging process

  property OnUTF8KeyPress;

  

UTF8KeyPress - event controller for a key being pressed while the control has focus.

  property ParentFont;

  

ParentFont - should the control use the same font as the parent? Default is true

  property ParentShowHint;

  

ParentShowHint - does the control adopt the same hinting behaviour as its parent? Default is true

  property PopupMenu;

  

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

  property ShowHint;

  

Flag to determine: Is hint to be displayed for this control?

  property TabOrder;

  

The place this control occupies in the list of tabs

  property TabStop;

  

Is the control in the sequence of controls accessed by successive presses of the Tab key?

  property Visible;

  

Visible - can the control be seen?

end;

Inheritance

TButton

  

TButton: Base type for all Buttons. A push button control

|

TCustomButton

  

TCustomButton - the base class for TButton and TBitBtn

|

TButtonControl

  

TButtonControl : ancestor class for several Button (including Radio Button) and Check Box classes

|

TWinControl

  

TWinControl - the base class for all windowed controls

|

TControl

  

TControl - the main ancestor class for visual controls.

|

TLCLComponent

?

TObject

Description

TButton: Base type for all Buttons. A push button control.

The user pushes a button (eg selects it with the mouse cursor and clicks the mouse) to start an action.

See also

HowToUseStdCtrls

  

How to use StdCtrls, ComCtrls or ExtCtrls

The latest version of this document can be found at lazarus-ccr.sourceforge.net.