  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
GetSelectStartYPosition Function
Overview
The GetSelectStartYPosition returns the native Y position in number of lines for the start of a selection within an edit window.
Syntax/Parameters
Syntax
int = GetSelectStartYPosition ( handle hObject, [int index] );
Parameters
hObject
A handle to an Edit Object or an Edit View.
index
An optional int containing an array index for the selection. This value is useful for array selections to determine the end position for an item within the array.
Return Value
Returns an int presenting the starting Y position or -1 on failure. Use the GetLastError function to retrieve error information.
Remarks
The Y position can be thought of as the starting line of the selection within the document, with the count beginning at zero (first line).
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.