BeginMultipleDuplicate Object Editing 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   BeginMultipleDuplicate
;

Python:

def  vs.BeginMultipleDuplicate():
   return None

Description:

Use this function in conjunction with EndMultipleDuplicate to preserve constraints on multiple duplicated objects.

See Also:

EndMultipleDuplicate  



  CreateDuplicateObject Object Editing 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   CreateDuplicateObject
(   objectToDuplicate :HANDLE;
    containerHandle :HANDLE
) :HANDLE ;

Python:

def  vs.CreateDuplicateObject(objectToDuplicate, containerHandle):
   return HANDLE

Description:

Duplicates the specified object and inserts the new object into the container. If container is nil, the new object will be inserted in the active container.

Parameters:

objectToDuplicate The object to be duplicated
containerHandle The container to the newly duplicated object



  DeleteObjs Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   DeleteObjs
;

Python:

def  vs.DeleteObjs():
   return None

Description:

Procedure DeleteObjs deletes all selected objects on the active layer. Using this procedure when the layer display mode is Show/Snap/Modify will cause selected objects on any visible layer will be deleted.

Example:

DSelectAll;
SelectObj(((T=Locus) & (NOT V)));
DeleteObjs;



  DeleteSymbolDefinition Object Editing 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   DeleteSymbolDefinition
(   hSymDef :HANDLE;
    bCompletely :BOOLEAN
) ;

Python:

def  vs.DeleteSymbolDefinition(hSymDef, bCompletely):
   return None

Description:

Procedure DeleteSymbolDefinition deletes the referenced symbol definition from the document. If bCompletely is TRUE, all corresponding symbol instances will be deleted completely; otherwise, the symbol instances will be replaced with loci.

Parameters:

hSymDef Handle to the symbol definition.
bCompletely Determines whether to replace the corresponding symbol instances with loci or delete the instances completely.



  DelObject Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   DelObject
( h:HANDLE ) ;

Python:

def  vs.DelObject(h):
   return None

Description:

Procedure DelObject deletes the referenced object from the document.

Parameters:

h Handle to object.



  Duplicate Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   Duplicate
(   offsetDX :REAL;
    offsetDY :REAL
) ;

Python:

def  vs.Duplicate(offset):
   return None

Description:

Procedure Duplicate copies the currently selected objects and moves them the specified offset distance.

Parameters:

offset Offset value.

Example:

Rect(0,1,1,0);
Duplicate(2,0);
{duplicates the rectangle 2 units right of the original}



  EditObjectSpecial Object Editing 
Vectorworks 2013

VectorScript Declaration:

PROCEDURE   EditObjectSpecial
(   h :HANDLE;
    editMode :INTEGER
) ;

Python:

def  vs.EditObjectSpecial(h, editMode):
   return None

Description:

Edit the specified object.

Parameters:

h The object to edit.
editMode The edit mode: 0-Default; 2-Properties; 3-Reshape; 4-Edit group like;



  EndMultipleDuplicate Object Editing 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   EndMultipleDuplicate
;

Python:

def  vs.EndMultipleDuplicate():
   return None

Description:

Use this function in conjunction with BeginMultipleDuplicate to preserve constraints on duplicated objects.

See Also:

BeginMultipleDuplicate  



  HDuplicate Object Editing 
VectorWorks10.0

VectorScript Declaration:

FUNCTION   HDuplicate
(   objectHandle :HANDLE;
    x :REAL;
    y :REAL
) :HANDLE ;

Python:

def  vs.HDuplicate(objectHandle, x, y):
   return HANDLE

Description:

Duplicates and moves an object by the offsets specified.

Parameters:

objectHandle Handle to the object to duplicate
x X-coordinate of distance object should be shifted from original location
y Y-coordinate of distance object should be shifted from original location

Result:

Returns a handle to the new object.



  HMove Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   HMove
(   h :HANDLE;
    xOffset :REAL;
    yOffset :REAL
) ;

Python:

def  vs.HMove(h, xOffset, yOffset):
   return None

Description:

Procedure HMove moves the referenced object a relative offset distance.

Parameters:

h Handle to object.
xOffset X offset distance.
yOffset Y offset distance.

Example:

HMove(handleToObject,2,2);



  HMoveBackward Object Editing 
VectorWorks8.5

VectorScript Declaration:

PROCEDURE   HMoveBackward
(   h :HANDLE;
    toBack :BOOLEAN
) ;

Python:

def  vs.HMoveBackward(h, toBack):
   return None

Description:

Move the referenced object backward in the object stacking order. If toBack is TRUE, the object will be moved to the back of the stacking order.

Parameters:

h Handle to object.
toBack Move to back of stacking order.



  HMoveForward Object Editing 
VectorWorks8.5

VectorScript Declaration:

PROCEDURE   HMoveForward
(   h :HANDLE;
    toFront :BOOLEAN
) ;

Python:

def  vs.HMoveForward(h, toFront):
   return None

Description:

Move the referenced object forward in the object stacking order. If toFront is TRUE, the object will be moved to the front of the stacking order.

Parameters:

h Handle to object.
toFront Move object to front of stacking order.

Example:

PROCEDURE Example;
BEGIN
	HMoveForward(FSActLayer, FALSE);
END;
RUN(Example);



  HRotate Object Editing 
MiniCAD6.0

VectorScript Declaration:

PROCEDURE   HRotate
(   h :HANDLE;
    centerX :REAL;
    centerY :REAL;
    rotationAngle :REAL
) ;

Python:

def  vs.HRotate(h, center, rotationAngle):
   return None

Description:

Procedure HRotate rotates the referenced object about a coordinate point location. rotationAngle is in degrees.

Parameters:

h Handle to object.
center X-Y coordinates of center point of rotation.
rotationAngle Angle of rotation.

Example:

HRotate(objHd,3,5,60d);



  HScale2D Object Editing 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   HScale2D
(   h :HANDLE;
    centerX :REAL;
    centerY :REAL;
    scaleX :REAL;
    scaleY :REAL;
    scaleText :BOOLEAN
) ;

Python:

def  vs.HScale2D(h, centerX, centerY, scaleX, scaleY, scaleText):
   return None

Description:

Scales a 2D object.



  HScale3D Object Editing 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   HScale3D
(   h :HANDLE;
    centerX :REAL;
    centerY :REAL;
    centerZ :REAL;
    scaleX :REAL;
    scaleY :REAL;
    scaleZ :REAL
) ;

Python:

def  vs.HScale3D(h, centerX, centerY, centerZ, scaleX, scaleY, scaleZ):
   return None

Description:

Scales a 3D object.



  Move3D Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   Move3D
(   xDistance :REAL (Coordinate);
    yDistance :REAL (Coordinate);
    zDistance :REAL (Coordinate)
) ;

Python:

def  vs.Move3D(xDistance, yDistance, zDistance):
   return None

Description:

Procedure Move3D moves the most recently created three-dimensional object a relative distance from it's original location. The object is moved relative to its center.

Parameters:

xDistance X offset distance.
yDistance Y offset distance.
zDistance Z offset ditance.

Example:

BeginXtrd(0',2");
Rect(0",1",1",0");
EndXtrd;
Move3D(3",1",2");



  Move3DObj Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   Move3DObj
(   h :HANDLE;
    xDistance :REAL (Coordinate);
    yDistance :REAL (Coordinate);
    zDistance :REAL (Coordinate)
) ;

Python:

def  vs.Move3DObj(h, xDistance, yDistance, zDistance):
   return None

Description:

Procedure Move3DObj moves the referenced object a specified distance from its current location. Movement distances are calculated from the 3D center of the object.

Parameters:

h Handle to object.
xDistance X offset distance.
yDistance Y offset distance.
zDistance Z offset distance.

Example:

Move3DObj(HandleToObj,2,4,0);



  MoveObjs Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   MoveObjs
(   moveDX :REAL;
    moveDY :REAL;
    allLayers :BOOLEAN;
    allObjects :BOOLEAN
) ;

Python:

def  vs.MoveObjs(move, allLayers, allObjects):
   return None

Description:

Procedure MoveObjs moves object(s) a specified offset distance. The last two parameters, allLayers and allObjects, control which objects are offset by this procedure.

Table - Effect of MoveObjs Parameters

allLayers allObjects Effect
TRUE TRUE Move all objects on all layers
TRUE FALSE Move selected objects on all layers
FALSE TRUE Move all objects on active layer
FALSE FALSE Move selected objects on active layer

Parameters:

move X-Y object offset distance.
allLayers Move objects on all layers option setting.
allObjects Move all objects option setting.

Example:

MoveObjs(3,0,FALSE,FALSE);
{ moves selected objects on active layer 3 units to the right }



  OffsetHandle Object Editing 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   OffsetHandle
(   h :HANDLE;
    offsetDistance :REAL;
    EdgeRestoration :BOOLEAN;
    FilletSharpEdges :BOOLEAN
) :HANDLE ;

Python:

def  vs.OffsetHandle(h, offsetDistance, EdgeRestoration, FilletSharpEdges):
   return HANDLE

Description:

Creates a group of lines which represent the weighted medial axis of given polygon.



  ResetBBox Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   ResetBBox
( h:HANDLE ) ;

Python:

def  vs.ResetBBox(h):
   return None

Description:

Procedure ResetBBox forces the bounding box information for the specified object to be recomputed based on the objects' current geometry.

Call this procedure after modifying an object to force a redraw of the object.

Parameters:

h Handle to object.



  SetBBox Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   SetBBox
(   h :HANDLE;
    p1X :REAL;
    p1Y :REAL;
    p2X :REAL;
    p2Y :REAL
) ;

Python:

def  vs.SetBBox(h, p1, p2):
   return None

Description:

Procedure SetBBox positions objects whose geometry is defined by a bounding box. These objects currently are Image, PICT, Rectangle, Oval, Rounded Rectangle, and Worksheet Container.

Other objects will generate a warning if they are passed to SetBBox.

Parameters:

h Handle to object.
p1 Top left coordinate of bounding box.
p2 Bottom right coordinate of bounding box.



  SetHDef Object Editing 
MiniCAD6.0

VectorScript Declaration:

PROCEDURE   SetHDef
(   oldH :HANDLE;
    newH :HANDLE
) ;

Python:

def  vs.SetHDef(oldH, newH):
   return None

Description:

Procedure SetHDef replaces the definition of the referenced "container" object with a new definition. Supported object types are worksheets, symbol definitions, and layer references.

Parameters:

oldH Handle to object.
newH Handle to new definition.

Example:

SetHDef(symbolHd,newSymDefHd);
{updates the referenced symbol with a new definition}



  SetRRDiam Object Editing 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetRRDiam
(   h :HANDLE;
    xDiam :REAL;
    yDiam :REAL
) ;

Python:

def  vs.SetRRDiam(h, xDiam, yDiam):
   return None

Description:

Sets the diameters of a rounded rectangle.