GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eighteen — DataView Integration (continued)

DataViewGetTab Function

Overview

The DataViewGetTab function retrieves all the data fields associated with a Data View tab.

Syntax/Parameters

Syntax

string[] = DataViewGetTab ( handle hView, [int index] );

Parameters

hView

A handle to either a Data View Object or to a window that employs Data View.

index

An optional zero-based int specifying the tab index or sheet position. If omitted or -1, the sheet associated with the handle’s view is used.

Return Value

Returns a string array containing the tab’s properties or an empty array on failure. Use the GetLastError function to retrieve error information.

Remarks

Depending on the view type and the application, various fields will contain data. They are named as follows:

	Key Name			Description/Comment
	General Items:
		Name		The tab’s name. This field will always be populated.
		Description		A description for the tab.
		Comments		Comments for the tab.
		Tip		Popup tip for the tab. (The hosting application may not support this feature.)
	Dimensional Items:
		RefID		A reference ID. Use depends on the view.
		CallerDataX		Up to 4 32-bit caller data words. They are reported in string form as hexadecimal. Use depends on the view.
		UserData		General data. Use depends on the view.

 

Related Functions

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

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

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

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

[DataViewGetTabs]

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 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.