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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

RGBToColor Function

Overview

The RGBToColor function creates a color string from a binary RGB value as a dword or as a series of colors.

Syntax/Parameters

Syntax

string = RGBToColor ( byte red, byte green, byte blue, [int mode] );

string = RGBToColor ( dword rgb, [int mode] );

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.

rgb

A dword representing a 24-bit RGB value.

mode

An int specifying a default color string mode. The default value is RGB_COLOR_TO_HEX.

Return Value

Returns a string containing the color value or empty on failure. Use the GetLastError function to retrieve error information.

Remarks

Only 24-bit color results are supported. The format of the resulting string is determined by the mode parameter;

	Definition		Ordinal		Description
	RGB_COLOR_TO_HEX		0		Color as #RRGGBB
	RGB_COLOR_TO_HEX_TRANSPARENT		1		Color as #RRGGBB allow "transparent"
	RGB_COLOR_TO_DECIMAL		2		Color as rgb(rr,gg,bb)
	RGB_COLOR_TO_NAME		3		Color as name, falls back to #RRGGBB

 

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.

MakeRGBColor — Makes an RGB value from a color name, RGB string or 8-bit ‘r g b’ values.

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.