Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

PageControlGetText Function

Overview

The PageControlGetText function retrieves the text from a page control.

Syntax/Parameters

Syntax

string = PageControlGetText ( int id );

Parameters

id

An int containing the control ID of the page control.

Return Value

A string containing the HTML code or empty on failure. Since it is possible to have an empty string as a value, the last error must be retrieved or tested to differentiate between no data and an error. Use the IsError to test for an error and the GetLastError function to retrieve a formatted error code. Common errors include: ERROR_RANGE if id is an invalid control ID for the open dialog or ERROR_INVALID_HANDLE if no dialog is open.

Remarks

The code returned will have line endings represented by return/new line (0x0D 0x0A) without regard to the type employed on a string to set data in the control.

If data is retrieved from a blank control, a paragraph placeholder will be returned.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic