Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

DataControlSetCellAttributes Function

Overview

The DataControlSetCellAttributes function sets a background highlight color for a cell or a row. If highlighting is not enabled, it is automatically turned on.

Syntax/Parameters

Syntax

int = DataControlSetCellAttributes ( int id, int row, int column,
                                      string data [], [boolean supplement] );

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. If the value is -1, the row will be highlighted.

data

A string array containing the attribute fields to update. The field key names must match items defined below.

supplement

An optional boolean value specifying whether to supplement existing data.

Return Value

Returns ERROR_NONE or a formatted error code failure. Use the GetLastError and GetLastErrorMessage function to retrieve error information.

Remarks

The following key names can be used:

  Element Key Name   Description  
  FieldTypeData   Extended field data for non-text style cells.  
  NativeData   Native data for non-text style cells. For example, the text of a radio style button.  
  Name   The name of the cell.  
  Description   The description of the cell.  
  Tip   An optional popup tip. Tips are only displayed if the host view supports tooltip popups.  
  Comment   A general comment.  
  Review   A review note.  
  PrivateA   General caller private data.  
  PrivateB   General caller private data.  
  Events   Script Events.  

 

Related Functions

Platform Support

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

Legato IDE, Legato Basic