FArrowHead | Document Attributes |
Declaration:
FUNCTION FArrowHead
:INTEGER ; Special Notes:
FArrowHead is obsolete as of VectorWorks 8.0
Description:
Obsolete procedure.See Also:
FMarker
FArrowSize | Document Attributes |
Declaration:
FUNCTION FArrowSize
:INTEGER ; Special Notes:
FArrowSize is obsolete as of VectorWorks 8.0
Description:
Obsolete procedure.See Also:
FMarker
FFillBack | Document Attributes |
Declaration:
PROCEDURE FFillBack
( VAR red :LONGINT; VAR green :LONGINT; VAR blue :LONGINT ) ; Description:
Procedure FFillBack returns the current fill background color.
A color table listing with associated index values can be found in the VectorScript Appendix.Parameters:
red Returns RGB color component value. green Returns RGB color component value. blue Returns RGB color component value. Example:
FFillBack(redValue,greenValue,blueValue);See Also:
RGBToColorIndex ColorIndexToRGB
FFillColorByClass | Document Attributes |
Declaration:
FUNCTION FFillColorByClass
:BOOLEAN ; Description:
Function FFillColorByClass returns whether the global attributes are set to use the fill colors of the default class.Example:
useClassFillCol:=FFillColorByClass;
FFillFore | Document Attributes |
Declaration:
PROCEDURE FFillFore
( VAR red :LONGINT; VAR green :LONGINT; VAR blue :LONGINT ) ; Description:
Procedure FFillFore returns the current fill foreground color.
A color table listing with associated index values can be found in the VectorScript Appendix.Parameters:
red Returns RGB color component value. green Returns RGB color component value. blue Returns RGB color component value. Example:
FFillFore(redValue,greenValue,blueValue);See Also:
RGBToColorIndex ColorIndexToRGB
FFillPat | Document Attributes |
Declaration:
FUNCTION FFillPat
:INTEGER ; Description:
Function FFillPat returns the current fill pattern setting.
Fill patterns and their associated constants can be found in the VectorScript Appendix.Example:
currFillStyle:=FFillPat;
FFPatByClass | Document Attributes |
Declaration:
FUNCTION FFPatByClass
:BOOLEAN ; Description:
Function FFPatByClass returns whether the global attributes are set to use the fill pattern of the default class.Example:
useClassFPat:=FFPatByClass;
FillBack | Document Attributes |
Declaration:
PROCEDURE FillBack
( colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure FillBack sets the active fill background color setting for the document.
A color table listing with associated index values can be found in the VectorScript Appendix.Parameters:
color RGB color value to set as active fill background color. Example:
FillBack(65535,0,39321);See Also:
RGBToColorIndex ColorIndexToRGB
FillFore | Document Attributes |
Declaration:
PROCEDURE FillFore
( colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure FillFore sets the active fill foreground color setting for the document.
A color table listing with associated index values can be found in the VectorScript Appendix.Parameters:
color RGB color value to set as active fill foreground color. Example:
FillFore(65535,0,39321);See Also:
RGBToColorIndex ColorIndexToRGB
FillPat | Document Attributes |
Declaration:
PROCEDURE FillPat
( patNumber:INTEGER ) ; Description:
Procedure FillPat sets the active fill pattern for the document. Any objects created after a calling this procedure will use the specified fill pattern.
Fill patterns and their associated constants can be found in the VectorScript Appendix.Parameters:
patNumber Index of fill pattern to be set as document default. Example:
Rect(0,0,2,2); FillPat(21); Rect(2,2,4,4);
FLSByClass | Document Attributes |
Declaration:
FUNCTION FLSByClass
:BOOLEAN ; Description:
Function FLSByClass returns whether the global attributes are set to use the line style of the default class.Example:
useClassLStyle:=FLSByClass;
FLWByClass | Document Attributes |
Declaration:
FUNCTION FLWByClass
:BOOLEAN ; Description:
Function FLWByClass returns whether the global attributes are set to use the line weight of the default class.Example:
useClassLWidth:=FLWByClass;
FMarker | Document Attributes |
Declaration:
PROCEDURE FMarker
( VAR style :INTEGER; VAR size :REAL; VAR ang :INTEGER ) ; Description:
Procedure FMarker returns the active marker style parameters.
Marker Styles
Marker Style Constant Arrow at start 1 Arrow at end 2 Filled Arrow 0 Empty Arrow 4 Open Arrow 8 Filled Circle 12 Empty Circle 16 Slash 20 Cross 24
Parameters:
style Returns marker style. size Returns marker size. ang Returns marker angle. Example:
FMarker(arrowType,len,arrowAng);
FMarkerByClass | Document Attributes |
Declaration:
FUNCTION FMarkerByClass
:BOOLEAN ; Description:
Function FMarkerByClass returns whether the global attributes are set to use the arrow style of the default class.Example:
useClassMarker:=FMarkerByClass;
FPenBack | Document Attributes |
Declaration:
PROCEDURE FPenBack
( VAR red :LONGINT; VAR green :LONGINT; VAR blue :LONGINT ) ; Description:
Procedure FPenBack returns the current pen background color.
A color table listing with associated index values can be found in the VectorScript Appendix.Parameters:
red Returns RGB color component value. green Returns RGB color component value. blue Returns RGB color component value. Example:
See Also:
RGBToColorIndex ColorIndexToRGB
FPenColorByClass | Document Attributes |
Declaration:
FUNCTION FPenColorByClass
:BOOLEAN ; Description:
Function FPenColorByClass returns whether the global attributes are set to use the pen colors of the default class.Example:
useClassPenColor:=FPenColorByClass;
FPenFore | Document Attributes |
Declaration:
PROCEDURE FPenFore
( VAR red :LONGINT; VAR green :LONGINT; VAR blue :LONGINT ) ; Description:
Procedure FPenFore returns the current pen foreground color of the document.
A color table listing with associated index values can be found in the VectorScript Appendix.Parameters:
red Returns RGB color component value. green Returns RGB color component value. blue Returns RGB color component value. See Also:
RGBToColorIndex ColorIndexToRGB
FPenPat | Document Attributes |
Declaration:
FUNCTION FPenPat
:INTEGER ; Description:
Function FPenPat returns the active pen pattern setting.
Example:
CurrPenStyle:=FPenPat;
FPenSize | Document Attributes |
Declaration:
FUNCTION FPenSize
:INTEGER ; Description:
Function FPenSize returns the active pen size setting(in mils).
Example:
CurrPenSize:=FPenSize;
GetDashStyle | Document Attributes |
Declaration:
FUNCTION GetDashStyle
:INTEGER ; Description:
Function GetDashStyle returns the active linestyle pattern of the document.Example:
currLS:=GetDashStyle;
Marker | Document Attributes |
Declaration:
PROCEDURE Marker
( style :INTEGER; size :REAL; ang :INTEGER ) ; Description:
Marker defines a marker(arrowhead) style for the document. This marker style becomes the active style for the document.
Marker Styles
Marker Style Constant Arrow at start 1 Arrow at end 2 Filled Arrow 0 Empty Arrow 4 Open Arrow 8 Filled Circle 12 Empty Circle 16 Slash 20 Cross 24
Parameters:
style Marker style constant. size Marker size. ang Marker angle. Example:
Marker(2,0.25,60);
NumDashStyles | Document Attributes |
Declaration:
FUNCTION NumDashStyles
:INTEGER ; Description:
Function NumDashStyles returns the number of available line dash patterns.Example:
numLS:=NumDashStyles;
PenBack | Document Attributes |
Declaration:
PROCEDURE PenBack
( colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure PenBack set the active pen background color for the document.
A color table listing with associated index values can be found in the VectorScript Appendix.Parameters:
color RGB color value to be set as active pen background. Example:
PenBack(65535,0,39321);See Also:
RGBToColorIndex ColorIndexToRGB
PenFore | Document Attributes |
Declaration:
PROCEDURE PenFore
( colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure PenFore sets the active pen foreground color for the document.
A color table listing with associated index values can be found in the VectorScript Appendix.Parameters:
color RGB color value to be set as active pen foreground. Example:
PenFore(65535,0,39321);See Also:
RGBToColorIndex ColorIndexToRGB
PenPat | Document Attributes |
Declaration:
PROCEDURE PenPat
( patNumber:INTEGER ) ; Description:
Procedure PenPat sets the active pen pattern (line style) for the document.
If patNumber is in the range 0 to 71 the linestyle will be set to the corresponding fill pattern. A value in the range -1 to -8, will set the linestyle to one of the defined VectorWorks linestyles.
Parameters:
patNumber Pattern/linestyle ID value. Example:
PenPat(25); { uses fill pattern 25 as the active pen pattern } PenPat(-3); { sets a linestyle as the active pen pattern }
PenSize | Document Attributes |
Declaration:
PROCEDURE PenSize
( lw:INTEGER ) ; Description:
Procedure PenSize sets the active line weight for the document.Parameters:
lw Line weight (in mils). Fourteen (14) mils equals one pixel. Example:
PenSize(28);
SetDashStyle | Document Attributes |
Declaration:
PROCEDURE SetDashStyle
( swt :BOOLEAN; numPairs :INTEGER; b1 :REAL; w1 :REAL; ... :REAL; b5 :REAL; w5 :REAL ) ; Description:
Procedure SetDashStyle creates a new linestyle in a VectorWorks document. Parameter swt defines whether the linestyle will be scaled with thickness, and parameter numPairs specifies the number of length pairs defining the linestyle.
The linestyle is defined by up to five black/white length pairs, which are specified in parameters b1,w1 through b5,w5. The minimum length of any given black or white parameter is 1 point, or 1/72 of an inch, and the line specification must be in pairs.
Example:
SetDashStyle(True,0,1",1/4",1/4",1/4");