GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

MakeRGBColor Function

Overview

The MakeRGBColor function creates a binary RGB value from a series of colors or a string representing colors.

Syntax/Parameters

Syntax

dword = MakeRGBColor ( byte red, byte green, byte blue );

dword = MakeRGBColor ( string color );

Parameters

red, green, blue

An int containing a color from 0-255. A color specification for red, green, and blue must be supplied in this order.

color

A string containing the color as either hexadecimal, decimal or as a web name. If hexadecimal, the string can be lead with the hex value or an optional ‘#’ character (like HTML colors). The value can be long or shorthand, e.g., #rgb or #rrggbb. If decimal. the value must be enclosed in the CSS “RGB(r, g, b)” format.

Return Value

Returns a dword containing the 24-bit color or RGB_DEFAULT (0xFF000000) on failure. Use the GetLastError function to retrieve error information.

Remarks

MakeRGBColor provides more options than the simple ColorToRGB function.

The MakeRGBColor function assumes that the order of the red, green, and blue color components is correct. Invalid parameters and other syntax errors will cause the function to return RGB_DEFAULT.

Related Functions

ColorToRGB — Makes a color string into an RGB dword.

GetRedValue — Gets the red byte from RGB value (dword) or string.

GetGreenValue — Gets the green byte from RGB value (dword) or string.

GetBlueValue — Gets the blue byte from RGB value (dword) or string.

IsDefaultColor — Tests for the value being RGB_DEFAULT for auto or transparent values.

RGBToColor — Makes an RGB value into a color string.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 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.