Creating Custom ID Label Symbols

The Vectorworks Architect and Landmark ID labels are created as plug-in objects that draw an ID symbol and an optional leader line. The symbols can automatically be kept horizontal, or can be rotated to the leader line angle.

It is possible to create ID symbols based on custom markers. ID symbols have certain requirements that must be met.

The ID Label tool (see Using the ID Label Tool ) detects the presence of any existing record information for the object being labeled in the drawing; if the tool cannot detect record information, you are prompted to select the appropriate record from a list. The ID symbols defined to work with that record type display for selection.

The ID Label tool determines whether the ID symbol requested in the dialog box is present in the drawing. If not, it copies it in from the ID_Symbols.vwx file, and scales it to the current drawing layer scale. Once an appropriate scaled symbol is created, it is used without further reference to external documents.

● Stored in the Vectorworks library file [Vectorworks]\Plug-Ins\Common\Data\ID_Symbols.vwx

The TagSchema Record

The TagSchema record determines the behavior of the ID symbol text. This record is present in the ID_Symbols.vwx file.

The AutoIncrement, FixCurrRecord, WriteMatchIDs, DrawLeader, and KeepHoriz fields are Boolean (true/false) values; ShoulderLength and MkrScaleFactor are numerical values. All other fields are text values.

The ID record writing options are controlled by four fields in the TagSchema record:

Parameter	Description
AutoIncrement	The value in this field controls the default setting for whether the ID number is automatically incremented between placements
FixCurrRecord	The value in this field controls whether the contents of the current record are rewritten to match earlier IDs with the same ID entry
WriteMatchIDs	The value in this field controls the writing of matching ID fields to records with identical contents in the MatchField text field
MatchField	Provides a record field for writing the ID for matching

ID Symbol Leader Options

Four TagSchema record fields determine whether the ID symbol is drawn with a leader, and, if so, determine the leader’s appearance.

Parameter	Description
DrawLeader	If DrawLeader is false, no leader is drawn with the ID Leader object; otherwise, a leader is drawn between the ID symbol and the object to which the ID is referring. This field sets the default for the draw leader parameter in the ID Leader object, which can be changed later.
KeepHoriz	If KeepHoriz is false, the ID symbol is drawn rotated to the leader angle; otherwise, the symbol is rotated horizontally, with a small “shoulder” line segment which is controlled using the value in the ShoulderLength field. These fields set the defaults for the KeepHoriz value and the ShoulderLength value of the ID Leader object, respectively. IDs with no leader should normally set KeepHoriz to true.
ArrowStyle	This field, along with MkrScaleFactor, controls the appearance of the marker at the end of the leader (if any)
MkrScaleFactor	This field, along with ArrowStyle, controls the appearance of the marker at the end of the leader (if any); this setting is a multiplier on a marker size of approximately 1/4”. For example, a MkrScaleFactor setting of 0.5 results in a marker of 1/8” standard size.

Defining ID Symbol Custom Fields

The ID symbol can have up to seven fields containing virtually any text, combined with the contents of the data record the ID uses.

For example, the ID Label tool reads the contents of the Fld1Spec field and writes the results to the Fld1Text field. The “Spec” field follows the format FieldName& “string constant” where the field names are fields in the data record named in the TagType field; the & indicates a concatenation, and the string constants are surrounded by double quotes.

For example, a field in the data record is called “Count.” This is a number field representing the total number of something. You want the first field in the ID to read: TOTAL: 12 when “Count” is 12. Enter the following formula in the Tag1Spec field: “TOTAL: ”&Count. There are no spaces between the ampersand and the field name, or between the string constant (in quotes) and the ampersand.

You can concatenate any number of fields and constants. For example, you could add the word “Item” to the tag field definition by using the following formula: “TOTAL: ”&Count& “ Item”.

There are a variety of pre-defined fields in the ID symbols that come with the Vectorworks Architect and Landmark products. Use these as a guideline in understanding this special formula language. This same formula convention is also used to define HVAC object tags.

Error Messages in ID Fields

If the ID Label tool cannot find the data record specified in the TagType field of the TagSchema record, the error message #RECORDNAME?# displays when the ID is placed. If any of the fields in the formula are misnamed, the message #FIELDNAME?# displays in the affected ID field. Verify the spelling of record and field names.

The TagType “Styled Wall” is reserved for use when an ID is placed on a styled wall.

Creating the Custom ID Symbol

Keeping in mind the information described in ID Symbol Requirements, create the custom ID symbol to be used by the ID Label tool.

An ID symbol can consist of any 2D object supported in the Vectorworks program except circles, arcs, grouped objects, or other symbols. These guidelines are necessary for the scaling algorithm currently used by the ID Label tool, to scale the symbol to the correct scale for the file. To achieve the look of an arc in the symbol, use an arc-smoothed vertex of a polyline; use an oval instead of a circle.