Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

DataControlSetCellHighlight Function

Overview

The DataControlSetCellHighlight 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 = DataControlSetCellHighlight ( int id, int row, int column, int index );

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.

index

A zero-based int specifying the predefined highlight color index. If set to zero, the highlight color is removed.

Return Value

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

Remarks

Highlighting adds a cell background color to highlight a cell or row. This does not set the background color for the cell’s properties but, rather, a separate highlight expressed during painting.

Highlight is automatically enabled when this function executes.

The highlight index is from 0 to 15, the 0th entry is ‘no highlight’ color. The default colors are as follows:

DCC_SCH_CLEAR          0    –   (Clear) White

DCC_SCH_YELLOW         1    –   Yellow

DCC_SCH_LIGHT_YELLOW   2    –   Light Yellow

DCC_SCH_GOLD           3    –   Gold

DCC_SCH_FUSHIA         4    –   Fuchsia

DCC_SCH_ROSE           5    –   Rose

DCC_SCH_TAN            6    –   Tan

DCC_SCH_AQUA           7    –   Aqua

DCC_SCH_GREEN          8    –   Green

DCC_SCH_CYAN           9    –   Cyan

DCC_SCH_TURQUOISE     10    –   Turquoise

DCC_SCH_SKY_BLUE      11    –   Sky Blue

DCC_SCH_PALE_BLUE     12    –   Pale Blue

DCC_SCH_LAVENDER      13    –   Lavender

DCC_SCH_GRAY          14    –   Gray

DCC_SCH_SILVER        15    –   Silver

 

Related Functions

Platform Support

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

Legato IDE, Legato Basic