VS:IsUserColor

From Vectorworks Developer
Revision as of 21:56, 27 April 2008 by Root (talk | contribs) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Returns True if the color is a user color.

FUNCTION IsUserColor(
ColorIDX :INTEGER;
VAR ColorName :DYNARRAY[] of CHAR) : BOOLEAN;
def vs.IsUserColor(ColorIDX):
    return (BOOLEAN, ColorName)

Parameters

ColorIDX INTEGER
ColorName DYNARRAY[] of CHAR

Remarks

ColorName returns the name of the color associated with the ColorIDX

Example

VectorScript

PROCEDURE PaintTagWorking;
VAR
obHd : HANDLE;
x, y : REAL;
colorIDX :INTEGER;
colorName : DYNARRAY[] of CHAR;
ok : BOOLEAN;
red, green, blue : LONGINT;

BEGIN
obHd := LSActLayer;
Allocate ColorName[1..32767];
WHILE NOT(obHd=NIL) DO BEGIN
GetFillBack(obHd, red, green, blue);
RGBToColorIndex(red, green, blue, colorIDX);
ok := IsUserColor(colorIDX, colorName);
IF ok THEN BEGIN
HCenter(obHd, x, y);
TextOrigin(x, y);
CreateText(colorName);
END;
obHd := PrevSObj(obHd);
END;
END;
RUN(PaintTagWorking);

Python


Version

Availability: from VectorWorks13.0