GetPageName Function

Class

PageList class

Action

Returns the page name of the specified page.

Syntax

sName = pagelist.GetPageName (iIndex, [bRawMode])

Variable	Description
`sName`	Name of the tab of the specified page. STRING.
`iIndex`	Page number. INTEGER.
`bRawMode`	Optional. TRUE to leave the platform-specific information in the string or FALSE (the default) to remove the information. BOOLEAN. The Open Agent always uses FALSE for this value regardless of what is specified in the script. The returned strings include trailing and leading spaces but ellipses, accelerators, and hot keys are removed.

Variable

Description

sName

Name of the tab of the specified page. STRING.

iIndex

Page number. INTEGER.

bRawMode

Optional. TRUE to leave the platform-specific information in the string or FALSE (the default) to remove the information. BOOLEAN.

The Open Agent always uses FALSE for this value regardless of what is specified in the script. The returned strings include trailing and leading spaces but ellipses, accelerators, and hot keys are removed.

Example

// Prints the name of the tab on page 1.
Print (MyDialog.MyPageList.GetPageName(1))