Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

dbSetShapeColorLocked

dbSetShapeColorLocked(
d_shapeId
g_setLocked
)
=> t / nil

Description

Changes the color state of the shape.

If you try to set the color state of a non-colorable shape, it results in an error. It also results in an error if you set the color state of a shape whose color is grayColor because it is inconsistent to lock the coloring of an uncolored shape.

Arguments

d_shapeId

Specifies the shape ID.

To check the shape's colorability use dbIsShapeColoringAllowed.

g_setLocked

Specifies one of the two boolean values: t or nil.

t to change the state to locked and nil to change the state to unlocked.

Value Returned

t

Returns t if the function runs successfully

nil

Returns nil if the function encounters an error during execution

Example

dbSetShapeColorLocked( coloredRect t ) => t
dbGetShapeColor( coloredRect ) => "mask2Color"
dbSetShapeColorLocked( coloredRect nil ) => t
dbGetShapeColor( coloredRect ) => "mask1Color"

Return to top
 ⠀
X