  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eighteen — DataView Integration (continued)
DataViewCellSetHighlight Function
Overview
The DataViewCellSetHighlight 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 = DataViewCellSetHighlight ( handle object, [int row, int column,] |
[string
address], int index );
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.
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
To apply highlighting to a row, set the column position to -1.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Page revised 2024-12-13
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.