Extensibility > Graphics Builder Automation Interface > Page Properties Functions > PagePrevious

PagePrevious

Retrieves the name of the page currently defined as "previous" to the active graphics page, or sets the page you would like defined as previous to the current page.

Syntax

PagePrevious(PageName)

PageName:

The name of the page defined as previous for the active graphics page, as a string.

Return Value

The name of the page defined as previous to the active graphics page (as a string), or 0 (zero) if successfully used to set the page that is previous to the active graphics page. In both cases, an error is returned if unsuccessful.

Note: For details on handling return and error values, see Error Handling.

Related Functions

PageName, PageTitle, PageDescription, PageNext, PageArea, PageScanTime, PageLogDevice

See Also

Example

' Defines a page as previous to the current page in a browse sequence
GraphicsBuilder.PagePrevious = "MyPage1"
' Retrieves the name for the page defined as previous to the current page
MyVariable = GraphicsBuilder.PagePrevious

Note: This function is implemented in the C++ environment as two separate functions: put_PagePrevious sets the page defined as previous to the active graphics page, and get_PagePrevious retrieves the name of the previous graphics page.

Published June 2018