Technical Reference > Graphics Builder Automation Interface > Page Properties Functions > PageTitle

PageTitle

Sets or retrieves the title of the active CitectSCADA graphics page.

Syntax

PageTitle(Title)

Title:

The title of the active page as a string.

Return Value

The title of the active graphics page as a string, or 0 (zero) if successfully used to set the title of 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, PageDescription, PagePrevious, PageNext, PageArea, PageScanTime, PageLogDevice

See Also

Example

' Sets the title of the active graphics page
GraphicsBuilder.PageTitle = "MyTitle"

' Retrieves the title of the active graphics page
MyVariable = GraphicsBuilder.PageTitle

Note: This function is implemented in the C++ environment as two separate functions: put_PageTitle sets the title of the active graphics page, and get_PageTitle retrieves the title of the active graphics page.