Button  - ButtonRowLocate 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.

The UI element ButtonRow can be used to arrange buttons in a row.

You can accurately arrange multiple buttons using ButtonRow. Buttons and 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.

Definition

IWDButtoninherits 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 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 designproperty can be filled with the following values and is represented by the enumeration type WDButtonDesign.

    Values

    Visual Display

    Short Description

    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.

    standard

    Displays the UI element with default background and text color.

  • 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

    This property is deprecated. Use tooltipinstead.

  • 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 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 textDirectionproperty can be filled with the following values and is represented by the enumeration type WDTextDirection.

    inherit

    The text direction is inherited from the parent element. Therefore, the text direction is identical to the one of the parent element.

    ltr

    The text runs from left to right.

    rtl

    The text runs from right to left

    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.

Properties Overview

Name

Interface

Type

Initial Value

Bindable

activateAccessKey

IWDAbstractButton

boolean

false

not bindable

design

IWDButton

WDButtonDesign

standard

bindable

hotkey

IWDAbstractButton

WDHotkey

none

not bindable

enabled

IWDUIElement

boolean

true

bindable

imageFirst

IWDAbstractCaption

boolean

true

bindable

imageSource

IWDAbstractCaption

String

 

bindable

text

IWDAbstractButton

String

 

bindable

textDirection

IWDAbstractCaption

WDTextDirection

inherit

bindable

tooltip

IWDUIElement

String

 

bindable

visible

IWDUIElement

WDVisibility

visible

bindable

width

IWDButton

String

 

bindable

 

Event
  • onAction

    This event is triggered when the user clicks the button.