ActiveClass Classes 
MiniCAD6.0

VectorScript Declaration:

FUNCTION   ActiveClass
:STRING ;

Python:

def  vs.ActiveClass():
   return STRING

Description:

Returns the name of the active class of the document.

Example:

activeClName:= ActiveClass;

See Also:

ActLayer   ActSymDef  



  ClassList Classes 
MiniCAD

VectorScript Declaration:

FUNCTION   ClassList
( index:LONGINT ) :STRING ;

Python:

def  vs.ClassList(index):
   return STRING

Description:

Returns the name of the specified class in the document class list. For example, ClassList(4) will return the name of the fourth class in the list.

Parameters:

index Index of class in class list (range of 1- n).

Example:

noneClass := ClassList(1);
dimensionClass := ClassList(2);
classNumber3 := ClassList(3);
classNumber4 := ClassList(4);

See Also:

ClassNum  



  ClassNum Classes 
MiniCAD

VectorScript Declaration:

FUNCTION   ClassNum
:LONGINT ;

Python:

def  vs.ClassNum():
   return LONGINT

Description:

Returns the total number of classes in the active document.

Example:

numOfClasses:= ClassNum;



  DelClass Classes 
MiniCAD

VectorScript Declaration:

PROCEDURE   DelClass
( className:STRING ) ;

Python:

def  vs.DelClass(className):
   return None

Description:

Deletes the specified class from the active document. If there are objects in the class to be deleted, they are reassigned to the None class.

Parameters:

className Name of class to delete.

Example:

DelClass('Future Construction');



  FillColorByClass Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   FillColorByClass
;

Python:

def  vs.FillColorByClass():
   return None

Description:

Sets the default document fill colors to the fill colors of the active class.

See Also:

PenColorByClass   MarkerByClass   FPatByClass  



  FPatByClass Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   FPatByClass
;

Python:

def  vs.FPatByClass():
   return None

Description:

Sets the default document fill pattern to the fill pattern of the active class.

See Also:

PenColorByClass   MarkerByClass   FillColorByClass  



  GetClassArrow Classes 
VectorWorks10.0 - obsolete as of VectorWorks 2008

VectorScript Declaration:

PROCEDURE   GetClassArrow
(   className :STRING;
  VAR  style :INTEGER;
  VAR  size :REAL;
  VAR  angle :INTEGER
) ;

Python:

def  vs.GetClassArrow(className):
   return (style, size, angle)

Special Notes:

GetClassArrow is obsolete as of VectorWorks 2008

Description:

Procedure GetClassArrow returns the arrow style parameters for the indicated class.

Parameters:

className The indicated class.
style Returns arrow style.
size Returns arrow size in inches measured in page space.
angle Returns arrow angle (in degrees).

Example:

PROCEDURE ShowNoneClassArrowValues;
VAR
	style :INTEGER;
	size  :REAL;
	ang   :INTEGER;
BEGIN
	GetClassArrow('None', style, size, ang);
	Message(style, ' ', size, ' ', ang);
END;
RUN(ShowNoneClassArrowValues);



  GetClassBeginningMarker Classes 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   GetClassBeginningMarker
(   name :STRING;
  VAR  style :LONGINT;
  VAR  angle :INTEGER;
  VAR  size :REAL;
  VAR  width :REAL;
  VAR  thicknessBasis :INTEGER;
  VAR  thickness :REAL
) :BOOLEAN ;

Python:

def  vs.GetClassBeginningMarker(name):
   return (BOOLEAN, style, angle, size, width, thicknessBasis, thickness)

Description:

Gets all properties for the named class' beginning marker. Return TRUE if operation was successful.

Parameters:

name Name of the class
style The marker style (see comments for details)
angle The marker angle in degrees (0 to 90)
size The marker size in pages inches
width The marker width in page inches
thicknessBasis The marker thickness basis. ( see comments for details)
thickness The marker thickness

Example:

PROCEDURE Example;
VAR
	ok : BOOLEAN;
style: INTEGER;
	angle: INTEGER;
	size: REAL;
	width: REAL;
	thickBasis: INTEGER;
	thickness: REAL;
	
BEGIN
	ok := GetClassBeginningMarker('None', style, angle, size, width, thickBasis, thickness);	
Message (style, ' /  ', angle, '  /  ', size, '  /  ', width, ' /  ', thickBasis, ' /  ', thickness);	

END;

RUN(Example);

See Also:

GetClassEndMarker  



  GetClassEndMarker Classes 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   GetClassEndMarker
(   name :STRING;
  VAR  style :LONGINT;
  VAR  angle :INTEGER;
  VAR  size :REAL;
  VAR  width :REAL;
  VAR  thicknessBasis :INTEGER;
  VAR  thickness :REAL
) :BOOLEAN ;

Python:

def  vs.GetClassEndMarker(name):
   return (BOOLEAN, style, angle, size, width, thicknessBasis, thickness)

Description:

Gets all properties for the named class's end marker. Return TRUE if operation was successful.

Parameters:

name Name of the class
style The marker style (see comments for details)
angle The marker angle in degrees (0 to 90)
size The marker size in pages inches
width The marker width in page inches
thicknessBasis The marker thickness basis. ( see comments for details)
thickness The marker thickness

Example:

PROCEDURE Example;
VAR
	ok : BOOLEAN;
style: INTEGER;
	angle: INTEGER;
	size: REAL;
	width: REAL;
	thickBasis: INTEGER;
	thickness: REAL;
	
BEGIN
	ok := GetClassEndMarker('None', style, angle, size, width, thickBasis, thickness);	
Message (style, ' /  ', angle, '  /  ', size, '  /  ', width, ' /  ', thickBasis, ' /  ', thickness);	

END;

RUN(Example);



  GetClassOptions Classes 
VectorWorks8.5

VectorScript Declaration:

FUNCTION   GetClassOptions
:INTEGER ;

Python:

def  vs.GetClassOptions():
   return INTEGER

Description:

Returns the class visibility setting for the active document.

Visibility Index
Active Only 1
Gray Others 2
Gray/Snap Others 6
Show Others 3
Show/Snap Others 4
Show/Snap/Modify Others 5

Result:

An INTEGER value indicating the current class visibility setting for the document.

See Also:

SetClassOptions  



  GetClFillBack Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetClFillBack
(   className :STRING;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

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

Description:

Returns the fill background color setting of the specified class. The color is returned as the three RGB components of the color. RGB values are in the range of 0~65535.

Parameters:

className Name of class.
colorRV Returns RGB color component (red).
colorGV Returns RGB color component (green).
colorBV Returns RGB color component (blue).

Example:

GetClFillBack('Grassy Cover',cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);



  GetClFillFore Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetClFillFore
(   className :STRING;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

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

Description:

Returns the fill foreground color setting of the specified class. The color is returned as the RGB components of the color. RGB values are in the range of 0~65535.

Parameters:

className Name of class.
colorRV Returns RGB color component (red).
colorGV Returns RGB color component (green).
colorBV Returns RGB color component (blue).

Example:

GetClFillFore('Grassy Cover',cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);



  GetClFPat Classes 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetClFPat
( className:STRING ) :LONGINT ;

Python:

def  vs.GetClFPat(className):
   return LONGINT

Description:

Returns the fill or hatch pattern of the specified class.

A positive return value in a range of 0 to 71 is the index of the bitmap fill pattern of the class. A negative value is the negative of the fill pattern index (index * -1).

Fill patterns and their associated constants can be found in the VectorScript Appendix.

Parameters:

className Name of class.

Example:

pbFillStyl:= GetClFPat('Grassy Cover');



  GetClLS Classes 
VectorWorks8.0 - obsolete as of Vectorworks 2013

VectorScript Declaration:

FUNCTION   GetClLS
( className:STRING ) :INTEGER ;

Python:

def  vs.GetClLS(className):
   return INTEGER

Special Notes:

GetClLS is obsolete as of Vectorworks 2013

Description:

Returns the line style of the specified class.

Parameters:

className Name of class.

Example:

pbLineSty:= GetClLS('Property Bounds');



  GetClLSN Classes 
Vectorworks 2013

VectorScript Declaration:

FUNCTION   GetClLSN
( className:STRING ) :LONGINT ;

Python:

def  vs.GetClLSN(className):
   return LONGINT

Description:

Returns the line style of the specified class.

Parameters:

className Name of class.

See Also:

SetClLSN  



  GetClLW Classes 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetClLW
( className:STRING ) :INTEGER ;

Python:

def  vs.GetClLW(className):
   return INTEGER

Description:

Returns the line weight of the specified class.

Parameters:

className Name of class.

Example:

pbLineWt:= GetClLW('Property Bounds');



  GetClOpacity Classes 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   GetClOpacity
( className:STRING ) :INTEGER ;

Python:

def  vs.GetClOpacity(className):
   return INTEGER

Description:

Gets the opacity of the specified class.



  GetClPenBack Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetClPenBack
(   className :STRING;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

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

Description:

Returns the pen background color setting of the specified class. The color is returned as the three RGB components of the color. RGB values are in the range of 0~65535.

Parameters:

className Name of class.
colorRV Returns RGB color component (red).
colorGV Returns RGB color component (green).
colorBV Returns RGB color component (blue).



  GetClPenFore Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetClPenFore
(   className :STRING;
  VAR  colorRV :LONGINT;
  VAR  colorGV :LONGINT;
  VAR  colorBV :LONGINT
) ;

Python:

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

Description:

Returns the pen foreground color setting of the specified class. The color is returned as the three RGB components of the color. RGB values are in the range of 0~65535.

Parameters:

className Name of class.
colorRV Returns RGB color component (red).
colorGV Returns RGB color component (green).
colorBV Returns RGB color component (blue).

Example:

GetClPenFore('Grassy Cover',cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);



  GetClTextStyleRef Classes 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   GetClTextStyleRef
( className:STRING ) :LONGINT ;

Python:

def  vs.GetClTextStyleRef(className):
   return LONGINT

Description:

Function GetClTextStyleRef gets the text style of the specified class. The integer style is the internal index of the text style.

Parameters:

className Name of class

See Also:

SetClUseTextStyle   GetClUseTextStyle   SetClTextStyleRef  



  GetClUseGraphic Classes 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetClUseGraphic
( className:STRING ) :BOOLEAN ;

Python:

def  vs.GetClUseGraphic(className):
   return BOOLEAN

Description:

Returns whether the graphic attributes of the specified class will be used at object creation.

Parameters:

className Name of class.

Result:

True indicates that this class is set to use its graphic attributes when objects are created in this class. False indicates that the objects created in this class will get default attributes from the default global attribute settings.



  GetClUseTextStyle Classes 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   GetClUseTextStyle
( className:STRING ) :BOOLEAN ;

Python:

def  vs.GetClUseTextStyle(className):
   return BOOLEAN

Description:

Function GetClUseTextStyle returns whether the text style of the specified class is used at object creation.

Parameters:

className Name of class

See Also:

SetClUseTextStyle   SetClTextStyleRef   GetClTextStyleRef  



  GetClVectorFill Classes 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetClVectorFill
(   className :STRING;
  VAR  hatchName :STRING
) :BOOLEAN ;

Python:

def  vs.GetClVectorFill(className):
   return (BOOLEAN, hatchName)

Description:

Returns the name of the hatch pattern setting of the specified class.

The function return value will be TRUE if the class uses a hatch pattern, and will be FALSE if the class does not use a hatch pattern.

Parameters:

className Name of class.
hatchName Name of active hatch pattern (if it exists).



  GetCVis Classes 
MiniCAD

VectorScript Declaration:

FUNCTION   GetCVis
( className:STRING ) :INTEGER ;

Python:

def  vs.GetCVis(className):
   return INTEGER

Description:

Returns the visibility status of the specified class.

Visibility Index Value
Visible 0
Hidden -1
Grayed 2

Parameters:

className Name of class.

Result:

Visibility Index Value
Visible 0
Hidden -1
Grayed 2

Example:

PROCEDURE Example;
BEGIN
	Message(GetCVis('Dimension'));
END;
RUN(Example);



  GrayClass Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GrayClass
( className:STRING ) ;

Python:

def  vs.GrayClass(className):
   return None

Description:

Sets the visibility of the specified class to grayed status.

Parameters:

className Name of class.

Example:

GrayClass('Phase 2 Construction');



  HideClass Classes 
MiniCAD

VectorScript Declaration:

PROCEDURE   HideClass
( className:STRING ) ;

Python:

def  vs.HideClass(className):
   return None

Description:

Sets the class visibility of the specified class to hidden (invisible) status.

Parameters:

className Name of class.

Example:

HideClass('Dimension');

See Also:

ShowClass  



  LSByClass Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   LSByClass
;

Python:

def  vs.LSByClass():
   return None

Description:

Sets the default document line style to the line style of the active class.





  LWByClass Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   LWByClass
;

Python:

def  vs.LWByClass():
   return None

Description:

Sets the default document line weight to the line weight of the active class.



  MarkerByClass Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   MarkerByClass
;

Python:

def  vs.MarkerByClass():
   return None

Description:

Sets the default document marker style to the marker style of the active class.



  NameClass Classes 
MiniCAD

VectorScript Declaration:

PROCEDURE   NameClass
( className:STRING ) ;

Python:

def  vs.NameClass(className):
   return None

Description:

Creates a new class in a Vectorworks document, which then become the active class.
If the specified class already exists, then it will become the active class of the document.

Note: Class names cannot exceed 20 characters.

Parameters:

className Name of class.

Example:

NameClass('Revisions');
Rect(4,4,6,6);

{Create a class 'Revisions' in the document}
{The rectangle is then assigned this class }



  OpacityByClass Classes 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   OpacityByClass
;

Python:

def  vs.OpacityByClass():
   return None

Description:

Sets the document default settings to the opacity of the active class.



  PenColorByClass Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   PenColorByClass
;

Python:

def  vs.PenColorByClass():
   return None

Description:

Sets the default document pen colors to the pen colors of the active class.


See Also:

FillColorByClass  



  RenameClass Classes 
VectorWorks8.5

VectorScript Declaration:

PROCEDURE   RenameClass
(   className :STRING;
    newName :STRING
) ;

Python:

def  vs.RenameClass(className, newName):
   return None

Description:

Renames the specified class.

All objects assigned to the class being renamed are updated.

Parameters:

className Existing name of the class.
newName New name for the class.



  SetClassArrow Classes 
VectorWorks10.0 - obsolete as of VectorWorks 2008

VectorScript Declaration:

PROCEDURE   SetClassArrow
(   className :STRING;
    style :INTEGER;
    size :REAL;
    angle :INTEGER
) ;

Python:

def  vs.SetClassArrow(className, style, size, angle):
   return None

Special Notes:

SetClassArrow is obsolete as of VectorWorks 2008

Description:

Procedure SetClassArrow sets the arrow style parameters for the indicated class.

Parameters:

className The indicated class.
style The arrow style.
size The arrow size in inches measured in page space.
angle The arrow angle (in degrees).

Example:

SetClassArrow('None', 2, 0.25, 15);



  SetClassBeginningMarker Classes 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   SetClassBeginningMarker
(   name :STRING;
    style :LONGINT;
    angle :INTEGER;
    size :REAL;
    width :REAL;
    thicknessBasis :INTEGER;
    thickness :REAL
) :BOOLEAN ;

Python:

def  vs.SetClassBeginningMarker(name, style, angle, size, width, thicknessBasis, thickness):
   return BOOLEAN

Description:

Sets all properties for the named class' beginning marker. Return TRUE if operation was successful.

Parameters:

name Name of the class
style The marker style (see comments for details)
angle The marker angle in degrees (0 to 90)
size The marker size in pages inches
width The marker width in page inches
thicknessBasis The marker thickness basis. ( see comments for details)
thickness The marker thickness

Example:

PROCEDURE Example;
VAR
	ok : BOOLEAN;	
BEGIN
	ok := SetClassBeginningMarker('None', 1280, 45, 0.25, 0.25, 0, 2);	
END;

RUN(Example);

See Also:

SetClassEndMarker  



  SetClassEndMarker Classes 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   SetClassEndMarker
(   name :STRING;
    style :LONGINT;
    angle :INTEGER;
    size :REAL;
    width :REAL;
    thicknessBasis :INTEGER;
    thickness :REAL
) :BOOLEAN ;

Python:

def  vs.SetClassEndMarker(name, style, angle, size, width, thicknessBasis, thickness):
   return BOOLEAN

Description:

Sets all properties for the named class's end marker. Return TRUE if operation was successful.

Parameters:

name Name of the class.
style The marker style. (see comments for details)
angle The marker angle in degrees. (0 to 90)
size The marker size in page inches.
width The marker width in page inches.
thicknessBasis The marker thickness basis. ( see comments for details)
thickness The marker thickness.

Example:

PROCEDURE Example;
VAR
	ok : BOOLEAN;
BEGIN
	ok := SetClassEndMarker('None', 1280, 25, 0.125, 0.125, 0, 2);
END;

RUN(Example);

See Also:

SetClassBeginningMarker  



  SetClassOptions Classes 
VectorWorks8.5

VectorScript Declaration:

PROCEDURE   SetClassOptions
( classOpts:INTEGER ) ;

Python:

def  vs.SetClassOptions(classOpts):
   return None

Description:

Sets class visibility setting for the active document.

Visibility Index
Active Only 1
Gray Others 2
Gray/Snap Others 6
Show Others 3
Show/Snap Others 4
Show/Snap/Modify Others 5

Parameters:

classOpts New class visibility setting.



  SetClFillBack Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetClFillBack
(   className :STRING;
    colorR :INTEGER;
    colorG :INTEGER;
    colorB :INTEGER
) ;

Python:

def  vs.SetClFillBack(className, color):
   return None

Description:

Sets the fill background color of the specified class. The color must be specified using the RGB components of the desired color. RGB values are in the range of 0~65535.

Parameters:

className Name of class.
color RGB color value.

Example:

ColorIndexToRGB(98,cRed,cGrn,cBlu);
SetClFillBack('Grassy Cover',cRed,cGrn,cBlu);



  SetClFillFore Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetClFillFore
(   className :STRING;
    colorR :INTEGER;
    colorG :INTEGER;
    colorB :INTEGER
) ;

Python:

def  vs.SetClFillFore(className, color):
   return None

Description:

Sets the fill foreground color of the specified class. The color must be specified using the RGB components of the desired color. RGB values are in the range of 0~65535.

Parameters:

className Name of class.
color RGB color value.

Example:

ColorIndexToRGB(24,cRed,cGrn,cBlu);
SetClFillFore('Grassy Cover',cRed,cGrn,cBlu);



  SetClFPat Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetClFPat
(   className :STRING;
    fillpattern :LONGINT
) ;

Python:

def  vs.SetClFPat(className, fillpattern):
   return None

Description:

Sets the fill pattern of the specified class.

To apply a bitmap fill pattern, use a positive value corresponding to the desired fill pattern index. To apply a vector fill, use the negative of the index of the vector fill (index * -1).

Fill patterns and their associated constants can be found in the VectorScript Appendix.

Parameters:

className Name of class.
fillpattern Fill pattern index value.

Example:

SetClFPat('Grassy Cover',42);



  SetClLS Classes 
VectorWorks8.0 - obsolete as of Vectorworks 2013

VectorScript Declaration:

PROCEDURE   SetClLS
(   className :STRING;
    LS :INTEGER
) ;

Python:

def  vs.SetClLS(className, LS):
   return None

Special Notes:

SetClLS is obsolete as of Vectorworks 2013

Description:

Sets the line style of the specified class.

Parameters:

className Name of class.
LS Line style index value.

Example:

SetClLS('Property Parcels',-4);



  SetClLSN Classes 
Vectorworks 2013

VectorScript Declaration:

PROCEDURE   SetClLSN
(   className :STRING;
    lineStyle :LONGINT
) ;

Python:

def  vs.SetClLSN(className, lineStyle):
   return None

Description:

Sets the line style of the specified class.

Parameters:

className Name of class.
lineStyle Line style index value.

See Also:

GetClLSN  



  SetClLW Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetClLW
(   className :STRING;
    LW :INTEGER
) ;

Python:

def  vs.SetClLW(className, LW):
   return None

Description:

Sets the line weight of the specified class.

Parameters:

className Name of class.
LW Line weight value (in mils).

Example:

SetClLW('To Be Demolished',28);



  SetClOpacity Classes 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   SetClOpacity
(   className :STRING;
    opacity :INTEGER
) ;

Python:

def  vs.SetClOpacity(className, opacity):
   return None

Description:

Sets the opacity persentage of a class. The opacity is specified by percentage value in range [0-100].

Parameters:

className Name of class.
opacity Opacity specified by percentage value in range [0-100].

Example:

{set opacity of 25%}
SetClOpacity('Cold Water Supply',25);



  SetClPenBack Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetClPenBack
(   className :STRING;
    colorR :INTEGER;
    colorG :INTEGER;
    colorB :INTEGER
) ;

Python:

def  vs.SetClPenBack(className, color):
   return None

Description:

Procedure SetClPenBack sets the pen background color of the specified class. The color must be specified using the RGB components of the desired color. RGB values are in the range of 0~65535.

Parameters:

className Name of class.
color RGB color value.

Example:

ColorIndexToRGB(214,cRed,cGrn,cBlu);
SetClPenBack('Cold Water Supply',cRed,cGrn,cBlu);



  SetClPenFore Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetClPenFore
(   className :STRING;
    colorR :INTEGER;
    colorG :INTEGER;
    colorB :INTEGER
) ;

Python:

def  vs.SetClPenFore(className, color):
   return None

Description:

Sets the pen foreground color of the specified class. The color must be specified using the RGB components of the desired color. RGB values are in the range of 0~65535.

Parameters:

className Name of class.
color RGB color value.

Example:

ColorIndexToRGB(214,cRed,cGrn,cBlu);
SetClPenFore('Cold Water Supply',cRed,cGrn,cBlu);



  SetClTextStyleRef Classes 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   SetClTextStyleRef
(   className :STRING;
    textStyleRef :LONGINT
) ;

Python:

def  vs.SetClTextStyleRef(className, textStyleRef):
   return None

Description:

Function SetClTextStyleRef sets the text style of the specified class. The integer style is the internal index of the text style.

Parameters:

className Name of class
textStyleRef text style reference id

See Also:

SetClUseTextStyle   GetClUseTextStyle   GetClTextStyleRef  



  SetClUseGraphic Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetClUseGraphic
(   className :STRING;
    use :BOOLEAN
) ;

Python:

def  vs.SetClUseGraphic(className, use):
   return None

Description:

Toggles the document setting for using the graphic attributes of the specified class at object creation.

Parameters:

className Name of class.
use Use graphic attributes on-off setting.

Example:

SetClUseGraphic('Forested Cover',TRUE);



  SetClUseTextStyle Classes 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   SetClUseTextStyle
(   className :STRING;
    use :BOOLEAN
) ;

Python:

def  vs.SetClUseTextStyle(className, use):
   return None

Description:

Controls whether the text style of the specified class is used at object creation.

Parameters:

className Name of class
use Use text style on-off setting.

See Also:

GetClUseTextStyle   SetClTextStyleRef   GetClTextStyleRef  



  SetClUseTexture Classes 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetClUseTexture
(   className :STRING;
    use :BOOLEAN
) ;

Python:

def  vs.SetClUseTexture(className, use):
   return None

Description:

Toggles the document setting for using the texture attributes of the specified class at object creation.

Parameters:

className Name of class.
use Use texture attributes on-off setting.

Example:

SetClUseTexture('Proposed Roof',TRUE);



  SetClVectorFill Classes 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   SetClVectorFill
(   className :STRING;
    hatchName :STRING
) :BOOLEAN ;

Python:

def  vs.SetClVectorFill(className, hatchName):
   return BOOLEAN

Description:

Sets the class fill style to use the specified hatch pattern. The function return value will be TRUE if the operation was successful.

Parameters:

className Name of class.
hatchName Name of hatch pattern.



  ShowClass Classes 
MiniCAD

VectorScript Declaration:

PROCEDURE   ShowClass
( className:STRING ) ;

Python:

def  vs.ShowClass(className):
   return None

Description:

Sets the visibility of the specified class to normal (visible) status.

Parameters:

className Name of class.

Example:

ShowClass('Dimension');

See Also:

HideClass