HorizontalContextualPanel

Definition

HorizontalContextualPanel (HCNP) is a bar of two rows. The first row is built of larger sized tabs. The second row can contain menu items.

Unlike a TabStrip UI element, the LeadSelection will not be changed automatically if the user selects a tab. You can set the LeadSelection for the context node which you have bound the itemSource property to by using method <node name>.setLeadSelection() .

Description of UI Element Properties

activateAccessKey

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

design

specifies the design of the HorizontalContextualPanel . The design property can take the following values and is represented by enumeration type WDHorizontalContextualPanelDesign:

standard
emphasized

itemEnabled

Specifies whether the item is enabled.

itemSource

Specifies the path to the context node. Must be bound to the context node from which the HorizontalContextualPanel gets its data. Two levels are rendered. The first level forms the tabs and the second level forms the menu items.

itemText

Specifies the item text.

itemTextDirection

You use this property to specify the text direction. This enables the labels for the tabs to be read in other languages that 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. The text direction is thus identical to that 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 .

itemVisible

specifies whether the item is visible.

Properties Overview

Name	Interface	Type	Initial Value	Bindable
activateAccessKey	IWDHorizontalContextualPanel	boolean	false	not bindable
design	IWDHorizontalContextualPanel	WDHorizontalContextualPanelDesign	standard	bindable
enabled	IWDUIElement	boolean	true	bindable
itemEnabled	IWDHorizontalContextualPanel	boolean	true	bindable
itemSource	IWDHorizontalContextualPanel	Object		bindable_mandatory
itemText	IWDHorizontalContextualPanel	String		bindable
itemTextDirection	IWDHorizontalContextualPanel	WDTextDirection	inherit	bindable
itemVisible	IWDHorizontalContextualPanel	boolean	true	bindable
tooltip	IWDUIElement	String		bindable
visible	IWDUIElement	WDVisibility	visible	bindable

Data Binding

To display the items individually with the corresponding text, text direction and state, you need to bind all properties to the context. For the second level that displays the MenuItems , you can use a recursive context node. Bear in mind that only two levels are supported.