Procedure UserColorDelete(color\_name)

UserColorDelete

With the procedure UserColorDelete you can programmatically delete a color from the set of user colors.

UserColorDelete(
     color_name            ! (input) scalar string expression
     )

Arguments

color_name

A string expression holding the name of the user color to delete.

Return Value

The procedure returns 1 if the color could be deleted successfully, or 0 if the color does not exist, or is contained in the fixed set of project colors.

Note

You can only delete user colors that have been added using the procedure UserColorAdd. Colors added through the Tools-User Colors dialog box are fixed and cannot be deleted or modified.

See also

UserColorAdd, UserColorGetRGB, UserColorModify. User colors are discussed in full detail in Setting colors within the model.