Skip to main content

History-List method

Suggest edit
Updated on March 16, 2022

Use the History-List method to obtain a list of History- instances for a class.

This method is similar to the Obj-List method, which creates embedded pages corresponding to a list of instances of a class.

Parameters

This method has five parameters:

ParameterDescription
ToPageIdentify the name of the destination clipboard page to contain the results of this method. This can be an existing or new page.
ClearToPage Select if the system is to clear the current contents of the page identified in the ToPage parameter before adding history detail.
IncludeLinksSelect this box to cause HTML <A > anchors from the history instances to be included on the destination page.
MaxReturnOptional. Enter an integer value that is the maximum number of history instances to search and return.
DescendingSelect this box to cause the embedded pages to correspond to the history instances with oldest first, corresponding to index value (1).

Results

This method retrieves history instances up to the count identified in the MaxReturn parameter and creates an embedded page for each instance, sorted in accord with the Descending check box.

Checking the method status

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

Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us