DeleteAllDLComponents Document Settings 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   DeleteAllDLComponents
:BOOLEAN ;

Python:

def  vs.DeleteAllDLComponents():
   return BOOLEAN

Description:

Deletes all components in the Double Line Preferences.

説明

「ダブルラインの設定」の全構成要素を削除します。



  DeleteDLComponent Document Settings 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   DeleteDLComponent
( index:INTEGER ) :BOOLEAN ;

Python:

def  vs.DeleteDLComponent(index):
   return BOOLEAN

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:

def  vs.DoubLines(doubleLineDistance):
   return None

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:

def  vs.DrwSize(rows, columns):
   return None

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:

def  vs.GetCurrentPlanarRefID():
   return LONGINT

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:

def  vs.GetDefaultTextSize():
   return REAL

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:

def  vs.GetDLComponentClass(index):
   return (BOOLEAN, componentClass)

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:

def  vs.GetDLComponentFill(index):
   return (BOOLEAN, fill)

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:

def  vs.GetDLComponentFillColors(index):
   return (BOOLEAN, fillForeColor, fillBackColor)

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:

def  vs.GetDLComponentName(index):
   return STRING

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:

def  vs.GetDLComponentPenColors(index):
   return (BOOLEAN, leftPenForeColor, leftPenBackColor, rightPenForeColor, rightPenBackColor)

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 - obsolete as of Vectorworks 2019

VectorScript Declaration:

FUNCTION   GetDLComponentPenStyles
(   index :INTEGER;
  VAR  penStyleLeft :INTEGER;
  VAR  penStyleRight :INTEGER
) :BOOLEAN ;

Python:

def  vs.GetDLComponentPenStyles(index):
   return (BOOLEAN, penStyleLeft, penStyleRight)

Special Notes:

GetDLComponentPenStyles is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use GetDLCompPenStylesN instead.

説明

「ダブルラインの設定」で、指定した番号の構成要素から左右の線の種類を取得します。

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:

GetDLCompPenStylesN  



  GetDLComponentPenWeights Document Settings 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   GetDLComponentPenWeights
(   index :INTEGER;
  VAR  penWeightLeft :INTEGER;
  VAR  penWeightRight :INTEGER
) :BOOLEAN ;

Python:

def  vs.GetDLComponentPenWeights(index):
   return (BOOLEAN, penWeightLeft, penWeightRight)

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:

def  vs.GetDLComponentUseFillClassAttr(index):
   return (BOOLEAN, useClassAttr)

Description:

Gets the use fill class attributes flag of the component at index in the Double Line Preferences.

説明

「ダブルラインの設定」の、番号で指定した構成要素の面の模様に、クラス属性を使っている場合はTRUEを返します。

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:

def  vs.GetDLComponentUsePenClassAttr(index):
   return (BOOLEAN, leftPenUseClassAttr, rightPenUseClassAttr)

Description:

Gets the useclass attributes flags of the left and right side pens of the component at index in the Double Line Preferences.

説明

「ダブルラインの設定」の、番号で指定した構成要素の左右の線種に、クラス属性を使っている場合はTRUEを返します。

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:

def  vs.GetDLComponentWidth(index):
   return (BOOLEAN, width)

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  



  GetDLCompPenStylesN Document Settings 
Vectorworks 2019

VectorScript Declaration:

FUNCTION   GetDLCompPenStylesN
(   index :INTEGER;
  VAR  penStyleLeft :LONGINT;
  VAR  penStyleRight :LONGINT
) :BOOLEAN ;

Python:

def  vs.GetDLCompPenStylesN(index):
   return (BOOLEAN, penStyleLeft, penStyleRight)

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 line types. 左側の線のスタイル(正の値:パターン,負の値:線の種類)
penStyleRight Returns the pen style of the component's right line. Positive values for patterns, negative values for line types. 右側の線のスタイル(正の値:パターン,負の値:線の種類)

See Also:

SetDLCompPenStylesN  



  GetDLControlOffset Document Settings 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   GetDLControlOffset
:REAL ;

Python:

def  vs.GetDLControlOffset():
   return REAL

Description:

Gets the Double Line Preferences control offset.

説明

「ダブルラインの設定」の、オフセットの値を返します。

See Also:

SetDLControlOffset  



  GetDLOptions Document Settings 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   GetDLOptions
:INTEGER ;

Python:

def  vs.GetDLOptions():
   return INTEGER

Description:

Gets the Double Line Preferences options. 0 for Create Lines, 1 for Create Polygons, 2 for Create Lines and Polygons.

説明

「ダブルラインの設定」オプションを取得します。(0:線を作る/1:面を作る/2:線と面を作る)

See Also:

SetDLOptions  



  GetDLSeparation Document Settings 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   GetDLSeparation
:REAL ;

Python:

def  vs.GetDLSeparation():
   return REAL

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:

def  vs.GetDrawingSizeRect():
   return (p1, p2)

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:

def  vs.GetDrawingSizeRectN(hLayer):
   return (p1, p2)

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.

説明

オブジェクトが含まれるファイルの全域を囲む四角形の、左上と右下の座標を返します。

GetDrawingSizeRectと同様であるが、特定のレイヤに対して機能します。

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:

def  vs.GetFName():
   return STRING

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:

def  vs.GetNumberOfDLComponents():
   return (BOOLEAN, numComponents)

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:

def  vs.GetOrigin():
   return (x, y)

Description:

Procedure GetOrigin returns the current origin location relative to the center of the page.

説明

現在の原点位置を座標で返します。GetOriginInDocUnits を参照してください。

Parameters:

x Returns X coordinate of origin. 原点のX座標
y Returns Y coordinate of origin. 原点のY座標

Example:

PROCEDURE Example;
VAR
   originPt :VECTOR;
BEGIN
   GetOrigin(originPt.x, originPt.y);
   Message(originPt);
END;
RUN(Example);



  GetOriginInDocUnits Document Settings 
Vectorworks 2016

VectorScript Declaration:

PROCEDURE   GetOriginInDocUnits
( VAR  x :REAL;
  VAR  y :REAL
) ;

Python:

def  vs.GetOriginInDocUnits():
   return (x, y)

Description:

Procedure GetOriginInDocUnits returns the current origin location relative to the center of the page in current units. It fixes the problem existing for GetOrigin (see remarks). The behavior is the same while used during objects reset and in commands.

説明

用紙中心に対する原点の位置を、現在の単位で返します。GetOrigin の問題が改善されています。

Parameters:

x Returns X coordinate of origin. 原点のX座標
y Returns Y coordinate of origin. 原点のY座標

Example:

PROCEDURE Example;
VAR
originPt : VECTOR;
BEGIN
GetOriginInDocUnits(originPt.x, originPt.y);
Message(originPt);
END;
RUN(Example);

See Also:

GetOrigin  



  GetPref Document Settings 
MiniCAD6.0

VectorScript Declaration:

FUNCTION   GetPref
( prefIndex:INTEGER ) :BOOLEAN ;

Python:

def  vs.GetPref(prefIndex):
   return BOOLEAN

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.

説明

環境設定の指定した項目の選択状態をBOOLEAN型の値で返します。

Parameters:

prefIndex Preference item constant. 識別番号

Example:

SelHandleStatus:=GetPref(17);



  GetPrefInt Document Settings 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetPrefInt
( prefIndex:INTEGER ) :INTEGER ;

Python:

def  vs.GetPrefInt(prefIndex):
   return INTEGER

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.

説明

環境設定の指定した項目に設定されているINTEGER型の値を返します。

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.

返り値

INTEGER型の値を返します。

Example:

maxUndos:=GetPrefInt(17);



  GetPrefLongInt Document Settings 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetPrefLongInt
( prefIndex:INTEGER ) :LONGINT ;

Python:

def  vs.GetPrefLongInt(prefIndex):
   return LONGINT

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.

説明

環境設定の指定した項目に設定されているLONGINT型の値を返します。

Parameters:

prefIndex Preference item index. 識別番号

Result:

Returns the value of the specified preference.

返り値

LONGINT型の値を返します。

Example:

convertRes2D:= GetPrefLongInt(55);



  GetPrefReal Document Settings 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetPrefReal
( prefIndex:INTEGER ) :REAL ;

Python:

def  vs.GetPrefReal(prefIndex):
   return REAL

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.

説明

環境設定の指定した項目に設定されているREAL型の値を返します。

Parameters:

prefIndex Preference item index. 識別番号

Result:

Returns the value of the specified preference.

返り値

REAL型の値を返します。

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:

def  vs.GetPrefRGB(prefIndex):
   return (colorRV, colorGV, colorBV)

Description:

Procedure GetPrefRGB return the RGB color components of the specified preference item. The RGB values are in the range of 0 - 65535.

説明

指定した項目の色成分を返します。値の範囲は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:

def  vs.GetPrefString(prefIndex):
   return STRING

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.

説明

環境設定の指定した項目に設定されているSTRING型の値を返します。

Parameters:

prefIndex Preference item index. 識別番号

Result:

Returns the value of the specified preference.

返り値

STRING型の値を返します。

Example:

unitmark:=GetPrefString(154);



  GetWallPrefStyle Document Settings 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   GetWallPrefStyle
:STRING ;

Python:

def  vs.GetWallPrefStyle():
   return STRING

Description:

Gets the name of the current document default wall style

説明

アクティブドキュメントのデフォルト壁スタイルの名前が返ります。



  GridLines Document Settings 
MiniCAD

VectorScript Declaration:

PROCEDURE   GridLines
( gridDistance:REAL (Coordinate) ) ;

Python:

def  vs.GridLines(gridDistance):
   return None

Description:

Procedure GridLines sets the distance between the drawing grid lines in the document.

説明

グリッドの幅を設定します。

Parameters:

gridDistance Grid spacing distance. グリッドの幅



  InsertNewDLCompN Document Settings 
Vectorworks 2019

VectorScript Declaration:

FUNCTION   InsertNewDLCompN
(   beforeIndex :INTEGER;
    widthDistance :REAL (Coordinate);
    fill :LONGINT;
    penWeightLeft :INTEGER;
    penWeightRight :INTEGER;
    penStyleLeft :LONGINT;
    penStyleRight :LONGINT
) :BOOLEAN ;

Python:

def  vs.InsertNewDLCompN(beforeIndex, widthDistance, fill, penWeightLeft, penWeightRight, penStyleLeft, penStyleRight):
   return BOOLEAN

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 line types. 構成要素の左側の線の種類
破線の種類は負の値で指定します。
penStyleRight The pen style of the component's right line. Positive values for patterns, negative values for line types. 構成要素の右側の線の種類
破線の種類は負の値で指定します。

See Also:

DeleteDLComponent  



  InsertNewDLComponent Document Settings 
VectorWorks12.5 - obsolete as of Vectorworks 2019

VectorScript Declaration:

FUNCTION   InsertNewDLComponent
(   beforeIndex :INTEGER;
    widthDistance :REAL (Coordinate);
    fill :LONGINT;
    penWeightLeft :INTEGER;
    penWeightRight :INTEGER;
    penStyleLeft :INTEGER;
    penStyleRight :INTEGER
) :BOOLEAN ;

Python:

def  vs.InsertNewDLComponent(beforeIndex, widthDistance, fill, penWeightLeft, penWeightRight, penStyleLeft, penStyleRight):
   return BOOLEAN

Special Notes:

InsertNewDLComponent is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use InsertNewDLCompN instead.

説明

「ダブルラインの設定」の、番号で指定した構成要素の前に新しい構成要素を挿入します。

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:

InsertNewDLCompN  



  PenGrid Document Settings 
MiniCAD

VectorScript Declaration:

PROCEDURE   PenGrid
( gridDistance:REAL (Coordinate) ) ;

Python:

def  vs.PenGrid(gridDistance):
   return None

Description:

Procedure PenGrid sets the snap grid distance in the document.

説明

スナップグリッドの幅を設定します。

Parameters:

gridDistance Pen grid spacing. スナップグリッドの幅



  RunGridSettingsDlg Document Settings 
Vectorworks 2022

VectorScript Declaration:

PROCEDURE   RunGridSettingsDlg
;

Python:

def  vs.RunGridSettingsDlg():
   return None

Description:

This procedure will show the grid settings dialog and handle related undo.

説明

グリッド設定ダイアログボックスを表示します。



  SetConstrain Document Settings 
MiniCAD

VectorScript Declaration:

PROCEDURE   SetConstrain
( str:STRING ) ;

Python:

def  vs.SetConstrain(str):
   return None

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


説明

スナップパレットのON/OFFを設定します。

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:

def  vs.SetDimStd(whichStandard):
   return None

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:

def  vs.SetDLComponentClass(index, componentClass):
   return BOOLEAN

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:

def  vs.SetDLComponentFill(index, fill):
   return BOOLEAN

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:

def  vs.SetDLComponentFillColors(index, fillForeColor, fillBackColor):
   return BOOLEAN

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:

def  vs.SetDLComponentName(index, componentName):
   return BOOLEAN

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:

def  vs.SetDLComponentPenColors(index, leftPenForeColor, leftPenBackColor, rightPenForeColor, rightPenBackColor):
   return BOOLEAN

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 - obsolete as of Vectorworks 2019

VectorScript Declaration:

FUNCTION   SetDLComponentPenStyles
(   index :INTEGER;
    penStyleLeft :INTEGER;
    penStyleRight :INTEGER
) :BOOLEAN ;

Python:

def  vs.SetDLComponentPenStyles(index, penStyleLeft, penStyleRight):
   return BOOLEAN

Special Notes:

SetDLComponentPenStyles is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use SetDLCompPenStylesN instead.

説明

「ダブルラインの設定」で、指定した番号の構成要素の左右の線の種類を設定します。

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:

SetDLCompPenStylesN  



  SetDLComponentPenWeights Document Settings 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   SetDLComponentPenWeights
(   index :INTEGER;
    penWeightLeft :INTEGER;
    penWeightRight :INTEGER
) :BOOLEAN ;

Python:

def  vs.SetDLComponentPenWeights(index, penWeightLeft, penWeightRight):
   return BOOLEAN

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:

def  vs.SetDLComponentUseFillClassAttr(index, useClassAttr):
   return BOOLEAN

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:

def  vs.SetDLComponentUsePenClassAttr(index, leftPenUseClassAttr, rightPenUseClassAttr):
   return BOOLEAN

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:

def  vs.SetDLComponentWidth(index, widthDistance):
   return BOOLEAN

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  



  SetDLCompPenStylesN Document Settings 
Vectorworks 2019

VectorScript Declaration:

FUNCTION   SetDLCompPenStylesN
(   index :INTEGER;
    penStyleLeft :LONGINT;
    penStyleRight :LONGINT
) :BOOLEAN ;

Python:

def  vs.SetDLCompPenStylesN(index, penStyleLeft, penStyleRight):
   return BOOLEAN

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 line types. 左側の線のスタイル(正の値:パターン,負の値:線の種類)
penStyleRight The pen style of the component's right line. Positive values for patterns, negative values for line types. 右側の線のスタイル(正の値:パターン,負の値:線の種類)

See Also:

GetDLCompPenStylesN  



  SetDLControlOffset Document Settings 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   SetDLControlOffset
( controlOffsetDistance:REAL (Coordinate) ) ;

Python:

def  vs.SetDLControlOffset(controlOffsetDistance):
   return None

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:

def  vs.SetDLOptions(options):
   return None

Description:

Gets the Double Line Preferences options. 0 for Create Lines, 1 for Create Polygons, 2 for Create Lines and Polygons.

説明

「ダブルラインの設定」の「線と面の設定」を設定します。
(0:線を作る/1:面を作る/2:線と面を作る)

Parameters:

options The options. 0 for Create Lines, 1 for Create Polygons, 2 for Create Lines and Polygons. 線と面の設定
0:線を作る/1:面を作る/2:線と面を作る

See Also:

GetDLOptions  



  SetDLSeparation Document Settings 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   SetDLSeparation
( separationDistance:REAL (Coordinate) ) ;

Python:

def  vs.SetDLSeparation(separationDistance):
   return None

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:

def  vs.SetOrigin(x, y):
   return None

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. 原点のX座標
y Y-offset from current origin. 原点のY座標

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:

def  vs.SetOriginAbsolute(xValue, yValue):
   return None

Description:

Procedure SetOriginAbsolute sets the position of the origin relative to the center of the document drawing space.

説明

原点の位置を絶対座標で設定します。

Parameters:

xValue X coordinate of origin. 原点のX座標
yValue Y coordinate of origin. 原点のY座標

See Also:

SetOrigin  



  SetPref Document Settings 
MiniCAD6.0

VectorScript Declaration:

PROCEDURE   SetPref
(   index :INTEGER;
    status :BOOLEAN
) ;

Python:

def  vs.SetPref(index, status):
   return None

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.

説明

環境設定の指定した項目の選択状態をBOOLEAN型の値で設定します。

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:

def  vs.SetPrefInt(index, value):
   return None

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.

説明

環境設定の指定した項目をINTEGER型の値で設定します。

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:

def  vs.SetPrefLongInt(index, value):
   return None

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.


説明

環境設定の指定した項目をLONGINT型の値で設定します。

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:

def  vs.SetPrefReal(index, value):
   return None

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.

説明

環境設定の指定した項目をREAL型の値で設定します。

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:

def  vs.SetPrefRGB(prefIndex, colorRV, colorGV, colorBV):
   return None

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.

説明

指定した項目の色成分を設定します。値の範囲は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:

def  vs.SetPrefString(index, value):
   return None

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.

説明

環境設定の指定した項目をSTRING型の値で設定します。

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:

def  vs.SetPrimaryDim(h, showValue, boxText, leader, trailer, precision):
   return None

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:

def  vs.SetSecondaryDim(h, showValue, boxText, leader, trailer, precision):
   return None

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:

def  vs.SetUnits(fraction, display, format, upi, name, squareName):
   return None

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:

def  vs.SetWallPrefStyle(sysName):
   return BOOLEAN

Description:

Set the document default wall preferences to match the Wall Style identified by sysName.

説明

アクティブドキュメントのデフォルト壁スタイルを設定します。