  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
DataControlGetCaretPosition Function
Overview
The DataControlGetCaretPosition function returns the caret position by row and column.
Syntax/Parameters
Syntax
int [] = DataControlGetCaretPosition ( int id );
Parameters
id
An int containing the control ID of the data control.
Return Value
Returns an int array of two elements for the row and column position or an empty array on failure. Common error codes are as follows: ERROR_RANGE if id is an invalid control ID for the open dialog or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information.
On success, the array key values are “Row” and “Col” or 0 and 1 respectively.
Remarks
The column and row position are always processed and returned even if the select mode is set to rows or columns. As the user clicks on a row, it must be over a specific column and as such the column position is also set.
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.