Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

DataControlInsertString Function

Overview

The DataControlInsertString function inserts a row within a data control. The string can be tab delimited or in comma delimited format.

Syntax/Parameters

Syntax

int = DataControlInsertString ( int id, int row, string data );

Parameters

id

An int containing the control ID of the data control.

row

A zero-based int specifying the row to insert before.

data

A string to add to the data control. The number of columns will automatically be expanded as required.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure, ERROR_RANGE if id is an invalid control ID for the open dialog, or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information.

Remarks

This function is similar to ListBoxInsertItem except it will also accept CSV data. Detection of the data mode is performed by scanning the data parameter for tab characters, finding none, scanning for a comma, and, if found, the mode is set to comma.

The insert function can be used to insert rows for later random-access on a cell by cell basis.

Related Functions

Platform Support

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

Legato IDE, Legato Basic