Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

ApplyTintToColor Function

Overview

The ApplyTintToColor function applies a tint percentage to a color.

Syntax/Parameters

Syntax

string = ApplyTintToColor ( string color, int tint );

Parameters

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.

tint

An int specifying a percentage (0-100) to tint the color.

Return Value

Returns a string containing the in the same format as the incoming color or empty on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The function will attempt to match resulting color format to the input color format. Obviously, if a web color name is used, it is not likely that a web color will be the result.

If a named color does not exist or the color contains a syntax error, an empty string and error will be returned.

Related Functions

Platform Support

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

Legato IDE, Legato Basic