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

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

DataSheetGetCellAttributeString Function

Overview

The DataSheetGetCellAttributeString function returns the raw aggregated cell attribute string.

Syntax/Parameters

Syntax

string = DataSheetGetCellAttributeString ( handle hSheet, int row, int column );

string = DataSheetGetCellAttributeString ( handle hSheet, string row, string column );

string = DataSheetGetCellAttributeString ( 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 containing the common delimited aggregate attributes or an empty string on failure. Use theGetLastError function to retrieve error information.

Remarks

The aggregate attribute string is normally broken into a number of attributes. This retrieves the raw string in CSV format. When there are no attributes, the string will be empty. Therefore, the GetLastError function must be used to determine if an error occurred.

The order of the delimited items as as follows:

Related Functions

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

DataSheetGetCellAttributes — Returns an array of attributes for 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.