Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

DataControlSetCellState Function

Overview

The DataControlSetCellState function sets the edit state of a cell.

Syntax/Parameters

Syntax

int = DataControlSetCellState ( int id, int row, int column, [int state] );

Parameters

id

An int containing the control ID of the data control.

row

A zero-based int specifying the row for the cell.

column

A zero-based int specifying the column for the cell.

state

An optional int specifying the state of the cell. The acceptable values are TRUE to enable the cell, FALSE to disable the cell and -1 to hide the cell. The default value is TRUE.

Return Value

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

Remarks

Changes to the cell’s state effects whether the cell can be clicked on, edited or displayed. The default state when data is added to a Data Control is ‘enabled’.

When a cell is disabled or hidden, the user cannot click on the cell. Also, unprocessed click notifications are passed to the action procedure for disabled or hidden cells.

Related Functions

Platform Support

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

Legato IDE, Legato Basic