Toolbar Button (PRIM_SPBN)
Shortcut button on the toolbar
Ancestors - Control (PRIM_CTRL)Object (PRIM_OBJT)
Details
A Toolbar Button is typically used to perform an action as part of a toolbar or Ribbon.
Toolbar button is very similar to Push Button, however a toolbar button cannot take focus. It can therefore only be activated by the used clicking on it either with a mouse or via touch.
Toolbar button has an Image and Caption, and can also have a Menu attached.
Properties
Name | Description |
|---|---|
Position of the caption shown on the button | |
AllowAllUp property specifies if all buttons can be unchecked | |
Automatically resize and reposition the image | |
BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL) | |
BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL) | |
ButtonStyle property makes the button 3D or flat | |
CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL) | |
Text to be displayed within the control | |
Check property selects or deselects a button | |
ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) | |
ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) | |
ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) | |
Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) | |
ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) | |
ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) | |
Variant of the control being used | |
Cursor sets the cursor image Inherited from Control (PRIM_CTRL) | |
DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL) | |
DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL) | |
Show ellipses for truncated text | |
Enable activates/deactivates the component Inherited from Control (PRIM_CTRL) | |
Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL) | |
Focus tells whether the component has focus Inherited from Control (PRIM_CTRL) | |
Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL) | |
Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL) | |
GroupIndex property identifies toolbar buttons | |
Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL) | |
The height of the control in pixels Inherited from Control (PRIM_CTRL) | |
Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL) | |
HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL) | |
Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL) | |
Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL) | |
HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL) | |
Repository enrolled image to show in the control | |
Set the height and width of the image in pixels | |
ImagePosition sets the position of the image relative to caption | |
IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL) | |
True if the control is currently realized Inherited from Control (PRIM_CTRL) | |
Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL) | |
Bottom margin in pixels | |
Left margin in pixels | |
Right margin in pixels | |
Top margin in pixels | |
Reference to a menu to be attached to the button | |
Popup Panel to display as a button menu | |
Position of the menu when shown | |
Position of the clickable menu prompt | |
Show a separator between the button and the menu | |
Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL) | |
MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL) | |
MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) | |
MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) | |
Name identifies the component Inherited from Object (PRIM_OBJT) | |
Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL) | |
Owner owns this component Inherited from Object (PRIM_OBJT) | |
Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL) | |
Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL) | |
Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL) | |
Reference to a style to be applied when clicked | |
Collection of styles to be applied when clicked | |
Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL) | |
RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) | |
RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) | |
ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) | |
ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) | |
ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) | |
ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) | |
ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL) | |
ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL) | |
Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) | |
Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) | |
SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL) | |
SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) | |
SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) | |
SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL) | |
Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL) | |
Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL) | |
TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL) | |
Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL) | |
Name of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL) | |
Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL) | |
Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL) | |
Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL) | |
Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL) | |
Determines whether a control can be resized Inherited from Control (PRIM_CTRL) | |
Show or hide the control Inherited from Control (PRIM_CTRL) | |
VisualStyle sets the appearance Inherited from Control (PRIM_CTRL) | |
Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL) | |
Width of the component in pixels Inherited from Control (PRIM_CTRL) | |
Wrap text on to the next line if there is insufficient space |
Events
Name | Description |
|---|---|
Fired when an animation is ended [Inherited from Toolbar Button (PRIM_SPBN) Cancelled | |
Fired when the mouse is clicked on the control Origin, Handled | |
CreateInstance is signaled when an instance of a component is created [Inherited from Toolbar Button (PRIM_SPBN) | |
DestroyInstance is signaled when an instance of a component is about to be destroyed [Inherited from Toolbar Button (PRIM_SPBN) | |
Fired on mouse up to signify the end of a drag process [Inherited from Toolbar Button (PRIM_SPBN) PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult | |
Fired during the drag and drop process when the cursor moves over the control [Inherited from Toolbar Button (PRIM_SPBN) PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled | |
Fired when the drag and drop process has completed [Inherited from Toolbar Button (PRIM_SPBN) Source, Payload, DragResult, AggregatedSource, Origin, Handled | |
Fired after a component has been realized for the first time [Inherited from Toolbar Button (PRIM_SPBN) | |
The mouse has entered the bounds of the control [Inherited from Toolbar Button (PRIM_SPBN) | |
The mouse has hovered over the control [Inherited from Toolbar Button (PRIM_SPBN) Origin, Handled | |
The mouse has left the bounds of the control [Inherited from Toolbar Button (PRIM_SPBN) | |
Fired when the user starts a drag and drop process [Inherited from Toolbar Button (PRIM_SPBN) Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled | |
Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events [Inherited from Toolbar Button (PRIM_SPBN) MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue | |
Fired when the user stops touching the screen [Inherited from Toolbar Button (PRIM_SPBN) | |
Fired when the user first makes physical contact with the screen [Inherited from Toolbar Button (PRIM_SPBN) Origin, TouchMove, TouchRotate, TouchScale, TouchSize |
Methods
Name | Description |
|---|---|
Animate from invisible to visible Inherited from Control (PRIM_CTRL) Duration, Delay | |
Animate from visible to invisible Inherited from Control (PRIM_CTRL) Duration, Delay, Visible | |
Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay | |
Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay | |
Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) | |
Animate a change of scale Inherited from Control (PRIM_CTRL) ScaleWidth, ScaleHeight, Duration, Delay | |
Sets the control to be the focus control Inherited from Control (PRIM_CTRL) | |
LANSA Internal Use Inherited from Control (PRIM_CTRL) | |
Changes and animates control size changing Inherited from Control (PRIM_CTRL) Width, Height, Duration, Delay | |
Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) | |
UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL) |