  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Seventeen — Application Integration Functions (continued)
Overview
The GetEditObject function returns the handle to an Edit object that represents the specified window (view).
Syntax/Parameters
Syntax
handle = GetEditObject ( handle hwTarget | int index | string name );
Parameters
hwTarget
If a handle is specified, then index or filename cannot be specified. If the handle is not a view, the Edit Object for the last active window will be returned. If a handle is specified, then an edit window index and view cannot be specified.
index
If an int is provided, it is expected to be an edit manager window index. The index can be -1 indicating that the active window is requested.
string
If a string is provided, an attempt is made to locate the window via the name of the window. Untitled windows cannot be accessed with this method.
Return Value
A handle to the created Edit Object or NULL_HANDLE (0) for an error. If an error occurs, a structured error can be retrieved using the GetLastError function.
Remarks
The last active window is always used to create the Edit Object.
The Edit Object should be closed when all work has been completed. Do not hold Edit Objects open or get another Edit Object for the same window without first closing the previous handle. This is useful to retrieve the type for a specific view.
If the window is specified as a handle, the request is sent directly to the window.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE
| 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.