GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Nine — Dialog Functions (continued)

PageControlGetSelectMode Function

Overview

The PageControlGetSelectMode function returns the select mode of the control.

Syntax/Parameters

Syntax

int = PageControlGetSelectMode ( int id );

Parameters

id

An int containing the control ID of the page control.

Return Value

An int as a select mode for the selected item or a formatted error code on failure. 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 select mode determines how something is selected. The values are as follows:

	Code		Value		Comment
	EDO_NOT_SELECTED		0		Nothing Selected — Simple caret.
	EDO_LINEAR_SELECT		1		Linear Select — Text is selected from a start x/y to an end x/y.
	EDO_BLOCK_SELECT		2		Block Select — Text is selected from a start x/y to an end x/y but only within a box area.
	EDO_ARRAY_SELECT		3		Array Select — Multiple items have been selected. This is normally used for tables.
	EDO_OBJECT_SELECT		4		Object Select — An object, such as an image, is selected. Note that the selected area is the point position immediately after the start of the object’s tag.

 

Use the PageControlGetSelectClue function to determine exactly what is selected.

Related Functions

PageControlGetCaret — Returns the zero-based caret position as an array.

PageControlGetCaretY — Returns the zero-based caret Y file position.

PageControlGetCaretX — Returns the zero-based caret X file position.

PageControlGetSelectArea — Returns the current select area in the form of a list.

PageControlGetSelectArray — Returns the current select array in the form of a table.

PageControlGetSelectClue — Returns the current select mode.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.