ActSymDef Objects - Symbols 

Declaration:

FUNCTION   ActSymDef
:HANDLE ;

Description:

Function ActSymDef returns a handle to the currently active symbol.

Example:

HandleToActiveSym:=ActSymDef;

See Also:

ActLayer   ActiveClass  



  BeginFolder Objects - Symbols 

Declaration:

PROCEDURE   BeginFolder
;

Description:

Procedure BeginFolder creates a new symbol folder in a VectorWorks document. Any symbols or symbol folders created after the current call to BeginFolder will be nested inside the new symbol folder. A call to EndFolder will complete the creation of the symbol folder, which is then generated in the VectorWorks document.

To name the new symbol folder, precede BeginFolder with a call to NameObject.

Example:

NameObject('Object Symbols');
BeginFolder;
  BeginSym('Oval Symbols');
    PenSize(14);
    PenPat(2);
    FillPat(1);
    FillFore(0,0,0);
    FillBack(65535,65535,65535);
    PenFore(0,0,0);
    PenBack(65535,65535,65535);
    Oval(-1/4",1/4",3/4",-3/4");
  EndSym;
EndFolder;
{creates the symbol folder 'Object Symbols', which contains a symbol}



  BeginSym Objects - Symbols 

Declaration:

PROCEDURE   BeginSym
( symbolName:STRING ) ;

Description:

Procedure BeginSym creates a new symbol definition ina VectorWorks document.

Any objects created after a call to BeginSym will be included in the symbol definition. A call to EndSym will complete the creation of the symbol, which is then generated in the VectorWorks document.

Parameters:

symbolName Name of the new symbol.

Example:

BeginSym('Window');
  Rect(-5'-11",-1",-2'-0",-5'-11");
  Rect(-5'-8 3/4",-2 1/4",-2'-2 1/4",-2'-10");
  Rect(-5'-8 3/4",-3'-1 3/4",-2'-2 1/4",-5'-9");
  Rect(-4'-7",-2'-7 3/4",-3'-3 1/2",-2'-9 1/2");
  MoveTo(-5'-11",-3'-0");
  LineTo(-2'-0",-3'-0");
EndSym;



  CopySymbol Objects - Symbols 

Declaration:

FUNCTION   CopySymbol
(   filePath :STRING;
    symbol :STRING
) :BOOLEAN ;

Description:

Procedure CopySymbol will copy a symbol into the active document from a user specified source document.

Parameters:

filePath File path to document.
symbol Name of symbol to import.

Result:

Returns a BOOLEAN value indicating the success or failure of the import operation.

Example:

wasFound:=CopySymbol('D:\\VectorWorks\Symbol_lib\Lib1',theSymbol);



  EndFolder Objects - Symbols 

Declaration:

PROCEDURE   EndFolder
;

Description:

Procedure EndFolder completes symbol folder creation in VectorScript. When EndFolder is called, the any procedure calls defined since a call to BeginFolder are used to create symbols and/or symbol folders.



  EndSym Objects - Symbols 

Declaration:

PROCEDURE   EndSym
;

Description:

Procedure EndSym completes symbol creation in VectorScript. When EndSym is called, the any procedure calls defined since a call to BeginSym are used to create the symbol.




  GetSDName Objects - Symbols 

Declaration:

FUNCTION   GetSDName
( h:HANDLE ) :STRING ;

Description:

Function GetSDName returns the name of the referenced symbol definition.

Parameters:

h Handle to symbol definition.



  GetSymbolOptions Objects - Symbols 

Declaration:

PROCEDURE   GetSymbolOptions
(   name :STRING;
  VAR  insertMode :INTEGER;
  VAR  breakMode :INTEGER
) ;

Description:

Procedure GetSymbolOptions returns the insert and break options for the specified symbol.

Table - Symbol Insertion Options

Insertion Mode Description Constant Value
Insert on Center Line 0
Insert on Edge 1
Break Mode Description Constant Value
Full Break with Caps 1
Full Break No Caps 3
Half Break 4
No Break 4

Parameters:

name Name of symbol.
insertMode Returns insertion mode of symbol.
breakMode Returns break mode of inserted symbol.



  GetSymBrightMult Objects - Symbols 

Declaration:

FUNCTION   GetSymBrightMult
( symbol:HANDLE ) :INTEGER ;

Description:

Function GetSymBrightMult returns the brightness multiplier of the referenced symbol.

The brightness multiplier is used for symbols that contains lights. This value is a percentage of the symbol definition's light brightness.

Parameters:

symbol Handle to symbol.



  GetSymName Objects - Symbols 

Declaration:

FUNCTION   GetSymName
( symHd:HANDLE ) :STRING ;

Description:

Function GetSymName returns the symbol name of a referenced symbol in a VectorWorks document.

Parameters:

symHd Handle to placed symbol.

Example:





  SetActSymbol Objects - Symbols 

Declaration:

PROCEDURE   SetActSymbol
( name:STRING ) ;

Description:

Procedure SetActSymbol sets the active symbol for a VectorWorks document. Parameter

Parameters:

name Name of symbol.

Example:





  SetSymbolOptions Objects - Symbols 

Declaration:

PROCEDURE   SetSymbolOptions
(   name :STRING;
    insertMode :INTEGER;
    breakMode :INTEGER
) ;

Description:

Procedure SetSymbolOptions sets the insert and break options for the specified symbol.

Table - Symbol Insertion Options

Insertion Mode Description Constant Value
Insert on Center Line 0
Insert on Edge 1
Break Mode Description Constant Value
Full Break with Caps 1
Full Break No Caps 3
Half Break 4
No Break 4

Parameters:

name Name of symbol.
insertMode Insertion mode of symbol.
breakMode Break mode for inserted symbol.



  SetSymBrightMult Objects - Symbols 

Declaration:

PROCEDURE   SetSymBrightMult
(   symbol :HANDLE;
    brightnessMultiplier :INTEGER
) ;

Description:

Function SetSymBrightMult sets the brightness multiplier for the referenced symbol.

The brightness multiplier is used for symbols that contains lights. This value is a percentage of the symbol definition's light brightness.

Parameters:

symbol Handle to symbol.
brightnessMultiplier Brightness multiplier for symbol.



  Symbol Objects - Symbols 

Declaration:

PROCEDURE   Symbol
(   symbolName :STRING;
    pX :REAL;
    pY :REAL;
    rotationAngle :REAL
) ;

Description:

Procedure Symbol places a symbol in the document at the specified coordinate location.

Parameters:

symbolName Name of symbol.
p Coordinates of symbol insertion point.
rotationAngle Rotation angle of symbol.



  SymDefNum Objects - Symbols 

Declaration:

FUNCTION   SymDefNum
:INTEGER ;

Description:

Function SymDefNum returns the number of symbol definitions within the active document.

Example: