SetFillBack.md

SetFillBack

Description

Procedure SetFillBack sets the fill background color setting of the specified object. RGB values are in the range of 0~65535.

PROCEDURE SetFillBack(
				h     : HANDLE;
				color : LONGINT);

def vs.SetFillBack(h, color):
    return None

Parameters

Name	Type	Description
h	HANDLE	Handle to object.
color	LONGINT	RGB color value.

Remarks

[[User:CBM-c-|c]]: This Procedure will also accept a single INTEGER Color Palette Index value in lieu of three LONGINT RGB values for the COLOR parameter. The Color index can be obtained with [[VS:RGBToColorIndex]]. See remarks under [[VS:SetPenFore]] for more infos. On Vectorlab there is a list of all color routines accepting multiple variable type, see: [http://www.vectorlab.info/index.php?title=Index_pitfalls#Colors Color Index]. ; Warning: SetFillBack, SetFillFore will remove the "ByClass" attribute of the PEN as well. Remember to parse for it and restore it.

Examples

==== VectorScript ====

{ Sets the Fill Background to black }
SetFillBack(h, 0, 0, 0); { using rgb values }
SetFillBack(h, 255); { using color index, be careful with color indexes after VW12 }
{ Conversely, GetFillBack will only return RGB values. }

==== Python ====

vs.SetFillBack( h, (0, 0, 0) ) # using rgb values in a tuple
vs.SetFillBack( h, (65535, 0, 0) ) # red color - note that the values are 32-bit
vs.SetFillBack( h, (0xFFFF, 0, 0) ) # red color - or you can use hex numbers in python
vs.SetFillBack( h, 255 ) # using color index, be careful with color indexes after VW12

See Also

VS Functions: RGBToColorIndex | ColorIndexToRGB

Version

Availability: from All Versions

Category

• Object Attributes