  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
DataControlSetLegendColor Function
Overview
The DataControlSetLegendColor function sets or resets the select color scheme for the legends.
Syntax/Parameters
Syntax
int = DataControlSetLegendColor ( int id );
int = DataControlSetLegendColor ( int id, color background, [color text], [color highlight] );
Parameters
id
An int containing the control ID of the data control.
background
An optional color (string or dword) value. If not provided, the colors are reset to the default theme colors. If provided, the value serves as the background color. See Remarks below.
text
An optional text color (string or dword) value. If not provided, the default text color is used. See Remarks below.
highlight
An optional highlight background color (string or dword) value. If not provided, the active color is used. See Remarks below.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure.
Remarks
If colors are not specified, the select colors are reset to the default values.
Color values can be specified as a string in the form of CSS legal values or as a dword for RGB values. See Section 5.22.5 Color Functions for additional information on colors.
Legend colors must be set after the legends are created. Since the default state of a data control is to not have legends, setting the colors must be the last step in control setup. First set the columns and then the rows, as desired, then the colors.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| 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.