THEMECBV Function

Returns an RGB value or an integer that represents an index in the document's color palette, where the color (number) passed in as an argument has been modified by the specified tint or shade value stored in the gradient settings of the active theme.

Version Information

Version Added: Visio 2013

Syntax

THEMECBV( color, gradient_stop_number)

Parameters

Name	Required/Optional	Data Type	Description
color	Required	Number	A number representing an index in the document's color palette.
gradient_stop_number	Required	Number	The gradient stop (tint or shade) stored in the gradient settings of the active theme to apply to the color.

Return value

Number

Remarks

Note

The THEMECBV function does nothing to the color passed in as an argument if the QuickStyle that is assigned to the shape does not have a gradient.

The gradient settings in a theme are a series of numbered gradient stops that correspond to a "lightening" (tint) or "darkening" (shade). These shades and tints are applied to a base color to create a gradient color effect.

The THEMECBV function takes a color input and outputs the color after it has been modified by the tint or shade of the specified gradient stop. The tints and shades come from the theme's definition, if the current quick style contains a gradient fill. If the active Quick Style does not specify a gradient fill or the shape is set to No Theme, then this formula simply returns the color that was passed in for the first argument.

Example

THEMECBV(FillForegnd, 5)

Returns the color created by applying the tint or shade in the fifth gradient stop of the gradient to the color specified in the FillForegnd cell.

THEMECBV(RGB(255,0,0), 2)

Returns a shade or tint of red created by applying the second gradient stop to a base color of red.