Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4i

Application v 5.22a

  

 

Chapter EightData Functions (continued)

DataSheetSetCellReadOnly Function

Overview

The DataSheetSetCellReadOnly function sets the read only state of a cell.

Syntax/Parameters

Syntax

int = DataSheetSetCellReadOnly ( handle hSheet, int row, int column,
                            [boolean flag] );

int = DataSheetSetCellReadOnly ( handle hSheet, string row, string column,
                            [boolean flag] );

int = DataSheetSetCellReadOnly ( handle hSheet, string address,
                            [boolean flag] );

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”.

flags

An optional boolean specifying to set or reset the read-only state. The default is TRUE, to set the cell as read only.

Return Value

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

Remarks

Setting a cell as read only does not impact any Data Sheet API functions but will affect Data View and Data Control, if connected to the cell.

This function is not transaction tracked.

Related Functions

Platform Support

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

Legato IDE, Legato Basic