Back Forward Page-Rename method

Methods and instructions by function

Use this method to rename a top-level page, or to name a primary page.

The page specified in the activity's Step Page field is the page to rename (a blank Step Page field means the primary page). The page must be listed in the Pages & Classes tab of the activity, unless it is the primary page. The PageNewName parameter may be the same class as the step page or a different class, but must also be specified in the activity's Pages & Classes tab.

NoteYou cannot rename an embedded page.

Parameters

This method has one required parameter:

Parameters

Description

PageNewName

Enter a new page name, starting with a letter. Use only letters, digits, and the underscore character.

Choose the page name carefully. See Understanding page names and reserved pages.

Results

The system renames the page identified on the Step Page column of the current step to the new name specified in the parameter.

CautionPage names are unique within the clipboard. If another page with the new name is already present, the system deletes it and replaces it with the renamed page.

Checking the method status

This method updates the pxMethodStatus property. See How to test method results using a transition.

Definitions top-level page
Related topics How to complete a Pages and Classes tab

zzzMethods and instructions by function