Progress Bar Gadgets
A progress bar gadget is an interactive object you can insert into Envision documents to display a user's page progress through the document and provide navigation controls for moving to the previous or next page.
To work with progress bar gadgets, you should know:
Progress bar gadget UI and behavior
A progress bar gadget consists of the following interactive UI elements:
Previous: a navigation button to go to the previous page in a document. This element is optional and included by default.
Progress bar: a bar that displays how far a user has gone in the document. This element is always included.
Page indicator: a label that displays the number of the current page out of the total number of pages. This element is optional and included by default.
Next: a navigation button to go to the next page in a document. This element is optional and included by default.
A document can have one or more progress bar gadgets. The best practice is to have them on master pages. If there are multiple master pages or users are not allowed to leave the current page without some validation, you can insert progress bar gadgets with different sets of UI elements into the document. A master page or page can have its own progress bar gadget for a specific user case.
Configuring progress bar gadgets
As a newly created progress bar gadget has the default settings, you can customize them with the Progress Bar Configuration pop-up dialog. If multiple progress bar gadgets are in the document, you should configure each separately. The dialog is for one progress bar gadget only.
You can configure a progress bar gadget as follows:
The Progress Bar Configuration dialog
The Progress Bar Configuration pop-up dialog provides the following controls to configure a progress bar gadget selected in a document:
- Starting Page
A drop-down list, the name of the page from which the progress bar gadget will display the document progress. The default value is the name of the first page of the document.
- Show Navigation Buttons
A checkbox to control whether the progress bar gadget will provide (selected) or will not provide (cleared) document users with the Previous and Next buttons. The default value is selected—it will have such buttons.
- Show Navigation Range
A checkbox to control whether the progress bar gadget will display (selected) or will not display (cleared) the page indicator. The default value is selected—it will have such an indicator.
Specifying the starting page of a progress bar gadget
To specify the page from which a progress bar gadget will display the document progress:
Select the progress bar gadget.
From the Starting Page drop-down list in the Progress Bar Configuration dialog, select the name of the page from which the progress bar gadget will display the document progress.
If necessary, continue configuring the progress bar gadget as discussed in the following sections.
Once done with configuring, click the OK button to save the changes. The dialog disappears, and the progress bar gadget displays the progress from the page you have selected from the Starting Page drop-down list.
Managing the inclusion of the navigation buttons in a progress bar gadget
To include or exclude the Previous and Next buttons in a progress bar gadget:
Select the progress bar gadget.
In the Progress Bar Configuration dialog, click the Show Navigation Buttons checkbox, either:
Select the checkbox to include the navigation buttons in the progress bar gadget.
Clear the checkbox to exclude the navigation buttons from the progress bar gadget.
If necessary, continue configuring the progress bar gadget as discussed in other sections.
Once done with configuring, click the OK button to save the changes. The dialog disappears, and the progress bar gadget includes or excludes the Previous and Next buttons according to your settings of the Show Navigation Buttons checkbox.
Managing the inclusion of the page indicator in a progress bar gadget
To include or exclude the page indicator label in a progress bar gadget:
Select the progress bar gadget.
In the Progress Bar Configuration dialog, click the Show Navigation Range checkbox, either:
Select the checkbox to include the page indicator label in the progress bar gadget.
Clear the checkbox to exclude the page indicator label from the progress bar gadget.
If necessary, continue configuring the progress bar gadget as discussed in other sections.
Once done with configuring, click the OK button to save the changes. The dialog disappears, and the progress bar gadget includes or excludes the page indicator label according to your settings of the Show Navigation Range checkbox.
Testing progress bar gadgets
To verify a progress bar gadget as an end-user:
Verify that the progress bar gadget displays the progress from the correct starting page.
Verify that the visibility of the Previous and Next buttons is correctly set.
Verify that the visibility of the page indicator label is correctly set.