  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
Overview
The PageControlGetCaretX function returns the current caret X/Y code position in the form of an array.
Syntax/Parameters
Syntax
int[] = PageControlGetCaret ( int id );
Parameters
id
An int containing the control ID of the page control.
Return Value
An int array as two zero-based file positions or empty on failure. Use 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 position within the control is always based on an X/Y file code position. Key names are “X” and “Y” for the zeroeth and first positions respectively.
The X position is always a native position, i.e., tabs are not expanded and treated as a single character position.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 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.