VectorScript Declaration:

PROCEDURE   Absolute

;

Python:

def  vs.Absolute():

   return None

Description:

Sets the point designation method for VectorScript procedure calls. When this mode is active, all points specified in procedure calls are assumed to be coordinate locations within the document.

説明

座標指定を絶対指定にします。

Example:

Absolute;
ClosePoly;
Poly(0,0,1,1,1,2,2,2,2,0);

VectorScript Declaration:

FUNCTION   AcquireExportPDFSettingsAndLocation

( inbSeparateDocuments:BOOLEAN ) :BOOLEAN ;

Python:

def  vs.AcquireExportPDFSettingsAndLocation(inbSeparateDocuments):

   return BOOLEAN

Description:

Asks the user for the Export PDF settings and the PDF file name (or folder name if the parameter is true). This is intended to support Batch PDF Export.

説明

「PDF取り出し」の設定ダイアログとPDFファイル名（パラメータをTRUEにした場合は保存先のフォルダ名）を設定するダイアログを表示します。PDFの一括取り出しに対応します。

VectorScript Declaration:

PROCEDURE   AngleVar

;

Python:

def  vs.AngleVar():

   return None

Description:

Sets the angle designation method in VectorScript. When called, VectorScript will treat language symbols which can be interpreted as direction angles (e.g., N, S, NW, SE) as variables rather than angles.

説明

変数を極座標として角度指定に使用することを宣言します。

Example:

procedure test;
var
	S : Real;

begin
	AngleVar;
	S := 30;
	LineTo(3", #S);
	{ The 'S' will be treated as a variable }
	{ and line will be drawn on 30 degree angle. }

end;
run(test);

VectorScript Declaration:

PROCEDURE   ClosePDFDocument

;

Python:

def  vs.ClosePDFDocument():

   return None

Description:

This will finish creating the PDF document that you started with OpenPDFDocument. This is intended to support Batch Export to PDF.

説明

OpenPDFDocumentで開始されたPDFドキュメントの作成プロセスが完了します。これは、PDFの一括取り出しに対応するための操作です。

VectorScript Declaration:

PROCEDURE   DoMenuText

( menuItem:STRING ) ;

Python:

def  vs.DoMenuText(menuItem):

   return None

Special Notes:

DoMenuText is obsolete as of VectorWorks8.0

Description:

Obsolete procedure.

説明

指定した名前のメニューを実行します。ワークシートのメニューを実行する場合は、頭に「WS」を付けます（「WS」は半角英字）。
使用できなくなった関数／手続きです。

Parameters:

menuItem

Menu item name.

メニューの名前

See Also:

DoMenuTextByName  

VectorScript Declaration:

PROCEDURE   DoMenuTextByName

(   subMenu :STRING;     index :INTEGER ) ;

Python:

def  vs.DoMenuTextByName(subMenu, index):

   return None

Description:

Calls the specified Vectorworks menu command item.

If the item is part of a Vectorworks menu chunk, pass the position of the item within the chunk as the second parameter. For menu items that are not part of a chunk, pass 0 as the second parameter.

Note: DoMenuTextByName uses the internal Vectorworks menu item name to reference the menu command, and calls to this procedure will work on localized (international) versions of Vectorworks without modification. Note also that when calling VS plug-ins, you have to use the filename (which could be different from the internal plug-in name).

A table listing DoMenuTextByName values can be found in the VectorScript Appendix.

説明

VectorWorksのメニューコマンドを実行します。
実行する項目がメニューチャンクの一部の場合は、2番目のパラメータにチャンク内での位置を設定します。メニューチャンクの一部でない場合は、2番目のパラメータに0を設定します。

※チャンクとは類似した機能をもつメニューが1つにまとめられているものです。作業画面などを作成／編集する際に「3Dをみる」というチャンクになっているメニューを組み込むと「2Dへ戻る」、「上」、「左斜め下後方」など15個のメニューが組み込まれます。チャンクになっているメニューの8番目である「斜め右」を選択するには、以下のように記述します。
DoMenuTextByName('Standard Views',8);

Parameters:

subMenu	Menu item selector.	メニューセレクタ
index	Menu chunk item position (range of 1 - n).	チャンクメニュー番号（1からnの範囲）

Example:

PROCEDURE DoMenuTextByNameExample;
BEGIN
	DoMenuTextByName('Print',0); {calls the print dialog}
	DoMenuTextByName('Standard Views',8); {sets view to right isometric}
END;
RUN(DoMenuTextByNameExample);

VectorScript Declaration:

FUNCTION   ExportPDFPages

( savedViewNameStr:DYNARRAY[] of CHAR ) :INTEGER ;

Python:

def  vs.ExportPDFPages(savedViewNameStr):

   return INTEGER

Description:

This will export the current document to PDF. You must call OpenPDFDocument before calling this function. This is intended to support Batch Export to PDF.

説明

現在のドキュメントがPDFとして取り出されます。この関数を使用する前にOpenPDFDocumentを使用する必要があります。これは、PDFの一括取り出しに対応するための操作です。

VectorScript Declaration:

PROCEDURE   Move

(   moveDX :REAL;     moveDY :REAL ) ;

Python:

def  vs.Move(move):

   return None

Description:

Sets the position of the graphics pen in the Vectorworks document by moving a specified distance from the current pen location.

Horizontal and vertical offsets from the initial location. The final position of the pen at a point whose coordinates are (x+moveDX, y+moveDY).

説明

現在のペン位置を相対的に移動します。

Parameters:

move

X-Y offset distance.

X、Y軸方向への移動距離

Example:

Move(6,1);
{ moves the graphics pen 6 units to the right }
{ and 1 unit up from the current position.    }

See Also:

MoveTo  

VectorScript Declaration:

PROCEDURE   MoveTo

(   pX :REAL;     pY :REAL ) ;

Python:

def  vs.MoveTo(p):

   return None

Description:

Sets the position of the graphics pen in the Vectorworks document using absolute coordinate values. The parameter specifies the X-Y coordinate location where the pen should be moved.

説明

ペン位置を絶対座標の位置に移動します。

Parameters:

p

X-Y coordinate location.

X、Y座標

Example:

MoveTo(4,3);
{moves the graphics pen to (4,3)}

See Also:

Move  

VectorScript Declaration:

PROCEDURE   NoAngleVar

;

Python:

def  vs.NoAngleVar():

   return None

Description:

Sets the angle designation method in VectorScript. When called, VectorScript will treat language symbols which can be interpreted as direction angles (e.g., N, S, NW, SE) as as angles, rather than as variables.

説明

AngleVarの宣言を解除します。

Example:

procedure test;
var
	S : Real;

begin
	NoAngleVar;
	S := 30;
	LineTo(3", #S);
	{ The 'S' will be treated as the direction 'South'  }
	{ and line will be drawn on 270 degree angle. }

end;
run(test);

VectorScript Declaration:

FUNCTION   OpenPDFDocument

( inFilenameStr:DYNARRAY[] of CHAR ) :BOOLEAN ;

Python:

def  vs.OpenPDFDocument(inFilenameStr):

   return BOOLEAN

Description:

Begins the export to a PDF document. You must call AcquireExportPDFSettingsAndLocation before calling this function. This is intended to support Batch PDF Export.

説明

PDFドキュメントへの取り出しを開始します。この関数を使用する前にAcquireExportPDFSettingsAndLocationを使用する必要があります。これは、PDFの一括取り出しに対応するための操作です。

VectorScript Declaration:

PROCEDURE   PenLoc

( VAR  pX :REAL;   VAR  pY :REAL ) ;

Python:

def  vs.PenLoc():

   return p

Description:

Returns the current coordinate location of the graphics pen.

説明

現在のペンの座標位置を返します。

Parameters:

p

The current location of the graphics pen.

ペンのX、Y座標

Example:

PenLoc(theXCoord,theYCoord);

VectorScript Declaration:

PROCEDURE   PopAttrs

;

Python:

def  vs.PopAttrs():

   return None

Description:

Restores the attribute, tool, and constraint settings saved by an earlier call to PushAttrs.

説明

記憶されている属性を現在の設定にします。

Example:

PROCEDURE Example;
BEGIN
  PushAttrs;
  PenFore(215);
  PenBack(5);
  PenPat(25);
  PenSize(42);
  PenPat(25);
  SetConstrain('q');
  CallTool(-201);
  PopAttrs;
END;
RUN(Example);

See Also:

PushAttrs  

VectorScript Declaration:

FUNCTION   PrintUsingPrintDialog

:INTEGER ;

Python:

def  vs.PrintUsingPrintDialog():

   return INTEGER

Description:

Available in Industry Series products only. Prints the active document. The Print Dialog will be displayed. The PageSetup dialog will be displayed, before the print dialog, if the existing print settings are not valid for the current printer.

Table - Return Values

Return Value	Status
0	User cancelled
1	Success
2	Failure

説明

アクティブなドキュメントをプリントします。プリントダイアログが表示されます。用紙設定が正しくない場合は、プリントダイアログの前に用紙設定ダイアログが表示されます。

VectorScript Declaration:

FUNCTION   PrintWithoutUsingPrintDialog

:INTEGER ;

Python:

def  vs.PrintWithoutUsingPrintDialog():

   return INTEGER

Description:

Available in Industry Series products only. Prints the active document. Neither the Print Dialog nor the PageSetup dialog will be displayed. This function can fail with certain printers if PrintUsingPrintDialog had not previously been called for the active document.

Table - Return Values

Return Value	Status
0	User cancelled
1	Success
2	Failure

説明

アクティブなドキュメントをプリントします。プリントダイアログ、用紙設定ダイアログのどちらも表示しません。

VectorScript Declaration:

PROCEDURE   PushAttrs

;

Python:

def  vs.PushAttrs():

   return None

Description:

Stores current attribute, tool, text, and constraint settings for later retrieval as the document default settings. Document settings can be modified as needed after using this call, and the stored settings can be restored with a call to PopAttrs. Calling this function more than once (nested) is allowed. The settings will be placed on a stack, and will be retrieved by calls to PopAttrs in the correct sequence.

説明

現在の属性の設定を記憶します。

Example:

PROCEDURE Example;
BEGIN
  PushAttrs;
  PenFore(215);
  PenBack(5);
  PenPat(25);
  PenSize(42);
  PenPat(25);
  SetConstrain('q');
  CallTool(-201);
  PopAttrs;
END;
RUN(Example);

See Also:

PopAttrs  

VectorScript Declaration:

PROCEDURE   Relative

;

Python:

def  vs.Relative():

   return None

Description:

Sets the point designation method for VectorScript procedure calls.

When this mode is active, all points specified in procedure calls are assumed to be X-Y offsets from the current graphics pen location. For example, the point designation (0,2) will move the graphics pen two vertical units away from its present location.

説明

座標指定を相対指定にします。

Example:

Relative;
ClosePoly;
Poly(0,0,1,1,1,2,2,2,2,0);

VectorScript Declaration:

PROCEDURE   Run

( p:PROCEDURE ) ;

Python:

def  vs.Run(p):

   return None

Description:

Initiates the execution of a VectorScript command by signalling the VectorScript interpreter to execute the script source code.

The procedure takes a single parameter, which is the name of the VectorScript command as defined at the beginning of the source code listing.

説明

VectorScript プログラムを実行します。

返り値

プログラム名

Example:

PROCEDURE Example;
BEGIN
	Sysbeep;
	Sysbeep;
	Sysbeep;
END;
RUN(Example);

VectorScript Declaration:

PROCEDURE   SetTool

( theTool:INTEGER ) ;

Python:

def  vs.SetTool(theTool):

   return None

Description:

Activates the specified Vectorworks tool for use. The tool remains selected as the active tool after use.

Note: Please refer to the VectorScript Appendix for specific tool ID values.

説明

ツールパレットからツールを選択します。ツールが使われた後も、そのツールを選択したままにします。

Parameters:

theTool

Vectorworks tool constant.

ツール番号

Example:

SetTool(-203);

See Also:

CallTool