  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eighteen — DataView Integration (continued)
Overview
The DataViewGetDataSheet function returns a Data Sheet Object handle to a sheet within a Data View as referenced from a view window or Data View Object handle. This object can then be used to access various Data Sheet functions.
Syntax/Parameters
Syntax
handle = DataViewGetDataSheet ( handle object, [int index] );
Parameters
object
A handle to either a Data View Object or to a window that employs Data View.
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 Sheet Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information. Use the CloseHandle function to close the handle.
Remarks
Each Data View sheet has a Data Sheet Object for its data store. The sheet handle can be used to access the same information, but in a more universal manner should the script contain code that works with Data View objects and simple sheet objects.
The Data Sheet Object will not handle undo operations and programmers should use caution when changing sheet content via the Data Sheet Object functions. See Section 8.6 Data Sheet for information on Data Sheet Objects.
Unlike a Data View Object, the CloseHandle operation does not update any associated windows.
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.