Use the Page-New method to create a page on the clipboard. The new page may be a top-level page or an embedded page.
You can identify a data transform to initialize the newly created page. The data transform can set values for one or more properties.
Except in rare cases, identify in the Step Page field the name of the page to be created by this method. If the Step Page field of the step is blank, this method clears the primary page of the current activity and may change its class. This often is undesirable.
Use the Apply-DataTransform method, not the Page-New method, to apply a data transform to an existing page.
Identify the name of the page in the Step Page column of the step. Choose a valid page name. See Understanding page names and reserved pages.
This method has three parameters:
The following keywords mean different things in other parts of PRPC. Using them as a page name is not recommended: param
, local
, primary
, steppage
, mysteppage
, top
, parent
, or current
.
The following names and patterns are not valid: pxNode
, pxRequestor
, pxThread
, locate*
prompt*
, $*
, px*
, pz*
, or py*
.
To avoid potential confusion, don't use Declare_ as the initial portion of a page name. By convention, such names indicate data pages.
The system creates a new page as specified, using the name in the Step Page column of the step. Next, it finds the data transform using rule resolution and applies it to initialize the contents of the new page.
The page name may identify a Data Page rule that has a Page Type (on the Definition tab) of Read-Only
. If appropriate conditions are met, the Data Page rule is executed and creates a clipboard page within the User Pages group. That page can thereafter be updated, saved, and processed like other user pages.
Page names are unique within the clipboard. If another page with the new name is already present, the system replaces the contents of new page with the contents of the existing page that has the same name.
This method updates the pxMethodStatus property. See How to Test method results using a transition.
You may want the activity to check whether a page with a certain name exists before you open a new page.
In the activity step's precondition, enter the following:
= @PageExists("myPage", tools)
where myPage is the name of the clipboard page.
This method cannot be used in a step that involves iteration. This method cannot be used to create a data page.