VCAddTextEntity


Version:

1.2

Description:

Adds a text line entity to the drawing database or to a symbol definition.

Declaration:

 

C/C++

extern "C" void WINAPI VCAddTextEntity(short* iError, short iSymbolIndex, Point2D dpP0);
extern "C" void WINAPI VCAddTextEntityBP(short* iError, short iSymbolIndex, Point2D* dpP0);

Delphi

procedure VCAddTextEntityBP(var iError: Smallint; iSymbolIndex: Smallint; dpP0: Point2D); stdcall;

ActiveX/COM

Sub AddTextEntity(ByVal iSymbolIndex As Integer, dpP0 As IVCPoint2D)

Parameters:

iSymbolIndex - index location for adding the entity.
-1 - NONDEFENTITY (Drawing)
-2 - HATCHFILLENTITY
-0 - Use VCGetSymbolIndex to retrieve the symbol index for creating a symbol definition.
dpP0
- the Point2D structure containing the coordinates to place the text entity.

Notes:

Any text added to the Visual CADD™ drawing database or to a symbol definition will take on the current text properties for font, color, layer, size, spacing, justification, formatting and aspect. The string to be added is set with VCSetTextString prior to placing the text line with VCAddTextEntity. These all need to be set before creating these entities or may be changed after creation with the text edit commands. All point locations including those within a symbol definition are relative to the drawing origin. Each entity added will be appended to the end of the database and take on the entity handle of one higher than the last entity in the drawing before the addition. To add entities to a symbol definition, the index of an existing symbol is retrieved with VCGetSymbolIndex while VCCreateSymbolDef creates an empty definition for a new symbol.

See Also:

VCGetTextString, VCGetSymbolIndex, VCCreateSymbolDef