Start of Content Area

Background documentation ProgressIndicator  Locate the document in its SAP Library structure

The ProgressIndicator UI element shows how much progress an activity has made in the form of a horizontal bar, along with the value that you have assigned to the percentValue property. You can use the displayValue property to display a text in the ProgressIndicator on the left side of the UI element. This makes it possible to provide descriptions with specific percentage values. You can hide the DisplayValue value using the showValue property. You can display the ProgessIndicator UI element in different colors using the barColor property. You can assign a popup menu to a ProgressIndicator.

You can use the ProgressIndicator UI element  to display, for example, a project status in percent.

Example of the Visual Display

This graphic is explained in the accompanying text

 

Note

To enable the development of accessible applications, the tooltip property is checked during the syntax check.

 

Runtime Class

CL_WD_PROGRESS_INDICATOR

 

Properties in the View Designer

Name

Type

Initial Value

Bindable

id

STRING

(automatic)

No

barColor

WDUI_PROG_IND_BAR_COL

neutral

Yes

contextMenuBehaviour

WDUI_CONTEXT_MENU_BEHAVIOUR

inherit

No

contextMenuId

WDY_MD_UI_ELEMENT_REFERENCE

 

No

displayValue

STRING

 

Yes

enabled

WDY_BOOLEAN

true

Yes

percentValue

I

0

Yes

showValue

WDY_BOOLEAN

true

Yes

tooltip

Translatable text

 

Yes

visible

WDUI_VISIBILITY

visible

Yes

width

STRING

 

Yes

 

Aggregations in the View Designer

Name

Cardinality

Type

Menu

0..1

Menu

Note

Other properties that can be inherited are defined in the associated higher-level classes. The associated UI elements are:

        UIElement

        ContextMenuProvider

        ViewElement

Dynamic Programming

For dynamic programming, the same properties, events, and aggregations as in the View Designer are available. Bear in mind the different spellings.

Dynamic Programming of Properties

View Designer Name

Runtime Name

Type

barColor

BAR_COLOR

WDUI_PROG_IND_BAR_COL

 barColor: critical

CL_WD_PROGRESS_INDICATOR=>E_BAR_COLOR-CRITICAL

 barColor: negative

CL_WD_PROGRESS_INDICATOR=>E_BAR_COLOR-NEGATIVE

 barColor: neutral

CL_WD_PROGRESS_INDICATOR=>E_BAR_COLOR-NEUTRAL

 barColor: positive

CL_WD_PROGRESS_INDICATOR=>E_BAR_COLOR-POSITIVE

contextMenuBehaviour

CONTEXT_MENU_BEHAVIOUR

WDUI_CONTEXT_MENU_BEHAVIOUR

 contextMenuBehaviour: inherit

CL_WD_PROGRESS_INDICATOR=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT

 contextMenuBehaviour: provide

CL_WD_PROGRESS_INDICATOR=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE

 contextMenuBehaviour: suppress

CL_WD_PROGRESS_INDICATOR=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS

contextMenuId

CONTEXT_MENU_ID

WDY_MD_UI_ELEMENT_REFERENCE

displayValue

DISPLAY_VALUE

STRING

enabled

ENABLED

WDY_BOOLEAN

percentValue

PERCENT_VALUE

I

showValue

SHOW_VALUE

WDY_BOOLEAN

tooltip

TOOLTIP

WDY_MD_TRANSLATABLE_TEXT

visible

VISIBLE

WDUI_VISIBILITY

visible: none

CL_WD_PROGRESS_INDICATOR=>E_VISIBLE-NONE

visible: visible

CL_WD_PROGRESS_INDICATOR=>E_VISIBLE-VISIBLE

width

WIDTH

STRING

 

Dynamic Programming of Aggregations

View Designer Name

Runtime Name

Cardinality

Menu

MENU

0..1

 

Example

You can find an example of this UI element in the system in the WDR_TEST_UI_ELEMENTS Web Dynpro application.

 

 

End of Content Area