Show TOC

 ToolBarLinkToActionLocate this document in the navigation structure

Definition

ToolBarLinkToActionis a LinkToActionespecially for a ToolBar. You have the option to collapse the element.

Description of UI Element Properties
  • activateAccessKey

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

  • collapsible

    Specifies whether the ToolBar element can be collapsed. A little icon is displayed in a ToolBar which contains those elements. When the user selects this icon, all toolbar elements with the collapsible property set to true are hidden.

  • design

    specifies the design of the ToolBarLinkToAction. The design property can take the following values and is represented by enumeration type WDLinkDesign.

    • emphasized. Highlights the text.
    • standard. Displays the text using the standard font size.
  • hotkey

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

  • imageAlt

    This 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 of the text.

  • imageHeight

    Specifies the height of the graphic next to the link. You can specify the height in CSS units like em, ex, pixels, or percentage.

  • imageSource

    defines the path to the image source.

    More Information: Specifying the Image Source

  • imageWidth

    Specifies the width of the graphic next to the link. You can specify the width in CSS units like em, ex, pixel, or percentage.

  • size

    This property is deprecated.

  • text

    Describes the label text.

  • textDirection

    Specifies the text direction and allows you to use subordinated UI elements for texts in languages which require a specific text direction. The textDirection property can take the following values and is represented by 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.

  • wrapping

    Indicates whether or not the link text is wrapped. If the initial value is false, the link text is not wrapped.

    Note

    If the value of this property is false, the link text is not wrapped.

Properties Overview

Name

Interface

Type

Initial Value

Bindable

activateAccessKey

IWDLink

boolean

false

not bindable

collapsible

IWDToolBarLinkToAction

boolean

false

bindable

design

IWDLink

WDLinkDesign

standard

bindable

enabled

IWDUIElement

boolean

true

bindable

hotkey

IWDToolBarLinkToAction

WDHotkey

none

not bindable

imageAlt

IWDAbstractCaption

String

 

bindable

imageFirst

IWDAbstractCaption

boolean

true

bindable

imageHeight

IWDLink

String

 

bindable

imageSource

IWDAbstractCaption

String

 

bindable

imageWidth

IWDLink

String

 

bindable

size

IWDLink

WDLinkSize

standard

bindable

text

IWDLink

String

 

bindable

textDirection

IWDAbstractCaption

WDTextDirection

inherit

bindable

tooltip

IWDUIElement

String

 

bindable

visible

IWDUIElement

WDVisibility

visible

bindable

wrapping

IWDLink

boolean

false

bindable

Events
  • onAction

    The event onAction is triggered when the user clicks the ToolBarLinkToAction.