RoadMapStep API 

Definition

The RoadMapStep element represents a step in a RoadMap UI element. The following graphic shows how the UI element is displayed:

Description of UI Element Properties

●     description

Allows you to display a text underneath the individual RoadMap steps.

●     design

The property design is deprecated.

You can visualize the appropriate design by using the following properties:

○     RoadMap: selected

○     RoadMapStep: enabled

○     RoadMapStep: type

        

●     enabled

Specifies whether or not the RoadMap step is activated. Only an activated RoadMap step can trigger events.

●     name

Allows you to specify a label for the RoadMapStep, which is displayed in the RoadMapStep itself.

●     textDirection

Specifies the text direction and allows you to use a RoadMap step 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.

●     tooltip

Describes a note for the RoadMapStep. The note is displayed when the user places the cursor on the UI element.

●     type

Specifies the type of the RoadMap step.
The type property can be filled with the following values and is represented by the enumeration type WDRoadMapStepType.

roundtripClosed	Specifies a step in the RoadMap UI element which contains substeps. These substeps are not displayed on the user interface.
roundtripEnd	Specifies the end point of a round trip.
roundtripStart	Specifies the starting point of a round trip.
standard	Specifies the standard step of a RoadMap UI element.
substep	Specifies the substep used for round trips.

●     visible

Specifies whether or not the RoadMap step is displayed. This property enables you to easily hide a RoadMap step.

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
design	IWDRoadMapStep	WDRoadMapStepDesign	standard	bindable	No
description	IWDRoadMapStep	String (TranslatableText)		bindable	No
enabled	IWDRoadMapStep	boolean	true	bindable	No
name	IWDRoadMapStep	String (TranslatableText)		bindable	No
textDirection	IWDRoadMapStep	WDTextDirection	inherit	bindable	No
tooltip	IWDRoadMapStep	String (TranslatableText)		bindable	No
type	IWDRoadMapStep	WDRoadMapStepType	standard	bindable	No