| DeleteAllDLComponents | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION DeleteAllDLComponents
:BOOLEAN ; Python:
return BOOLEAN
def vs.DeleteAllDLComponents(): Description:
Deletes all components in the Double Line Preferences.
| DeleteDLComponent | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION DeleteDLComponent
( index:INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DeleteDLComponent(index): Description:
Deletes the nth component of the Double Line Preferences, where n is equal to index.Parameters:
index The index of the component to delete. See Also:
InsertNewDLComponent
| DoubLines | Document Settings MiniCAD - obsolete as of VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE DoubLines
( doubleLineDistance:REAL (Coordinate) ) ; Python:
return None
def vs.DoubLines(doubleLineDistance): Special Notes:
DoubLines is obsolete as of VectorWorks12.5
Description:
Procedure DoubLines sets the line spacing width for double-line tools.
Parameters:
doubleLineDistance Width between lines. Example:
DoubLines(1/2");
| DrwSize | Document Settings MiniCAD |
VectorScript Declaration:
PROCEDURE DrwSize
( rows :INTEGER; columns :INTEGER ) ; Python:
return None
def vs.DrwSize(rows, columns): Description:
Procedure DrwSize sets the drawing area of the document.
Parameters:
rows Number of sheet rows comprising total document area. columns Number of sheet columns comprising total document area. Example:
DrwSize(2,3); {sets the drawing size to 2 x 3 sheets}
| GetCurrentPlanarRefID | Document Settings Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetCurrentPlanarRefID
:LONGINT ; Python:
return LONGINT
def vs.GetCurrentPlanarRefID(): Description:
Return the current plane ref ID. This could be any plane: a working plane, screen plane (0), ground plane of a container, or any arbitrary plane.
| GetDefaultTextSize | Document Settings VectorWorks8.0 |
VectorScript Declaration:
FUNCTION GetDefaultTextSize
:REAL ; Python:
return REAL
def vs.GetDefaultTextSize(): Description:
Function GetDefaultTextSize returns the default text size in points.
72 points are equal to one(1) inch.
| GetDLComponentClass | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetDLComponentClass
( index :INTEGER; VAR componentClass :LONGINT ) :BOOLEAN ; Python:
return (BOOLEAN, componentClass)
def vs.GetDLComponentClass(index): Description:
Gets the class of the component at index in the Double Line Preferences.Parameters:
index The index of the component. componentClass Returns the class of the component. See Also:
SetDLComponentClass
| GetDLComponentFill | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION GetDLComponentFill
( index :INTEGER; VAR fill :LONGINT ) :BOOLEAN ; Python:
return (BOOLEAN, fill)
def vs.GetDLComponentFill(index): Description:
Gets the fill of the component at index in the Double Line Preferences.Parameters:
index The index of the component. fill Returns the fill of the component. Positive values for patterns, negative ref numbers for hatches. See Also:
SetDLComponentFill
| GetDLComponentFillColors | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetDLComponentFillColors
( index :INTEGER; VAR fillForeColor :INTEGER; VAR fillBackColor :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, fillForeColor, fillBackColor)
def vs.GetDLComponentFillColors(index): Description:
Gets the fore and back fill colors of the component at index in the Double Line Preferences.Parameters:
index The index of the component. fillForeColor Returns the fore color of the fill. fillBackColor Returns the back color of the fill. See Also:
SetDLComponentFillColors
| GetDLComponentName | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetDLComponentName
( index:INTEGER ) :STRING ; Python:
return STRING
def vs.GetDLComponentName(index): Description:
Gets the name of the component at index in the Double Line Preferences.Parameters:
index The index of the component. Result:
The name of the component.See Also:
SetDLComponentName
| GetDLComponentPenColors | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetDLComponentPenColors
( index :INTEGER; VAR leftPenForeColor :INTEGER; VAR leftPenBackColor :INTEGER; VAR rightPenForeColor :INTEGER; VAR rightPenBackColor :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, leftPenForeColor, leftPenBackColor, rightPenForeColor, rightPenBackColor)
def vs.GetDLComponentPenColors(index): Description:
Gets the fore and back colors of the left and right side pens of the component at index in the Double Line Preferences.Parameters:
index The index of the component. leftPenForeColor Returns the fore color of the left pen. leftPenBackColor Returns the back color of the left pen. rightPenForeColor Returns the fore color of the right pen. rightPenBackColor Resturns the back color of the right pen. See Also:
SetDLComponentPenColors
| GetDLComponentPenStyles | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION GetDLComponentPenStyles
( index :INTEGER; VAR penStyleLeft :INTEGER; VAR penStyleRight :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, penStyleLeft, penStyleRight)
def vs.GetDLComponentPenStyles(index): Description:
Gets the left and right side pen styles of the component at index in the Double Line Preferences.Parameters:
index The index of the component. penStyleLeft Returns the pen style of the component's left line. Positive values for patters, negative values for dash styles. penStyleRight Returns the pen style of the component's right line. Positive values for patterns, negative values for dash styles. See Also:
SetDLComponentPenStyles
| GetDLComponentPenWeights | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION GetDLComponentPenWeights
( index :INTEGER; VAR penWeightLeft :INTEGER; VAR penWeightRight :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, penWeightLeft, penWeightRight)
def vs.GetDLComponentPenWeights(index): Description:
Gets the pen weights of the left and right sides of the component at index in the Double Line Preferences.Parameters:
index The index of the component. penWeightLeft Returns the pen weight of the component's left line. penWeightRight Returns the pen weight of the component's right line. See Also:
SetDLComponentPenWeights
| GetDLComponentUseFillClassAttr | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetDLComponentUseFillClassAttr
( index :INTEGER; VAR useClassAttr :BOOLEAN ) :BOOLEAN ; Python:
return (BOOLEAN, useClassAttr)
def vs.GetDLComponentUseFillClassAttr(index): Description:
Gets the use fill class attributes flag of the component at index in the Double Line Preferences.Parameters:
index The index of the component. useClassAttr Returns whether or not the component is using class attributes for its fill. See Also:
SetDLComponentUseFillClassAttr
| GetDLComponentUsePenClassAttr | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetDLComponentUsePenClassAttr
( index :INTEGER; VAR leftPenUseClassAttr :BOOLEAN; VAR rightPenUseClassAttr :BOOLEAN ) :BOOLEAN ; Python:
return (BOOLEAN, leftPenUseClassAttr, rightPenUseClassAttr)
def vs.GetDLComponentUsePenClassAttr(index): Description:
Gets the useclass attributes flags of the left and right side pens of the component at index in the Double Line Preferences.Parameters:
index The index of the component. leftPenUseClassAttr Returns whether or not the component is using class attributes for its left pen. rightPenUseClassAttr Returns whether or not the component is using class attributes for right pen. See Also:
SetDLComponentUsePenClassAttr
| GetDLComponentWidth | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION GetDLComponentWidth
( index :INTEGER; VAR width :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, width)
def vs.GetDLComponentWidth(index): Description:
Gets the width of the component at index in the Double Line Preferences.Parameters:
index The index of the component. width Returns the width of the component. See Also:
SetDLComponentWidth
| GetDLControlOffset | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION GetDLControlOffset
:REAL ; Python:
return REAL
def vs.GetDLControlOffset(): Description:
Gets the Double Line Preferences control offset.See Also:
SetDLControlOffset
| GetDLOptions | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION GetDLOptions
:INTEGER ; Python:
return INTEGER
def vs.GetDLOptions(): Description:
Gets the Double Line Preferences options. 0 for Create Lines, 1 for Create Polygons, 2 for Create Lines and Polygons.See Also:
SetDLOptions
| GetDLSeparation | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION GetDLSeparation
:REAL ; Python:
return REAL
def vs.GetDLSeparation(): Description:
Gets the Double Line Preferences separation.See Also:
SetDLSeparation
| GetDrawingSizeRect | Document Settings VectorWorks8.0 |
VectorScript Declaration:
PROCEDURE GetDrawingSizeRect
( VAR p1X :REAL; VAR p1Y :REAL; VAR p2X :REAL; VAR p2Y :REAL ) ; Python:
return (p1, p2)
def vs.GetDrawingSizeRect(): Description:
Returns the top left and bottom right coordinates of a rectangle surrounding the entire area of the document containing objects.Parameters:
p1 Returns top left coordinate of drawing rectangle. p2 Returns bottom right coordinate of drawing rectangle.
| GetDrawingSizeRectN | Document Settings Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE GetDrawingSizeRectN
( hLayer :HANDLE; VAR p1X :REAL; VAR p1Y :REAL; VAR p2X :REAL; VAR p2Y :REAL ) ; Python:
return (p1, p2)
def vs.GetDrawingSizeRectN(hLayer): Description:
Returns the top left and bottom right coordinates of a rectangle surrounding the entire area of the document containing objects.
Similar to GetDrawingSizeRect but can work on specified layer.Parameters:
hLayer The layer to be used for calculating the drawing rectangle. p1 Returns top left coordinate of drawing rectangle. p2 Returns bottom right coordinate of drawing rectangle. See Also:
GetDrawingSizeRect
| GetFName | Document Settings MiniCAD |
VectorScript Declaration:
FUNCTION GetFName
:STRING ; Python:
return STRING
def vs.GetFName(): Description:
Function GetFName returns the current file name of the active document.
| GetNumberOfDLComponents | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION GetNumberOfDLComponents
( VAR numComponents:INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, numComponents)
def vs.GetNumberOfDLComponents(): Description:
Gets the number of components in the Double Line Preferences.Parameters:
numComponents Returns the number of components.
| GetOrigin | Document Settings MiniCAD |
VectorScript Declaration:
PROCEDURE GetOrigin
( VAR x :REAL; VAR y :REAL ) ; Python:
return (x, y)
def vs.GetOrigin(): Description:
Procedure GetOrigin returns the current origin location relative to the center of the page.
Parameters:
x Returns X coordinate of origin. y Returns Y coordinate of origin. Example:
PROCEDURE Example; VAR originPt :VECTOR; BEGIN GetOrigin(originPt.x, originPt.y); Message(originPt); END; RUN(Example);
| GetPref | Document Settings MiniCAD6.0 |
VectorScript Declaration:
FUNCTION GetPref
( prefIndex:INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.GetPref(prefIndex): Description:
Function GetPref returns the on-off status of the specified preference item.
A table of preference dialog items and their corresponding IDs may be found in the Appendix.
Parameters:
prefIndex Preference item constant. Example:
SelHandleStatus:=GetPref(17);
| GetPrefInt | Document Settings VectorWorks8.0 |
VectorScript Declaration:
FUNCTION GetPrefInt
( prefIndex:INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.GetPrefInt(prefIndex): Description:
Function GetPrefInt returns the value of a numeric Vectorworks preference setting.
A table of preference dialog items and their corresponding IDs may be found in the Appendix.
Parameters:
prefIndex Preference item constant. Result:
The status of the requested preference. If the preference is a checkbox, then GetPrefInt returns TRUE or false. If it is a radio group or editable text item, then GetPrefInt returns an integer value representing that setting.Example:
maxUndos:=GetPrefInt(17);
| GetPrefLongInt | Document Settings VectorWorks9.0 |
VectorScript Declaration:
FUNCTION GetPrefLongInt
( prefIndex:INTEGER ) :LONGINT ; Python:
return LONGINT
def vs.GetPrefLongInt(prefIndex): Description:
Returns the value of a Vectorworks preference setting. Used with preference settings returning a LONGINT value.
A table of preference dialog items and their corresponding IDs may be found in the Appendix.Parameters:
prefIndex Preference item index. Result:
Returns the value of the specified preference.
Example:
convertRes2D:= GetPrefLongInt(55);
| GetPrefReal | Document Settings VectorWorks9.0 |
VectorScript Declaration:
FUNCTION GetPrefReal
( prefIndex:INTEGER ) :REAL ; Python:
return REAL
def vs.GetPrefReal(prefIndex): Description:
Returns the value of a Vectorworks preference setting. Used with preference settings returning a REAL value.
A table of preference dialog items and their corresponding IDs may be found in the Appendix.
Parameters:
prefIndex Preference item index. Result:
Returns the value of the specified preference.Example:
upi:= GetPrefReal(152);
| GetPrefRGB | Document Settings Vectorworks 2009 |
VectorScript Declaration:
PROCEDURE GetPrefRGB
( prefIndex :INTEGER; VAR colorRV :LONGINT; VAR colorGV :LONGINT; VAR colorBV :LONGINT ) ; Python:
return (colorRV, colorGV, colorBV)
def vs.GetPrefRGB(prefIndex): Description:
Procedure GetPrefRGB return the RGB color components of the specified preference item. The RGB values are in the range of 0 - 65535.Parameters:
prefIndex Preference item constant colorRV Returns RGB color component (red) colorGV Returns RGB color component (green) colorBV Returns RGB color component (blue) See Also:
SetPrefRGB
| GetPrefString | Document Settings VectorWorks9.0 |
VectorScript Declaration:
FUNCTION GetPrefString
( prefIndex:INTEGER ) :STRING ; Python:
return STRING
def vs.GetPrefString(prefIndex): Description:
Returns the value of a Vectorworks preference setting. Used with preference settings returning a STRING value.
A table of preference dialog items and their corresponding IDs may be found in the Appendix.
Parameters:
prefIndex Preference item index. Result:
Returns the value of the specified preference.Example:
unitmark:=GetPrefString(154);
| GetWallPrefStyle | Document Settings VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetWallPrefStyle
:STRING ; Python:
return STRING
def vs.GetWallPrefStyle(): Description:
Gets the name of the current document default wall style
| GridLines | Document Settings MiniCAD |
VectorScript Declaration:
PROCEDURE GridLines
( gridDistance:REAL (Coordinate) ) ; Python:
return None
def vs.GridLines(gridDistance): Description:
Procedure GridLines sets the distance between the drawing grid lines in the document.
Parameters:
gridDistance Grid spacing distance.
| InsertNewDLComponent | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION InsertNewDLComponent
( beforeIndex :INTEGER; widthDistance :REAL (Coordinate); fill :LONGINT; penWeightLeft :INTEGER; penWeightRight :INTEGER; penStyleLeft :INTEGER; penStyleRight :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.InsertNewDLComponent(beforeIndex, widthDistance, fill, penWeightLeft, penWeightRight, penStyleLeft, penStyleRight): Description:
Inserts a new component before index in the Double Line Preferences.Parameters:
beforeIndex The index before which to insert the new component. widthDistance The width of the component. fill The fill of the component. Positive values for patterns, negative ref numbers for hatches. penWeightLeft The pen weight of the component's left line. penWeightRight The pen weight of the component's right line. penStyleLeft The pen style of the component's left line. Positive values for patterns, negative values for dash styles. penStyleRight The pen style of the component's right line. Positive values for patterns, negative values for dash styles. See Also:
DeleteDLComponent
| PenGrid | Document Settings MiniCAD |
VectorScript Declaration:
PROCEDURE PenGrid
( gridDistance:REAL (Coordinate) ) ; Python:
return None
def vs.PenGrid(gridDistance): Description:
Procedure PenGrid sets the snap grid distance in the document.
Parameters:
gridDistance Pen grid spacing.
| SetConstrain | Document Settings MiniCAD |
VectorScript Declaration:
PROCEDURE SetConstrain
( str:STRING ) ; Python:
return None
def vs.SetConstrain(str): Description:
Procedure SetConstrain sets the active drawing constraints for the document. Each constraint is represented by an ASCII character identifier; these characters are assembled into a string which determines the constraints to be activated.
Vectorworks Constraint Identifiers
Constraint Identifier Snap To Grid A Snap To Objects Q Constrain Angle S Snap Intersection W Smart Points D Snap To Distance E Smart Edge F Constrain Tangent R
Parameters:
str Constraint constant string. Example:
SetConstrain('QD'); {activates the snap objects and smart point constraints}
| SetDimStd | Document Settings MiniCAD4.0 |
VectorScript Declaration:
PROCEDURE SetDimStd
( whichStandard:INTEGER ) ; Python:
return None
def vs.SetDimStd(whichStandard): Description:
Procedure SetDimStd changes the default dimension standard of a Vectorworks document.
Built-in dimension standards are specified using index values of 1 thru 9, corresponding to the dimension standard preference menu. Custom dimensions are specified using indexes 0 thru -8, with 0 being the first custom dimension standard, -1 being the second, and so on.Parameters:
whichStandard Dimension standard constant. Example:
SetDimStd(2); {sets the dimension standard to ASME}
| SetDLComponentClass | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetDLComponentClass
( index :INTEGER; componentClass :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetDLComponentClass(index, componentClass): Description:
Sets the class of the component at index in the Double Line Preferences.Parameters:
index The index of the component. componentClass The class of the component. See Also:
GetDLComponentClass
| SetDLComponentFill | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION SetDLComponentFill
( index :INTEGER; fill :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetDLComponentFill(index, fill): Description:
Sets the fill of the component at index in the Double Line Preferences.Parameters:
index The index of the component. fill The fill of the component. Positive values for patterns, negative object indexes for hatches. See Also:
GetDLComponentFill
| SetDLComponentFillColors | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetDLComponentFillColors
( index :INTEGER; fillForeColor :INTEGER; fillBackColor :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetDLComponentFillColors(index, fillForeColor, fillBackColor): Description:
Sets the fore and back fill colors of the component at index in the Double Line Preferences.Parameters:
index The index of the component. fillForeColor The fore color of the fill. fillBackColor The back color of the fill. See Also:
GetDLComponentFillColors
| SetDLComponentName | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetDLComponentName
( index :INTEGER; componentName :STRING ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetDLComponentName(index, componentName): Description:
Sets the name of the component at index in the Double Line Preferences.Parameters:
index The index of the component. componentName The name of the component. See Also:
GetDLComponentName
| SetDLComponentPenColors | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetDLComponentPenColors
( index :INTEGER; leftPenForeColor :INTEGER; leftPenBackColor :INTEGER; rightPenForeColor :INTEGER; rightPenBackColor :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetDLComponentPenColors(index, leftPenForeColor, leftPenBackColor, rightPenForeColor, rightPenBackColor): Description:
Sets the fore and back colors of the left and right side pens of the component at index in the Double Line Preferences.Parameters:
index The index of the component. leftPenForeColor The fore color of the left pen. leftPenBackColor The back color of the left pen. rightPenForeColor The fore color of the right pen. rightPenBackColor The back color of the right pen. See Also:
GetDLComponentPenColors
| SetDLComponentPenStyles | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION SetDLComponentPenStyles
( index :INTEGER; penStyleLeft :INTEGER; penStyleRight :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetDLComponentPenStyles(index, penStyleLeft, penStyleRight): Description:
Sets the left and right pen styles for the component at index in the Double Line Preferences.Parameters:
index The index of the component. penStyleLeft The pen style of the component's left line. Positive values for patterns, negative values for dash styles. penStyleRight The pen style of the component's right line. Positive values for patterns, negative values for dash styles. See Also:
GetDLComponentPenStyles
| SetDLComponentPenWeights | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION SetDLComponentPenWeights
( index :INTEGER; penWeightLeft :INTEGER; penWeightRight :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetDLComponentPenWeights(index, penWeightLeft, penWeightRight): Description:
Sets the left and right pen weights for the component at index in the Double Line Preferences.Parameters:
index The index of the component. penWeightLeft The pen weight of the component's left line. penWeightRight The pen weight of the component's right line. See Also:
GetDLComponentPenWeights
| SetDLComponentUseFillClassAttr | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetDLComponentUseFillClassAttr
( index :INTEGER; useClassAttr :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetDLComponentUseFillClassAttr(index, useClassAttr): Description:
Sets the use fill class attributes flag of the component at index in the Double Line Preferences.Parameters:
index The index of the component. useClassAttr Whether or not the component will use class attributes for its fill. See Also:
GetDLComponentUseFillClassAttr
| SetDLComponentUsePenClassAttr | Document Settings VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetDLComponentUsePenClassAttr
( index :INTEGER; leftPenUseClassAttr :BOOLEAN; rightPenUseClassAttr :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetDLComponentUsePenClassAttr(index, leftPenUseClassAttr, rightPenUseClassAttr): Description:
Sets the useclass attributes flags of the left and right side pens of the component at index in the Double Line Preferences.Parameters:
index The index of the component. leftPenUseClassAttr Whether or not the component will use class attributes for its left pen. rightPenUseClassAttr Whether or not the component will use class attributes for its right pen. See Also:
GetDLComponentUsePenClassAttr
| SetDLComponentWidth | Document Settings VectorWorks12.5 |
VectorScript Declaration:
FUNCTION SetDLComponentWidth
( index :INTEGER; widthDistance :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetDLComponentWidth(index, widthDistance): Description:
Sets the width of the nth component of the Double Line Preferences, where n is equal to index.Parameters:
index The index of the component. widthDistance The width of the component. See Also:
GetDLComponentWidth
| SetDLControlOffset | Document Settings VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetDLControlOffset
( controlOffsetDistance:REAL (Coordinate) ) ; Python:
return None
def vs.SetDLControlOffset(controlOffsetDistance): Description:
Sets the Double Line Preferences control offset.Parameters:
controlOffsetDistance The control offset. See Also:
GetDLControlOffset
| SetDLOptions | Document Settings VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetDLOptions
( options:INTEGER ) ; Python:
return None
def vs.SetDLOptions(options): Description:
Gets the Double Line Preferences options. 0 for Create Lines, 1 for Create Polygons, 2 for Create Lines and Polygons.Parameters:
options The options. 0 for Create Lines, 1 for Create Polygons, 2 for Create Lines and Polygons. See Also:
GetDLOptions
| SetDLSeparation | Document Settings VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetDLSeparation
( separationDistance:REAL (Coordinate) ) ; Python:
return None
def vs.SetDLSeparation(separationDistance): Description:
Sets the Double Line Preferences separation.Parameters:
separationDistance The separation. See Also:
GetDLSeparation
| SetOrigin | Document Settings MiniCAD |
VectorScript Declaration:
PROCEDURE SetOrigin
( x :REAL; y :REAL ) ; Python:
return None
def vs.SetOrigin(x, y): Description:
Shifts the position of the document origin. The function does not modify the relative
positions of objects in the document; the coordinate locations of objects, however,
will change when the origin location is modified.
Parameters:
x X-offset from current origin. y Y-offset from current origin. Example:
Rect(0,0,1,1); SetOrigin(1,1); { Creates a rectangle with the bottom left point at coordinates (0,0), then moves the origin so that the top right point of the rectangle has coordinates (0,0). }See Also:
SetOriginAbsolute
| SetOriginAbsolute | Document Settings VectorWorks8.0 |
VectorScript Declaration:
PROCEDURE SetOriginAbsolute
( xValue :REAL; yValue :REAL ) ; Python:
return None
def vs.SetOriginAbsolute(xValue, yValue): Description:
Procedure SetOriginAbsolute sets the position of the origin relative to the center of the document drawing space.
Parameters:
xValue X coordinate of origin. yValue Y coordinate of origin. See Also:
SetOrigin
| SetPref | Document Settings MiniCAD6.0 |
VectorScript Declaration:
PROCEDURE SetPref
( index :INTEGER; status :BOOLEAN ) ; Python:
return None
def vs.SetPref(index, status): Description:
Procedure SetPref sets the on-off status of a Vectorworks preference dialog item. Parameter index specifies the preference item, and parameter status sets the on-off status of the item.
A table of preference dialog items and their corresponding IDs may be found in the Appendix.Parameters:
index Preference item constant. status On- off status of preference. Example:
SetPref(17,FALSE);
| SetPrefInt | Document Settings VectorWorks8.0 |
VectorScript Declaration:
PROCEDURE SetPrefInt
( index :INTEGER; value :INTEGER ) ; Python:
return None
def vs.SetPrefInt(index, value): Description:
Function SetPrefInt sets the value of a numeric Vectorworks preference setting.
A table of preference dialog items and their corresponding IDs may be found in the Appendix.
Parameters:
index Preference item constant. value New value for preference. Example:
SetPrefInt(17,FALSE);
| SetPrefLongInt | Document Settings VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE SetPrefLongInt
( index :INTEGER; value :LONGINT ) ; Python:
return None
def vs.SetPrefLongInt(index, value): Description:
Sets the value of the specified Vectorworks preference setting. Used with preference settings requiring a LONGINT value.
A table of preference dialog items and their corresponding IDs may be found in the Appendix.
Parameters:
index Preference item index. value New value for preference. Example:
SetPrefLongInt(55,128);
| SetPrefReal | Document Settings VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE SetPrefReal
( index :INTEGER; value :REAL ) ; Python:
return None
def vs.SetPrefReal(index, value): Description:
Sets the value of the specified Vectorworks preference setting. Used with preference settings requiring a REAL value.
A table of preference dialog items and their corresponding IDs may be found in the Appendix.
Parameters:
index Preference item index. value New value for preference. Example:
SetPrefReal(68,144);
| SetPrefRGB | Document Settings Vectorworks 2009 |
VectorScript Declaration:
PROCEDURE SetPrefRGB
( prefIndex :INTEGER; colorRV :LONGINT; colorGV :LONGINT; colorBV :LONGINT ) ; Python:
return None
def vs.SetPrefRGB(prefIndex, colorRV, colorGV, colorBV): Description:
Procedure SetPrefRGB return the RGB color components of the specified preference item. The color must be specified using the RGB components of the desired color. The RGB values are in the range of 0 - 65535.Parameters:
colorRV The RGB color component (red). colorGV The RGB color component (green). colorBV The RGB color component (blue).
| SetPrefString | Document Settings VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE SetPrefString
( index :INTEGER; value :STRING ) ; Python:
return None
def vs.SetPrefString(index, value): Description:
Sets the value of the specified Vectorworks preference setting. Used with preference settings requiring a STRING value.
A table of preference dialog items and their corresponding IDs may be found in the Appendix.
Parameters:
index Preference item index. value New value for preference. Example:
SetPrefString(154,'cubits');
| SetPrimaryDim | Document Settings MiniCAD7.0 |
VectorScript Declaration:
PROCEDURE SetPrimaryDim
( h :HANDLE; showValue :BOOLEAN; boxText :BOOLEAN; leader :STRING; trailer :STRING; precision :LONGINT ) ; Python:
return None
def vs.SetPrimaryDim(h, showValue, boxText, leader, trailer, precision): Description:
Procedure SetPrimaryDim sets the primary dimension options for single and dual dimensions.
Parameters:
h Handle to dimension. showValue Display dimension value flag. boxText Display box around dimension text flag. leader Leader string. trailer Trailer string. precision Precision setting for displayed dimension value. Example:
SetPrimaryDim(dimHd,TRUE,FALSE,'Approx.','',64);
| SetSecondaryDim | Document Settings MiniCAD7.0 |
VectorScript Declaration:
PROCEDURE SetSecondaryDim
( h :HANDLE; showValue :BOOLEAN; boxText :BOOLEAN; leader :STRING; trailer :STRING; precision :LONGINT ) ; Python:
return None
def vs.SetSecondaryDim(h, showValue, boxText, leader, trailer, precision): Description:
Procedure SetSecondaryDim sets the dimension options that are specific to the secondary portion of a dual dimension. This procedure can only be used for dual dimensions.Parameters:
h Handle to dimension. showValue Display dimension value flag. boxText Display box around dimension text flag. leader Leader string. trailer Trailer string. precision Precision setting for displayed dimension value. Example:
SetSecondaryDim(dimHd,TRUE,FALSE,'Approx.','',64);
| SetUnits | Document Settings MiniCAD |
VectorScript Declaration:
PROCEDURE SetUnits
( fraction :LONGINT; display :LONGINT; format :INTEGER; upi :REAL; name :STRING; squareName :STRING ) ; Python:
return None
def vs.SetUnits(fraction, display, format, upi, name, squareName): Description:
Procedure SetUnits sets low-level unit values in a Vectorworks document.
If only one of the units values is to be modified, GetUnits should be called first, and the values retrieved from that call should be passed back into SetUnits.
To specify a standard units setting with default values, use Units. To specify a standard units setting, but with some modified values, use PrimaryUnit.
Vectorworks Unit Formats
Units Format Format Flag Decimal 0 Fractional 1 Decimal Feet and Inches 2 Fractional Feet and Inches 3 Parameters:
fraction Stored accuracy for the document. display Minimum display accuracy for the document. format Unit format style. upi Units per inch. name Unit label for displayed values squareName Squared unit label for displayed values. Example:
SetUnits(4096,64,3,1.0,'"','sq ft');
| SetWallPrefStyle | Document Settings VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetWallPrefStyle
( sysName:STRING ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetWallPrefStyle(sysName): Description:
Set the document default wall preferences to match the Wall Style identified by sysName.