ActiveClass | Classes |
Declaration:
FUNCTION ActiveClass
:STRING ; Description:
Function ActiveClass returns the name of the active class of the document.Example:
ClName:=ActiveClass;See Also:
ActLayer ActSymDef
ClassList | Classes |
Declaration:
FUNCTION ClassList
( index:INTEGER ) :STRING ; Description:
Function ClassList returns the name of the specified class.Parameters:
index Index of class in class list (range of 1- n). Example:
Class:=ClassList(4);
ClassNum | Classes |
Declaration:
FUNCTION ClassNum
:INTEGER ; Description:
Function ClassNum returns the total number of classes in the active document.Example:
NumOfClasses:=ClassNum;
DelClass | Classes |
Declaration:
PROCEDURE DelClass
( className:STRING ) ; Description:
Procedure DelClass deletes the specified class from the active document.
Parameters:
className Name of class to delete. Example:
DelClass('Future Construction');
FillColorByClass | Classes |
Declaration:
PROCEDURE FillColorByClass
; Description:
Procedure FillColorByClass sets the document default fill colors to the fill colors of the active class.
See Also:
PenColorByClass MarkerByClass FPatByClass
FPatByClass | Classes |
Declaration:
PROCEDURE FPatByClass
; Description:
Procedure FPatByClass sets the document default fill pattern to the fill pattern of the active class.
See Also:
PenColorByClass MarkerByClass FillColorByClass
GetClFillBack | Classes |
Declaration:
PROCEDURE GetClFillBack
( className :STRING; VAR colorRV :LONGINT; VAR colorGV :LONGINT; VAR colorBV :LONGINT ) ; Description:
Procedure GetClFillBack returns the fill background color setting of the specified class.
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 |
Declaration:
PROCEDURE GetClFillFore
( className :STRING; VAR colorRV :LONGINT; VAR colorGV :LONGINT; VAR colorBV :LONGINT ) ; Description:
Procedure GetClFillFore returns the fill foreground color setting of the specified class.
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 |
Declaration:
FUNCTION GetClFPat
( className:STRING ) :INTEGER ; Description:
Function GetClFPat returns the fill pattern of the specified class. The fill pattern index will be in a range of 0 to 71.
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 |
Declaration:
FUNCTION GetClLS
( className:STRING ) :INTEGER ; Description:
Function GetClLS returns the line style of the specified class.
Parameters:
className Name of class. Example:
pbLineSty:=GetClLS('Property Bounds');
GetClLW | Classes |
Declaration:
FUNCTION GetClLW
( className:STRING ) :INTEGER ; Description:
Function GetClLW returns the line weight of the specified class.Parameters:
className Name of class. Example:
pbLineWt:=GetClLW('Property Bounds');
GetClPenBack | Classes |
Declaration:
PROCEDURE GetClPenBack
( className :STRING; VAR colorRV :LONGINT; VAR colorGV :LONGINT; VAR colorBV :LONGINT ) ; Description:
Procedure GetClPenBack returns the pen background color setting of the specified class.
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 |
Declaration:
PROCEDURE GetClPenFore
( className :STRING; VAR colorRV :LONGINT; VAR colorGV :LONGINT; VAR colorBV :LONGINT ) ; Description:
Procedure GetClPenFore returns the pen foreground color setting of the specified class.
The RGB components of the color setting are returned in parameters colorRV, colorGV, and colorBV.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);
GetClUseGraphic | Classes |
Declaration:
FUNCTION GetClUseGraphic
( className:STRING ) :BOOLEAN ; Description:
Function GetClUseGraphic returns whether the specified classes' graphic attributes 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.
GetCVis | Classes |
Declaration:
FUNCTION GetCVis
( className:STRING ) :INTEGER ; Description:
Function GetCVis returns the visibility status of the specified class.
Parameters:
className Name of class. Result:
Visibility Index Value Visible 0 Hidden 1 Grayed 2
Example:
VisStatus:=GetCVis('Dimension');
GrayClass | Classes |
Declaration:
PROCEDURE GrayClass
( className:STRING ) ; Description:
Procedure GrayClass sets the class visibility of the specified class to grayed status.Parameters:
className Name of class. Example:
GrayClass('Phase 2 Construction');
HideClass | Classes |
Declaration:
PROCEDURE HideClass
( className:STRING ) ; Description:
Procedure HideClass 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 |
Declaration:
PROCEDURE LSByClass
; Description:
Procedure LSByClass sets the document default line style to the line style of the active class.
LWByClass | Classes |
Declaration:
PROCEDURE LWByClass
; Description:
Procedure LWByClass sets the document default line weight to the line weight of the active class.
MarkerByClass | Classes |
Declaration:
PROCEDURE MarkerByClass
; Description:
Procedure MarkerByClass sets the document default marker style to the marker style of the active class.
NameClass | Classes |
Declaration:
PROCEDURE NameClass
( className:STRING ) ; Description:
NameClass creates a new class in a VectorWorks document, which then become the active class.
Class names cannot exceed 20 characters.
If the specified class already exists, then it will become the active class of the document.
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 }
PenColorByClass | Classes |
Declaration:
PROCEDURE PenColorByClass
; Description:
Procedure PenColorByClass sets the document default pen colors to the pen colors of the active class.
See Also:
FillColorByClass
SetClFillBack | Classes |
Declaration:
PROCEDURE SetClFillBack
( className :STRING; colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure SetClFillBack sets the fill background color of the specified class.Parameters:
className Name of class. color RGB color value. Example:
ColorIndexToRGB(98,cRed,cGrn,cBlu); SetClFillBack('Grassy Cover',cRed,cGrn,cBlu);
SetClFillFore | Classes |
Declaration:
PROCEDURE SetClFillFore
( className :STRING; colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure SetClFillFore sets the fill foreground color of the specified class.Parameters:
className Name of class. color RGB color value. Example:
ColorIndexToRGB(24,cRed,cGrn,cBlu); SetClFillFore('Grassy Cover',cRed,cGrn,cBlu);
SetClFPat | Classes |
Declaration:
PROCEDURE SetClFPat
( className :STRING; fillpattern :INTEGER ) ; Description:
Procedure SetClFPat sets the fill pattern of the specified class.Parameters:
className Name of class. fillpattern Fill pattern index value. Example:
SetClFPat('Grassy Cover',42);
SetClLS | Classes |
Declaration:
PROCEDURE SetClLS
( className :STRING; LS :INTEGER ) ; Description:
Procedure SetClLS sets the line style of the specified class.Parameters:
className Name of class. LS Line style index value. Example:
SetClLS('Property Parcels',-4);
SetClLW | Classes |
Declaration:
PROCEDURE SetClLW
( className :STRING; LW :INTEGER ) ; Description:
Procedure SetClLW 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);
SetClPenBack | Classes |
Declaration:
PROCEDURE SetClPenBack
( className :STRING; colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure SetClPenBack sets the pen background color of the specified class.Parameters:
className Name of class. color RGB color value. Example:
ColorIndexToRGB(214,cRed,cGrn,cBlu); SetClPenBack('Cold Water Supply',cRed,cGrn,cBlu);
SetClPenFore | Classes |
Declaration:
PROCEDURE SetClPenFore
( className :STRING; colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure SetClPenFore sets the pen foreground color of the specified class.Parameters:
className Name of class. color RGB color value. Example:
ColorIndexToRGB(214,cRed,cGrn,cBlu); SetClPenFore('Cold Water Supply',cRed,cGrn,cBlu);
SetClUseGraphic | Classes |
Declaration:
PROCEDURE SetClUseGraphic
( className :STRING; use :BOOLEAN ) ; Description:
Procedure SetClUseGraphic sets whether the specified classes' graphic attributes will be used at object creation.Parameters:
className Name of class. use Use graphic attributes on-off setting. Example:
SetClUseGraphic('Forested Cover',TRUE);
SetClUseTexture | Classes |
Declaration:
PROCEDURE SetClUseTexture
( className :STRING; use :BOOLEAN ) ; Description:
Procedure SetClUseTexture sets whether the specified classes' texture attributes will be used at object creation.Parameters:
className Name of class. use Use texture attributes on-off setting. Example:
SetClUseTexture('Proposed Roof',TRUE);
ShowClass | Classes |
Declaration:
PROCEDURE ShowClass
( className:STRING ) ; Description:
Procedure ShowClass sets the class visibility of the specified class to normal (visible) status.Parameters:
className Name of class. Example:
ShowClass('Dimension');See Also:
HideClass