ToggleLinkLocate this document in the navigation structure

A ToggleLinkis a link that can display two different states.They are displayed with a triangle symbol:

checked = false WDJ_UIE_TOGGLELINK

checked = true

WDJ_UIE_TOGGLELINK

Description of UI Element Properties
  • activateAccessKey

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

  • checked

    Specifies whether or not the ToggleLinkis toggled.

  • hotkey

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

    enumeration type WDHotkey .

  • text

    Describes the text to be displayed.

  • textDirection

    Specifies the text direction and allows you to use a ToggleLink for texts 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.

    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.

Properties Overview
Name Interface Type Initial Value Bindable

activateAccessKey

IWDAbstractToggle

boolean

false

not bindable

checked

IWDAbstractToggle

boolean

false

bindable_mandatory

enabled

IWDUIElement

boolean

true

bindable

hotkey

IWDToggleLink

WDHotkey

none

not bindable

text

IWDToggleLink

String

 

bindable

textDirection

IWDAbstractToggle

WDTextDirection

inherit

bindable

tooltip

IWDUIElement

String

 

bindable

visible

IWDUIElement

WDVisibility

visible

bindable

Events

The onToggle event is triggered when the ToggleLinkis toggled. The parameter is the new status of the element.

Name Class Parameter

onToggle

IWDAbstractToggle

(boolean checked)