Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4i

Application v 5.22a

  

 

Chapter EightData Functions (continued)

DataSheetRowInsert Function

Overview

The DataSheetRowInsert function inserts one or more rows of cells prior to the insert position.

Syntax/Parameters

Syntax

int = DataSheetRowInsert ( handle hSheet, int position, [int count], [boolean populate] );

Parameters

hSheet

A handle to a Data Sheet Object.

position

A zero-based int specifying the row prior to which the new rows will be inserted.

count

An optional int specifying the number of rows to insert. The default value is 1 row.

populate

An optional boolean value, when set to TRUE, populates all the cell positions in the matrix with clear cell records. If not set or set to FALSE, the matrix positions will be created without cell records.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure.

Remarks

The DataSheetRowInsert function inserts the empty row(s) of cells prior to the specified position. The insert action affects the position of the rows after the inserted row(s), effectively moving them “down”.

When matrix positions are created without cells, they behave as if the cells have no data and with the default presentation style. The advantage to not creating cells (if they are empty), is that memory usage will be significantly reduced.

If transaction tracking is on, an edit action must be open to use this function.

Related Functions

Platform Support

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

Legato IDE, Legato Basic