Skip to content

SetColorName.md

Latest commit

 

History

History
59 lines (48 loc) · 1.15 KB

SetColorName.md

File metadata and controls

59 lines (48 loc) · 1.15 KB
Raw

SetColorName

Description

Sets the color name of the specified color index.

FUNCTION SetColorName(
				ColorIndex : INTEGER;
				ColorName  : STRING): BOOLEAN;
def vs.SetColorName(ColorIndex, ColorName):
    return BOOLEAN

Parameters

Name Type Description
ColorIndex INTEGER The index of the color to be named.
ColorName STRING The new name of the color specified by the index.

Examples

BEGIN
	bFlipTexture := SetColorName (ColorChoiceNdx,NewColorNameString);
	bNameChanged := FALSE;
END;

	blue:=65535;
END;
RGBToColorIndexN(red, blue, green, gelIndex, TRUE);
IF GetColorName(gelIndex) <> colorList[i].colorSort THEN BEGIN
	boo:=SetColorName(gelIndex, colorList[i].colorSort);
END;
import vs

# Sets the color name of the specified color index.
ColorIndex = 1
ColorName = 'Example'

ok = vs.SetColorName(ColorIndex, ColorName)
if ok:
    vs.Message('SetColorName succeeded')
else:
    vs.Message('SetColorName failed')

See Also

VS Functions: GetColorName

Version

Availability: from Vectorworks 2011

Category