  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eighteen — DataView Integration (continued)
Overview
The DataViewGetObject function returns the handle to a sheet within Data View Object (DVO) as referenced from a view window handle. This object can then be used to access various Data View functions.
Syntax/Parameters
Syntax
handle = DataViewGetObject ( handle hwView, [int index] );
Parameters
hwView
A handle specifying a window handle to a view. This can be retrieved by using the Edit Window functions.
index
An optional zero-based int specifying the sheet or tab index. If omitted, the sheet associated with the view handle is returned.
Return Value
Returns a handle to a Data View Object (DVO) or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information. When processing has been completed, the script should use the CloseHandle function to discard the handle.
Remarks
DVO handles reference a sheet or tab within a collection of sheets that make up an overall view. Most functions at the Data View level access the entire group of sheets or work on abstract references to data. Each sheet will also employ a Data Sheet Object. Many views that employ a Data View as an underlying framework may have high-level functions that should be used in preference to mid-level Data View functions, such as this function.
The most common reasons the DataViewGetObject function could fail is the view handle is invalid or does not point to a window that employs Data View as the underlying class.
When a DVO handle is closed, any outstanding edit actions are completed and the window and frame is updated.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
| 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.