CreateVPClOvrd Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   CreateVPClOvrd
(   viewportHandle :HANDLE;
    className :STRING
) ;

Python:

def  vs.CreateVPClOvrd(viewportHandle, className):
   return None

Description:

Creates a new override for the specified class in the specified viewport. The override is initially populated with the class's current properties.

Parameters:

viewportHandle The viewport handle.
className The name of the class.

See Also:

RemoveVPClOvrd  



  CreateVPLrOvrd Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   CreateVPLrOvrd
(   viewportHandle :HANDLE;
    layerHandle :HANDLE
) ;

Python:

def  vs.CreateVPLrOvrd(viewportHandle, layerHandle):
   return None

Description:

Creates a new layer override, initially set to the layer's current properties.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer to override.

See Also:

RemoveVPLrOvrd  



  GetVPClOvrdCount Viewports 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetVPClOvrdCount
( viewportHandle:HANDLE ) :INTEGER ;

Python:

def  vs.GetVPClOvrdCount(viewportHandle):
   return INTEGER

Description:

Returns the number of class overrides associated with a particular viewport.

Parameters:

viewportHandle The viewport handle.

Result:

Returns the number of class overrides associated with the given viewport.
If the handle is invalid, returns -1.

See Also:

GetVPClOvrdName  



  GetVPClOvrdFillBack Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetVPClOvrdFillBack
(   viewportHandle :HANDLE;
    className :STRING;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

def  vs.GetVPClOvrdFillBack(viewportHandle, className):
   return (colorRV, colorGV, colorBV)

Description:

Fetches the fill background color of the class override. The color is returned as three RGB components in the range 0~65535.

Parameters:

viewportHandle Handle to the viewport.
className Name of class.
colorRV Returns red color component.
colorGV Returns green color component.
colorBV Returns blue color component.

Result:

True if the viewport has an override for the specified class.
False if it does not have an override or the class or viewport was invalid.

See Also:

SetVPClOvrdFillBack  



  GetVPClOvrdFillFore Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetVPClOvrdFillFore
(   viewportHandle :HANDLE;
    className :STRING;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

def  vs.GetVPClOvrdFillFore(viewportHandle, className):
   return (colorRV, colorGV, colorBV)

Description:

Fetches the fill foreground color of the class override. The color is returned as three RGB components in the range 0~65535.

Parameters:

viewportHandle The viewport handle.
className The name of the class.
colorRV Red color value.
colorGV Green color value.
colorBV Blue color value.

Result:

True if the viewport has an override for the specified class.
False if it does not have an override or the class or viewport was invalid.

See Also:

SetVPClOvrdFillFore  



  GetVPClOvrdFillOpty Viewports 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetVPClOvrdFillOpty
(   viewportHandle :HANDLE;
    className :STRING
) :INTEGER ;

Python:

def  vs.GetVPClOvrdFillOpty(viewportHandle, className):
   return INTEGER

Description:

Retrieves the fill opacity for a viewport class override.

Parameters:

viewportHandle The viewport handle.
className Name of the class.

Result:

Returns the fill opacity of the class override.

See Also:

SetVPClOvrdFillOpty  



  GetVPClOvrdName Viewports 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetVPClOvrdName
(   viewportHandle :HANDLE;
    index :INTEGER
) :STRING ;

Python:

def  vs.GetVPClOvrdName(viewportHandle, index):
   return STRING

Description:

Gets the name for the override at a particular index in the override list.

Parameters:

viewportHandle The viewport handle.
index The index into the class override list.

Result:

Returns the name of the class which is overriden at the specified index.
Returns -1 if the index is out of bounds.

See Also:

GetVPClOvrdCount  



  GetVPClOvrdPenBack Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetVPClOvrdPenBack
(   viewportHandle :HANDLE;
    className :STRING;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

def  vs.GetVPClOvrdPenBack(viewportHandle, className):
   return (colorRV, colorGV, colorBV)

Description:

Fetches the pen background color of the class override. The color is returned as three RGB components in the range 0~65535.

Parameters:

viewportHandle The viewport handle.
className The name of the class.
colorRV Red color value.
colorGV Green color value.
colorBV Blue color value.

Result:

True if the viewport has an override for the specified class.
False if it does not have an override or the class or viewport was invalid.

See Also:

SetVPClOvrdPenBack  



  GetVPClOvrdPenFore Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetVPClOvrdPenFore
(   viewportHandle :HANDLE;
    className :STRING;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

def  vs.GetVPClOvrdPenFore(viewportHandle, className):
   return (colorRV, colorGV, colorBV)

Description:

Fetches the pen foreground color of the class override. The color is returned as three RGB components in the range 0~65535.

Parameters:

viewportHandle The viewport handle.
className The name of the class.
colorRV Red color value.
colorGV Green color value.
colorBV Blue color value.

Result:

True if the viewport has an override for the specified class.
False if it does not have an override or the class or viewport was invalid.

See Also:

SetVPClOvrdPenBack  



  GetVPClOvrdPenOpty Viewports 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetVPClOvrdPenOpty
(   viewportHandle :HANDLE;
    className :STRING
) :INTEGER ;

Python:

def  vs.GetVPClOvrdPenOpty(viewportHandle, className):
   return INTEGER

Description:

Retrieves the pen opacity for a class override. Opacity is in the range 0-100.

Parameters:

viewportHandle The viewport handle.
className Name of the class.

Result:

Returns the pen opacity of the class override.

See Also:

SetVPClOvrdPenOpty  



  GetVPLrOvrdCount Viewports 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetVPLrOvrdCount
( viewportHandle:HANDLE ) :INTEGER ;

Python:

def  vs.GetVPLrOvrdCount(viewportHandle):
   return INTEGER

Description:

Retrieves the number of layer overrides.

Parameters:

viewportHandle The viewport handle.

Result:

Returns the number of layer overrides associated with the specified viewport.
If the handle is invalid, returns -1.

See Also:

GetVPLrOvrdHandle  



  GetVPLrOvrdFillBack Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetVPLrOvrdFillBack
(   viewportHandle :HANDLE;
    layerHandle :HANDLE;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

def  vs.GetVPLrOvrdFillBack(viewportHandle, layerHandle):
   return (colorRV, colorGV, colorBV)

Description:

Gets the fill background color from a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.
colorRV Red value (0-65535)
colorGV Green value (0-65535)
colorBV Blue value (0-65535)

See Also:

SetVPLrOvrdFillBack  



  GetVPLrOvrdFillFore Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetVPLrOvrdFillFore
(   viewportHandle :HANDLE;
    layerHandle :HANDLE;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

def  vs.GetVPLrOvrdFillFore(viewportHandle, layerHandle):
   return (colorRV, colorGV, colorBV)

Description:

Gets the fill foreground color from a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.
colorRV Red value (0-65535)
colorGV Green value (0-65535)
colorBV Blue value (0-65535)

See Also:

SetVPLrOvrdFillFore  



  GetVPLrOvrdHandle Viewports 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetVPLrOvrdHandle
(   viewportHandle :HANDLE;
    index :INTEGER
) :HANDLE ;

Python:

def  vs.GetVPLrOvrdHandle(viewportHandle, index):
   return HANDLE

Description:

Retrieves the handle of the layer overridden at the specified index in the overrides list.

Parameters:

viewportHandle The viewport handle.
index The index into the layer overrides list.

Result:

Returns a handle to the layer overriden at the given index.
Returns 0 if the index is out of range.

See Also:

GetVPLrOvrdCount  



  GetVPLrOvrdOpty Viewports 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetVPLrOvrdOpty
(   viewportHandle :HANDLE;
    layerHandle :HANDLE
) :INTEGER ;

Python:

def  vs.GetVPLrOvrdOpty(viewportHandle, layerHandle):
   return INTEGER

Description:

Gets the opacity for a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.

Result:

Returns the opacity for a layer override (0-100).

See Also:

SetVPLrOvrdOpty  



  GetVPLrOvrdPenBack Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetVPLrOvrdPenBack
(   viewportHandle :HANDLE;
    layerHandle :HANDLE;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

def  vs.GetVPLrOvrdPenBack(viewportHandle, layerHandle):
   return (colorRV, colorGV, colorBV)

Description:

Gets the pen background color from a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.
colorRV Red value (0-65535)
colorGV Green value (0-65535)
colorBV Blue value (0-65535)

See Also:

SetVPLrOvrdPenBack  



  GetVPLrOvrdPenFore Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetVPLrOvrdPenFore
(   viewportHandle :HANDLE;
    layerHandle :HANDLE;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

def  vs.GetVPLrOvrdPenFore(viewportHandle, layerHandle):
   return (colorRV, colorGV, colorBV)

Description:

Gets the pen foreground color from a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.
colorRV Red value (0-65535)
colorGV Green value (0-65535)
colorBV Blue value (0-65535)

See Also:

SetVPLrOvrdPenFore  



  RemoveVPClOvrd Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   RemoveVPClOvrd
(   viewportHandle :HANDLE;
    className :STRING
) ;

Python:

def  vs.RemoveVPClOvrd(viewportHandle, className):
   return None

Description:

Removes a class override from the specified viewport.

Parameters:

viewportHandle The viewport handle.
className The name of the class.

See Also:

CreateVPClOvrd  



  RemoveVPLrOvrd Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   RemoveVPLrOvrd
(   viewportHandle :HANDLE;
    layerHandle :HANDLE
) ;

Python:

def  vs.RemoveVPLrOvrd(viewportHandle, layerHandle):
   return None

Description:

Removes a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.

See Also:

CreateVPLrOvrd  



  SetVPClOvrdFillBack Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPClOvrdFillBack
(   viewportHandle :HANDLE;
    className :STRING;
    colorRV :LONGINT;
    colorGV :LONGINT;
    colorBV :LONGINT
) ;

Python:

def  vs.SetVPClOvrdFillBack(viewportHandle, className, colorRV, colorGV, colorBV):
   return None

Description:

Sets the fill background color of a class override in a viewport. The color is specified by RGB values in the range 0~65535.

Parameters:

viewportHandle The viewport handle.
className The name of the class to override.
colorRV Red color value.
colorGV Green color value.
colorBV Blue color value.

Result:

Returns true if the color override was applied.
Returns false if the class override does not exist or the handle is invalid.

See Also:

GetVPClOvrdFillBack  



  SetVPClOvrdFillFore Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPClOvrdFillFore
(   viewportHandle :HANDLE;
    className :STRING;
    colorRV :LONGINT;
    colorGV :LONGINT;
    colorBV :LONGINT
) ;

Python:

def  vs.SetVPClOvrdFillFore(viewportHandle, className, colorRV, colorGV, colorBV):
   return None

Description:

Sets the fill foreground color of a class override in a viewport. The color is specified by RGB values in the range 0~65535.

Parameters:

viewportHandle The viewport handle.
className The name of the class.
colorRV Red color value.
colorGV Green color value.
colorBV Blue color value.

Result:

Returns true if the color override was applied.
Returns false if the class override does not exist or the handle is invalid.

See Also:

GetVPClOvrdFillFore  



  SetVPClOvrdFillOpty Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPClOvrdFillOpty
(   viewportHandle :HANDLE;
    className :STRING;
    fillOpacity :INTEGER
) ;

Python:

def  vs.SetVPClOvrdFillOpty(viewportHandle, className, fillOpacity):
   return None

Description:

Sets the fill opacity for a viewport class override.

Parameters:

viewportHandle The viewport handle.
className Name of the class.
fillOpacity The fill opacity as a percentage (0-100).

Result:

Returns true if the opacitiy could be set for the viewport override.
Returns false otherwise.



  SetVPClOvrdPenBack Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPClOvrdPenBack
(   viewportHandle :HANDLE;
    className :STRING;
    colorRV :LONGINT;
    colorGV :LONGINT;
    colorBV :LONGINT
) ;

Python:

def  vs.SetVPClOvrdPenBack(viewportHandle, className, colorRV, colorGV, colorBV):
   return None

Description:

Sets the pen background color of a class override in a viewport. The color is specified by RGB values in the range 0~65535.

Parameters:

viewportHandle The viewport handle.
className The name of the class.
colorRV Red color value.
colorGV Green color value.
colorBV Blue color value.

Result:

Returns true if the color override was applied.
Returns false if the class override does not exist or the handle is invalid.

See Also:

GetVPClOvrdPenBack  



  SetVPClOvrdPenFore Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPClOvrdPenFore
(   viewportHandle :HANDLE;
    className :STRING;
    colorRV :LONGINT;
    colorGV :LONGINT;
    colorBV :LONGINT
) ;

Python:

def  vs.SetVPClOvrdPenFore(viewportHandle, className, colorRV, colorGV, colorBV):
   return None

Description:

Sets the pen foreground color of a class override in a viewport. The color is specified by RGB values in the range 0~65535.

Parameters:

viewportHandle The viewport handle.
className The name of the class.
colorRV Red color value.
colorGV Green color value.
colorBV Blue color value.

Result:

Returns true if the color override was applied.
Returns false if the class override does not exist or the handle is invalid.

See Also:

GetVPClOvrdPenBack  



  SetVPClOvrdPenOpty Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPClOvrdPenOpty
(   viewportHandle :HANDLE;
    className :STRING;
    penOpacity :INTEGER
) ;

Python:

def  vs.SetVPClOvrdPenOpty(viewportHandle, className, penOpacity):
   return None

Description:

Sets the pen opacity for a class override.

Parameters:

viewportHandle The viewport handle.
className Name of the class.
penOpacity The pen opacity as a percentage (0-100).

Result:

True if the class override exists.
False otherwise.

See Also:

GetVPClOvrdPenOpty  



  SetVPLrOvrdFillBack Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPLrOvrdFillBack
(   viewportHandle :HANDLE;
    layerHandle :HANDLE;
    colorRV :LONGINT;
    colorGV :LONGINT;
    colorBV :LONGINT
) ;

Python:

def  vs.SetVPLrOvrdFillBack(viewportHandle, layerHandle, colorRV, colorGV, colorBV):
   return None

Description:

Sets the fill background color for a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.
colorRV Red value (0-65535)
colorGV Green value (0-65535)
colorBV Blue value (0-65535)

See Also:

GetVPLrOvrdFillBack  



  SetVPLrOvrdFillFore Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPLrOvrdFillFore
(   viewportHandle :HANDLE;
    layerHandle :HANDLE;
    colorRV :LONGINT;
    colorGV :LONGINT;
    colorBV :LONGINT
) ;

Python:

def  vs.SetVPLrOvrdFillFore(viewportHandle, layerHandle, colorRV, colorGV, colorBV):
   return None

Description:

Sets the fill foreground color for a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.
colorRV Red value (0-65535)
colorGV Green value (0-65535)
colorBV Blue value (0-65535)

See Also:

GetVPLrOvrdFillFore  



  SetVPLrOvrdOpty Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPLrOvrdOpty
(   viewportHandle :HANDLE;
    layerHandle :HANDLE;
    opacity :INTEGER
) ;

Python:

def  vs.SetVPLrOvrdOpty(viewportHandle, layerHandle, opacity):
   return None

Description:

Sets the opacity for a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.
opacity Opacity (0-100)

See Also:

GetVPLrOvrdOpty  



  SetVPLrOvrdPenBack Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPLrOvrdPenBack
(   viewportHandle :HANDLE;
    layerHandle :HANDLE;
    colorRV :LONGINT;
    colorGV :LONGINT;
    colorBV :LONGINT
) ;

Python:

def  vs.SetVPLrOvrdPenBack(viewportHandle, layerHandle, colorRV, colorGV, colorBV):
   return None

Description:

Sets the pen background color for a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.
colorRV Red value (0-65535)
colorGV Green value (0-65535)
colorBV Blue value (0-65535)

See Also:

GetVPLrOvrdPenBack  



  SetVPLrOvrdPenFore Viewports 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetVPLrOvrdPenFore
(   viewportHandle :HANDLE;
    layerHandle :HANDLE;
    colorRV :LONGINT;
    colorGV :LONGINT;
    colorBV :LONGINT
) ;

Python:

def  vs.SetVPLrOvrdPenFore(viewportHandle, layerHandle, colorRV, colorGV, colorBV):
   return None

Description:

Sets the pen foreground color for a layer override.

Parameters:

viewportHandle The viewport handle.
layerHandle The layer handle.
colorRV Red value (0-65535)
colorGV Green value (0-65535)
colorBV Blue value (0-65535)

See Also:

GetVPLrOvrdPenFore