Overview | Symbol List

Query/Modify Color Settings

Synopsis

&TYPCLR(TYPE,number[,SUBTYP,number][,PROP,number][,IFERR,label:])

Description

Queries or modifies the color preference for a specific object type, subtype, and/or property. The following is a list of valid values for color.

Characteristics

Read/Write - number - [-1..216]

Constant Values

-1 = &NOPAR
0 = &DFAULT
1 = &BLUE
2 = &GREEN
3 = &CYAN
4 = &RED
5 = &MAGENT
6 = &YELLOW
7 = &WHITE
8 = &OLIVE
9 = &PINK
10 = &BROWN
11 = &ORANGE
12 = &PURPLE
13 = &DKRED
14 = &AQUAMR
15 = &GRAY

The following general rules apply to &TYPCLR, &TYPFNT, and &TYPWID.

• If you attempt to query or modify an invalid "type[,subtype][,property]" combination, then the system issues a non-fatal execution error.

• All types, except type 70, have the property zero (0). Thus, the property is currently extraneous information except for type 70.

• If you attempt to query or modify a valid type that individually supports subtypes or properties, then you must provide a valid subtype or property, respectively, or else the system issues a non-fatal execution error.

• If you attempt to query a valid "type[,subtype][,property]" combination that does not have a setting for either color, line font, or line width, then the system returns a negative one (-1) (&NOPAR).

• If you attempt to modify a valid "type[,subtype][,property]" combination that does not have a setting for either color, line font, or line width, then the system issues a non-fatal execution error if the value is not negative one (-1) (&NOPAR).

• If you attempt to set the default preference settings to &DFAULT, then the system issues a non-fatal execution error.

• If you attempt to set the individual preference settings for drafting types to &DFAULT, a non-fatal execution error results.

• The color/font/width EDAs, when used with object type 26 (dimension), set the colors for all dimension objects (extension lines, arrow lines, arrow heads, text, etc.). The color/font/width EDAs also apply to leader lines for the following drafting objects (type 25): labels, id symbols, and GD&T symbols. The values returned from using the GPA's to read the current settings for type 26 are eqivalent to the Preferences->Drafting Object color/font/width settings for Type->Dimension (the default is Type->GD&T when first selected). The EDA's do not read the values from the Preferences->Dimension Line color/font/width screen.

• The following GPA Constants can facilitate readable source code:

Symbol	Value	Description
&NOPAR	-1	No change or no setting for this preference.
&DFAULT	0	The default color, line font, and density.
&TYPSOL	1	property for type 70 solid bodies.
&TYPSHT	2	property for type 70 sheet bodies.

Please see list, Object Types and subtypes. Not all type and subtype combinations are supported. Not all type and subtype combinations have their own unique setting. That is, setting one type subtype combination may affect another type subtype combination. Note that type 70 does not support subtypes, but it does support the following properties:

Parameters

Parameter	Description
TYPE	Minor word which indicates the object type number is to follow
number	The object type number. Please see list, Object Types and subtypes. This command does not support object type 10 (patterns).
SUBTYP	Minor word which indicates the object's subtype number is to follow.
number	The object's subtype number. Please see list, Object Types and subtypes.
PROP	Minor word which indicates that the property is to follow.
number	The object's property number. Type Subtype Property Name 70 &NOPAR 1 Solid Body 70 &NOPAR 2 Sheet Body
IFERR,label:	Specifies a label to which program execution jumps if an error occurs. Type Subtype Property Can set typwid and typfnt Description 2 -- -- -- Point 3 -- -- Yes Line 5 -- -- Yes Arc 6 -- -- Yes Conic 9 -- -- Yes Spline 25 1 -- -- Note 25 2 -- -- Label 25 3 -- Yes ID Symbol 25 4 -- Yes GD&T Symbol 25 5 -- -- Centerline (pre V10) 25 6 -- -- Cross Hatching 25 7 -- Yes Assorted Parts 25 8 -- Yes Intersection 25 9 -- Yes Target Point 25 10 -- Yes Stand-alone User defined symbol 25 11 -- -- Area fill 25 12 -- -- Solid Fill 25 13 -- -- Linear Centerline 25 14 -- -- Full Circle Centerline 25 15 -- -- Partial circle Centerline 25 16 -- -- Full bolt Circle 25 17 -- -- Partial bolt circle 25 18 -- -- Offset centerpoint 25 19 -- -- Cylindrical centerline 25 20 -- -- Symmetrical centerline 26 -- -- Yes Dimension 26 1 -- Yes Horizontal 26 2 -- Yes Vertical 26 3 -- Yes Parallel 26 4 -- Yes Cylindrical 26 5 -- Yes Perpendicular 26 6 -- Yes Angular (minor) 26 7 -- Yes Angular (major) 26 8 -- Yes Arc length 26 9 -- Yes Radius 26 10 -- Yes Diameter 26 11 -- Yes Hole 26 12 -- Yes Concentric circles 26 13 -- Yes Ordinate - horizontal 26 14 -- Yes Ordinate - vertical 26 15 -- Yes Assorted parts converted from UG1 26 16 -- Yes Folded radius 26 17 -- Yes Chain dimensions 26 18 -- Yes Ordinate origin 45 -- -- -- Coordinate system 46 -- -- -- Plane 70 -- 1 Yes Solid body 70 -- 2 Yes Sheet body 196 -- -- -- Datum axis 197 -- -- -- Datum plane