Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

PageControlGetSelectArray Function

Overview

The PageControlGetSelectArray function returns an table of points for multiple selected areas.

Syntax/Parameters

Syntax

int[][] = PageControlGetSelectArray ( int id );

Parameters

id

An int containing the control ID of the page control.

Return Value

An int table as items as rows and columns as entry data, all as zero-based positions or empty on failure. Use the GetLastError function to retrieve a formatted error code. GetLastError can also be used to get an an item count on success. 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

Each selected item represents a row. Array selects are usually performed for cells, columns, regions and rows. Select positions include the tag end points. For example, the start of a cell is the opening <TD...> and the end is the last character of the </TD>.

The columns position within the control is always based on an X/Y file code position. Key names are “s_x”, “s_y”, “e_x”, “e_y”, “r_n” and “c_n”. Columns numbers are -1 for row selections.

The X position is always a native position, i.e., tabs are not expanded and treated as a single character position.

When using a fixed table, call the function without setting a variable and get the number of rows by using the GetLastError function.

Related Functions

Platform Support

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

Legato IDE, Legato Basic