Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EighteenDataView Integration (continued)

DataViewIsRegionEmpty Function

Overview

The DataViewIsRegionEmpty function tests if a region contains data.

Syntax/Parameters

Syntax

boolean = DataViewIsRegionEmpty ( handle object, int start_row, int start_column,
                                            [int end_row,   int end_column] );

Parameters

object

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

start_row  start_column

Two int values specifying the zero-based index of the start of the area by row and column to test. This is the upper left position in the sheet matrix.

end_row  end_column

Two optional int values specifying the zero-based index of the end of the area by row and column to test. This is the lower right position in the sheet matrix. If omitted, end the of the rows or columns will be used. For force a default condition, -1 can be used.

Return Value

Returns TRUE if the area is empty or FALSE if it is not. Use the GetLastError function to retrieve error information.

The row and column end points are inclusive. Therefore, 3:3 by 4:4 expresses a matrix of 2 x 2 cells.

Remarks

A cell is considered empty even if it contains spaces.

Related Functions

Platform Support

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