Integrating a guided tour with your application
You can use one or more controls to integrate a guided tour with your application. By defining the conditions that start, stop, or restart your tour, you can respond to the actions that users take on the screen.
- Add a control to the section that starts the tour.
- Find and open a section to start the guided tour, by searching for it or by using the Application Explorer.
- On the Design tab of the Section form, add any field, or control, to the section. For more information, see Creating sections.
- Click the field to edit it.
- If you are in full section editing mode, click the Gear icon.
- In the Cell properties dialog box, click Change, and then click Other in the Custom control category.
- In the autocomplete field, enter one of the following controls:
pxGuidedTourAutoStart – Starts the tour one time per user.
pxGuidedTourAutoStartOncePerSession – Starts the tour one time per session, to support users who share the same log-in credentials.
- Associate the control with your guided tour.
- In the Cell properties dialog box, click Parameters.
- In the TourClass field, press the Down Arrow key, and then select the class of your guided tour.
- In the TourName field, press the Down Arrow key, and then select the name of your guided tour.
- Optional: To start the tour every time that the control is displayed, select the AutoLaunchAlways check box. This option is available for the pxGuidedTourAutoStart control only.
- Click Submit.
- Click Save.
- Optional: To support restarting the guided tour, add actions to other elements on the
screen.
- Follow step 1 to open the Cell Properties dialog box for another section or another element in the same section.
- Click Actions, and then click Create an action set.
- Click Add an event, and then click the type of event, such as mouse click, that initiates the action.
- Click .
- In the Action to take list, select Start tour.
- In the Tour applies to field, enter the class of your guided tour.
- In the Tour name field, enter the name of the guided tour.
- Optional: To restart the tour from the beginning instead of the last visited tour stop, clear the Always continue where left off check box.
- Click Submit.
- Click Save.
Previous topic Associating content with a feature in a guided tour Next topic Creating guidance for developers