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

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

DataSheetGetCellAttributes Function

Overview

The DataSheetGetCellAttributes function returns a string array of cell attributes.

Syntax/Parameters

Syntax

string[] = DataSheetGetCellAttributes ( handle hSheet, int row, int column );

string[] = DataSheetGetCellAttributes ( handle hSheet, string row, string column );

string[] = DataSheetGetCellAttributes ( handle hSheet, string address );

Parameters

hSheet

A handle to a Data Sheet Object.

row

An int or string specifying a zero-based row or Y position for the cell.

column

An int or string specifying a zero-based column or X position for the cell.

address

A string specifying the cell position by cell address such as “A1”.

Return Value

Returns a string array containing the each attribute value for the cell or an empty array on failure. Use the GetLastError function to retrieve error information.

Remarks

The following key names are used:

	Element Key Name		Description
	FieldTypeData		Extended field data for non-text style cells.
	NativeData		Native data for non-text style cells. For example, the text of a radio style button.
	Name		The name of the cell.
	Description		The description of the cell.
	Tip		An optional popup tip. Tips are only displayed if the host view supports tooltip popups.
	Comment		A general comment.
	Review		A review note.
	PrivateA		General caller private data.
	PrivateB		General caller private data.
	Events		Script Events.

 

Related Functions

DataSheetGetCell — Returns all properties of a cell in the form of a string array.

DataSheetGetCellAttributeString — Returns the aggregate attribute string of a cell.

DataSheetGetCellName — Gets a cell name by row and column.

DataSheetGetCellText — Gets cell text by row and column.

DataSheetGetCellType — Gets the cell type (text, numeric, button, etc).

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-12-13

 

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.