GoFiler Legato Script Reference   Legato v 1.6a Application v 6.0a

Table of Contents	< < Previous	Next >>

 

Chapter Eighteen — DataView Integration (continued)

18.2 DataView Object

18.2.1 Handles

Most functions within this section employ a Data View Object (DVO) handle. This can be a handle retrieved using the DataViewGetObject function and can be accessed using a view handle retrieved from Edit Window functions such as GetActiveEditWindow.

Global DVO handles should be closed after each set of operations to allow the referenced form to update and paint. To speed successive operations, hold the handle open until the group completes. This paint hold does not work for non-DVO references. 

When using a DVO handle, certain functions that alter the text, attributes or layout will automatically open an edit transaction. Using the CloseHandle function or if exiting a routine where the handle is a local variable, the process of closing the handle will close the edit action. Edit actions will mark a file or window as modified.

18.2.2 Tabs

No matter the view type, Data View windows will contain one or more tabs or sheets. While many functions apply to a complete workbook, a DVO handle always references a specific sheet. Certain functions can specify a zero-based tab index or the specific view’s handle can be retrieved from an Edit Window function.

18.2.3 Functions

DataViewActivateTab — Brings the specified tab for the specified Data View Object in view.

DataViewAddEditAction — Increases the edit change count and refreshes the view.

DataViewGetObject — Returns a Data View handle (for an associated sheet) for the specified view by window handle. Also locks for paint.

DataViewGetClassName — Returns the view’s class name.

DataViewGetClassType — Returns the view’s window type.

DataViewGetDataSheet — Returns the handle for a specific data sheet.

DataViewGetTabCount — Returns the number of tabs/sheets for the specified handle.

DataViewGetTabIndex — Gets the tab or sheet index associated with a specific handle.

DataViewGetTab — Retrieves the properties of the default tab or specified tab.

DataViewGetTabName — Retrieves the name of the tab of the default or specified sheet.

DataViewGetTabs

DataViewSetEditFlags — Retrieves or sets editing flags.

DataViewUndoGetCount — Returns the count of aggregated undo transactions.

DataViewUndoSetState — Reads, enables or disables undo transaction tracking.

Page revised 2025-03-13

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 03/17/2025

© 2012-2025 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. Novaworks, GoFiler™ and Legato™ are registered 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.