Show TOC

Background documentationButton and ButtonRow Locate this document in the navigation structure

 

The UI element Button simulates the pushbutton on the screen. The user can execute statements and actions by clicking the pushbutton. Using ButtonRow, you can accurately arrange multiple buttons. In a ButtonRow, Buttons as well as ToggleButtons can be inserted. The ButtonRow itself does not contain any additional properties, but has the relevant methods for creating and maintaining the inserted buttons.

IWDButton inherits from IWDAbstractButton, which is the abstract base class of pushbuttons. It inherits the ability to display an icon from the base class IWDAbstractCaption and adds the ability to display a text on the pushbutton and trigger an action.

Description of the UI Element Properties

activateAccessKey

Indicates whether the access key for this button is activated. More information: Enabling Access Keys

design

Describes the style of the Button UI element - for example, the button size or the highlighting of the button label. The design property is represented by the enumeration type WDButtonDesign and can be filled with the following values:

standard: Displays the UI element with default background and text color.

emphasized: Displays the UI element with highlighted left edge.

next: Displays the button with a triangle pointing to the right.

previous: Displays the button with a triangle pointing to the left.

explanation

Specifies the explanation text. More information: Explanation

hotKey

Specifies the key combination that triggers the onAction event. The value is defined as enumeration type WDHotKey.

imageAlt

Property is deprecated. Use tooltip instead.

imageFirst

Defines the position of the icon in relation to the corresponding text. If the value of this property is true, the icon is displayed to the left-hand side of the text.

imageSource

Defines the path to the image source. See: Specifying the Image Source

size

This property is deprecated and can no longer be used.

text

Describes the label text of the Button UI element.

textDirection

Specifies the text direction and allows you to read the texts of subordinated UI elements in languages which require a specific text direction. The textDirection property can be filled with the following values and is represented by the enumeration type WDTextDirection. The default value for this property is inherit.

width

Determines the width of the Button UI element that you can specify in CSS sizes, such as em, ex, pixels or percentage values.

Events

onAction: This event is triggered when the user clicks the button.