Absolute Command 

Declaration:

PROCEDURE   Absolute
;

Description:

Procedure Absolute sets the point designation method for VectorScript procedure calls. When the mode is set to Absolute, all points specified in procedure calls are assumed to be coordinate locations within the document.


Example:

Absolute;
ClosePoly;
Poly(0,0,1,1,1,2,2,2,2,0);



  AngleVar Command 

Declaration:

PROCEDURE   AngleVar
;

Description:

Procedure AngleVar sets the angle designation method in VectorScript. A call to AngleVar will cause VectorScript to treat language symbols which can be interpreted as direction angles (e.g. N,S,NW,SE) as as angles, rather than as variables.

Example:

AngleVar;
LineTo(3",#S);
{the VectorScript symbol 'S' will be treated as a direction angle}



  CallTool Command 

Declaration:

PROCEDURE   CallTool
( toolID:INTEGER ) ;

Description:

Procedure CallTool activates the specified VectorWorks tool for a single use. After the tool has been used VectorWorks will revert back to the previously active tool.

Please refer to the VectorScript Appendix for specific tool ID values.

Parameters:

toolID VectorWorks tool constant.

Example:

PushAttrs;
PenFore(16);
PenBack(0);
PenPat(-2);
CallTool(-201);
PopAttrs;



  DoMenu Command 

Declaration:

PROCEDURE   DoMenu
(   menuID :INTEGER;
    itemID :INTEGER
) ;

Special Notes:

DoMenu is obsolete as of MiniCAD 5.0

Description:

Obsolete procedure.

Parameters:

menuID Menu ID value.
itemID Item ID value.

See Also:

DoMenuTextByName  



  DoMenuText Command 

Declaration:

PROCEDURE   DoMenuText
( menuItem:STRING ) ;

Special Notes:

DoMenuText is obsolete as of VectorWorks 8.0

Description:

Obsolete procedure.

Parameters:

menuItem Menu item name.

See Also:

DoMenuTextByName  



  DoMenuTextByName Command 

Declaration:

PROCEDURE   DoMenuTextByName
(   subMenu :STRING;
    index :INTEGER
) ;

Description:

Procedure DoMenuTextByName will call any VectorWorks menu command item.

Parameter index specifies the position within a submenu, if the item is part of a VectorWorks menu chunk(such as Standard Views or Projection). When calling menu items that are not part of a chunk, pass 0 as this parameter.

DoMenuTextByName uses the internal VectorWorks menu item name to reference the menu command, and calls to this procedure will work on localized (international) versions of VectorWorks without modification.

A table listing DoMenuTextByName values can be found in the VectorScript Appendix.

Parameters:

subMenu Menu item name.
index Menu chunk item position (range of 1 - n).

Example:

DoMenuTextByName('Print',0);
{calls the print dialog}

DoMenuTextByName('Standard Views',8);
{will set the view to right isometric}

DoMenuTextByName('WSRecalculate',0);
{calls the recalculate command for the active worksheet}



  Move Command 

Declaration:

PROCEDURE   Move
(   moveDX :REAL;
    moveDY :REAL
) ;

Description:

Procedure Move sets the position of the graphics pen in the VectorWorks document by moving a specified distance from the current pen location.

Horizontal and vertical offsets from the initial location. The final position of the pen at a point whose coordinates are (x+moveDX, y+moveDY).


Parameters:

move X-Y offset distance.

Example:

Move(6,1);
{ moves the graphics pen 6 units to the right }
{ and 1 unit up from the current position.    }



  MoveTo Command 

Declaration:

PROCEDURE   MoveTo
(   pX :REAL;
    pY :REAL
) ;

Description:

Procedure MoveTo sets the position of the graphics pen in the VectorWorks document using absolute coordinate values. The parameter specifies the X-Y coordinate location where the pen should be moved.

Parameters:

p X-Y coordinate location.

Example:

MoveTo(4,3);
{moves the graphics pen to (4,3)}



  NoAngleVar Command 

Declaration:

PROCEDURE   NoAngleVar
;

Description:

Procedure NoAngleVar sets the angle designation method in VectorScript. A call to NoAngleVar will cause VectorScript to treat language symbols which can be interpreted as direction angles (e.g. N,S,NW,SE) as variables rather than angles.


Example:

NoAngleVar;
LineTo(3",#S);
{the VectorScript symbol 'S' will be treated as a variable}



  PenLoc Command 

Declaration:

PROCEDURE   PenLoc
( VAR  pX :REAL;
  VAR  pY :REAL
) ;

Description:

Procedure PenLoc returns the current coordinate location of the graphics pen.

Example:

PenLoc(theXCoord,theYCoord);



  PopAttrs Command 

Declaration:

PROCEDURE   PopAttrs
;

Description:

Procedure PopAttrs retrieves and restores the attribute, tool, and constraint settings as stored by a call to PushAttrs.

Example:

PushAttrs;
  PenFore(215);
  PenBack(5);
  PenPat(25);
  PenSize(42);
  PenPat(25);
  SetConstrain('q');
  CallTool(-201);
PopAttrs;
{ allows the procedures specified between the calls }
{ to PushAttrs and PopAttrs to temporarily modify   }
{ the attribute defaults of the document.           }



  PushAttrs Command 

Declaration:

PROCEDURE   PushAttrs
;

Description:

Procedure PushAttrs stores current attribute, tool, and constraint settings for later
retrieval/reset as document default settings. After a call to PushAttrs, document settings can be modified as desired.

Example:

PushAttrs;
  PenFore(215);
  PenBack(5);
  PenPat(25);
  PenSize(42);
  PenPat(25);
  SetConstrain('q');
  CallTool(-201);
PopAttrs;
{ allows the procedures specified between the calls }
{ to PushAttrs and PopAttrs to temporarily modify   }
{ the attribute defaults of the document.           }



  Relative Command 

Declaration:

PROCEDURE   Relative
;

Description:

Procedure Relative sets the point designation method for VectorScript procedure calls. When the mode is set to Relative, all points specified in procedure calls are assumed to be X-Y offsets from the current graphics pen location. For example, the point designation (0,2) would move the graphics pen two vertical units away from its present location.


Example:

Relative;
ClosePoly;
Poly(0,0,1,1,1,2,2,2,2,0);



  Run Command 

Declaration:

PROCEDURE   Run
( p:PROCEDURE ) ;

Description:

Procedure Run initiates the execution of a VectorScript command.

The procedure call is always found at the end of a command, and signals the VectorScript interpreter to execute the commands' source code.

The procedure takes a single parameter, which is the name of the VectorScript command as defined at the beginning of the source code listing.

Example:

PROCEDURE ATest;
BEGIN
  Sysbeep;
  Sysbeep;
  Sysbeep;
END;
Run(ATest);



  SetTool Command 

Declaration:

PROCEDURE   SetTool
( theTool:INTEGER ) ;

Description:

Procedure SetTool activates the specified VectorWorks tool for use. The tool remains selected as the active tool after use.

Please refer to the VectorScript Appendix for specific tool ID values.

Parameters:

theTool VectorWorks tool constant.

Example:

SetTool(-203);