Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4i

Application v 5.22a

  

 

Chapter EightData Functions (continued)

DataSheetIsCellMerged Function

Overview

The DataSheetIsCellMerged function tests to see if a specific cell is within a merged region.

Syntax/Parameters

Syntax

boolean = DataSheetIsCellMerged ( handle hSheet, int row, int column );

boolean = DataSheetIsCellMerged ( handle hSheet, string row, string column );

boolean = DataSheetIsCellMerged ( 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 TRUE if the cell is merged or FALSE if it is not merged or on failure. Use the GetLastError function to retrieve error information.

If the cell position is the origin position (top left most), the last error value will contain the row and column span values as the hi word and lo word respectively. Use the GetHighWord or GetLowWord functions to retrieve the respective values.

Remarks

The origin cell is the top left cell of a merged region. This cell will contain the call information for the entire region. Other cells in the region theoretically do not exist since they are merged over. Such cells are always to the right or below the cell that contains the merged content. Since any cell can be accessed by row and column, it is possible to access cells that do not exist by virtue of being merged over.

Related Functions

Platform Support

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

Legato IDE, Legato Basic