Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EighteenDataView Integration (continued)

DataViewCellSetReadOnly Function

Overview

The DataViewCellSetReadOnly function sets the read-only status for a specified cell.

Syntax/Parameters

Syntax

int = DataViewCellSetReadOnly ( handle object, [int row, int column] | [string address],
                           [boolean mode] );

Parameters

object

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

row and column

An optional pair of int values specifying the row and column of the cell. Or,

address

An optional string that can be used as a cell address as an alternative to specifying the row and column parameters.

mode

An optional boolean value to set the read-only mode, TRUE for read-only, FALSE for normal. The default value is TRUE.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError function to retrieve error information.

Remarks

In Forms View, when a cell is set to read-only the user cannot edit it. In Data View, the user will be given a warning regarding overwrite. For other views based on Data View, the behavior is implementation dependent.

Due to the operational nature of this function, it is slower than other functions. Programmers should avoid constantly setting read-only state unless it is required.

Related Functions

Platform Support

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