AddButtonMode Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   AddButtonMode
( imageSpecifier:DYNARRAY[] of CHAR ) ;

Python:

def  vs.AddButtonMode(imageSpecifier):
   return None

Description:

Adds an image button to the mode bar for a tool. Replaces vstAddButtonMode.

説明

ツールのモードバーにボタンイメージを追加します。vstAddButtonModeの代わりに使用してください。

Parameters:

imageSpecifier The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)



  AddChoice Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   AddChoice
(   dialogID :LONGINT;
    componentID :LONGINT;
    choiceText :STRING;
    itemIndex :INTEGER
) ;

Python:

def  vs.AddChoice(dialogID, componentID, choiceText, itemIndex):
   return None

Description:

Adds an item to the component's choices.

説明

プルダウンメニューやリストアイテムに項目を追加します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier for the component that contains the choices. アイテム番号
choiceText The text for the item that is about to be added. 追加する項目の文字列
itemIndex The index after which the new item is to be added. 追加する項目のインデックス番号



  AddListBoxTabStop Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   AddListBoxTabStop
(   dialogID :LONGINT;
    itemID :LONGINT;
    tabStop :INTEGER
) ;

Python:

def  vs.AddListBoxTabStop(dialogID, itemID, tabStop):
   return None

Description:

Adds a tab stop to a Layout Manager list box. The last parameter is the tab stop, in characters. This function should be called in the dialog handler, as opposed to the dialog definition procedure. This function will clear all data in the list control.

説明

リストボックスにタブストップを設定します。

Parameters:

dialogID ID of the dialog ダイアログ番号
itemID ID of the list box リストボックスアイテム番号
tabStop The tab stop, in characters タブストップ

See Also:

RemoveListBoxTabStop  



  AddRadioMode Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   AddRadioMode
(   initialSetting :INTEGER;
    buttonCount :INTEGER;
    imageSpecifier1 :DYNARRAY[] of CHAR;
    imageSpecifier2 :DYNARRAY[] of CHAR;
    imageSpecifier3 :DYNARRAY[] of CHAR;
    imageSpecifier4 :DYNARRAY[] of CHAR;
    imageSpecifier5 :DYNARRAY[] of CHAR;
    imageSpecifier :DYNARRAY[] of CHAR
) ;

Python:

def  vs.AddRadioMode(initialSetting, buttonCount, imageSpecifier1, imageSpecifier2, imageSpecifier3, imageSpecifier4, imageSpecifier5, imageSpecifier):
   return None

Description:

Adds a group of buttons with an image to the mode bar for a tool. Replaces vstAddRadioMode

説明

ツールのモードバーにボタンイメージのグループを追加します。vstAddRadioModeの代わりに使用してください。

Parameters:

imageSpecifier1 The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)
imageSpecifier2 The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)
imageSpecifier3 The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)
imageSpecifier4 The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)
imageSpecifier5 The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)
imageSpecifier The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)



  AdjustComponentPixelPos Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   AdjustComponentPixelPos
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nHorizontalPixels :INTEGER;
    nVerticalPixels :INTEGER
) :BOOLEAN ;

Python:

def  vs.AdjustComponentPixelPos(nDialogID, nComponentID, nHorizontalPixels, nVerticalPixels):
   return BOOLEAN

Description:

Adjust the pixel width and height of the specified Layout Manager component.

説明

指定したレイアウトダイアログのコンポーネントのピクセル幅とピクセル高さを調整します。



  AlignItemEdge Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   AlignItemEdge
(   dialogID :LONGINT;
    itemID :LONGINT;
    whichEdge :LONGINT;
    alignID :INTEGER;
    alignMode :INTEGER
) ;

Python:

def  vs.AlignItemEdge(dialogID, itemID, whichEdge, alignID, alignMode):
   return None

Description:

Aligns the specified control item with other items having the same edge and alignment id values. To align several control items, call this function once for each item to be aligned using a common alignment id value.

Table - Alignment Options

Index
Alignment Edge
1
Right
2
Bottom
3
Left
   
Index
Alignment Mode
0
Resize control items
1
Shift control items


Right alignment of objects will use the object with the minimum pixel value as the alignment baseline. Bottom and left alignment of objects will use the object with the maximum pixel value as the alignment baseline.

説明

ダイアログ上の指定したアイテムの位置を揃えます。

Parameters:

dialogID The index of the dialog layout being defined. ダイアログ番号
itemID The index of the control item to be aligned. 位置揃えするアイテム番号
whichEdge The control edge to be aligned. 位置揃えの種類
alignID An arbitrary number used to identify the items to be aligned together. 一緒に整列するアイテムを識別するための任意の番号
alignMode Alignment mode of the operation 位置揃えのモード

Example:

{aligns all items with the positioning ID of 99}
	AlignItemEdge(lEditID,4,1,99,0);
	AlignItemEdge(lEditID,6,1,99,0);



  ClearGradientSliderSegments Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   ClearGradientSliderSegments
(   dialogID :LONGINT;
    componentID :LONGINT
) ;

Python:

def  vs.ClearGradientSliderSegments(dialogID, componentID):
   return None

Description:

Removes all segments (except for 2) from the gradient slider.

Note: a gradient slider must always have at least 2 segments.

説明

グラデーションスライダーからすべての変化位置を消去します。

注:グラデーションスライダーには少なくとも2つの変化点がなければなりません。

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号

Example:

ClearGradientSliderSegments(dialogID, componentID);



  CreateBorderlessBtn Dialogs - Modern 
Vectorworks 2024

VectorScript Declaration:

PROCEDURE   CreateBorderlessBtn
(   dialogID :LONGINT;
    itemID :LONGINT;
    label :DYNARRAY[] of CHAR;
    iconResPath :DYNARRAY[] of CHAR;
    isToggleButton :BOOLEAN
) ;

Python:

def  vs.CreateBorderlessBtn(dialogID, itemID, label, iconResPath, isToggleButton):
   return None

Description:

Creates a borderless button control in a dialog layout.

説明

ダイアログに枠無しのボタンを作成します。

Parameters:

dialogID The ID of the dialog ダイアログ番号
itemID The ID of the control コントロール番号
label Label of the button. If the label is empty, this button will be a small untitled borderless button. ボタンのラベル。ラベルが空の場合、このボタンは小さい名前のないボーダレスボタンになります。
iconResPath The resource path of the icon アイコンのリソースパス
isToggleButton A boolean to specify whether this is a toggle button トグルボタンかどうかを指定するブーリアン値



  CreateBorderlessMenu Dialogs - Modern 
Vectorworks 2024

VectorScript Declaration:

PROCEDURE   CreateBorderlessMenu
(   dialogID :LONGINT;
    itemID :LONGINT;
    label :DYNARRAY[] of CHAR;
    iconResPath :DYNARRAY[] of CHAR
) ;

Python:

def  vs.CreateBorderlessMenu(dialogID, itemID, label, iconResPath):
   return None

Description:

Creates a borderless menu button control in a dialog layout.

説明

ダイアログに枠無しのメニューボタンを作成します。

Parameters:

dialogID The ID of the dialog ダイアログ番号
itemID The ID of the control コントロール番号
label Label of the button. If the label is empty, this button will be a small untitled borderless menu button. ボタンのラベル。ラベルが空の場合、このボタンは小さい名前のないボーダレスボタンになります。
iconResPath The resource path of the icon アイコンのリソースパス



  CreateCenteredStaticText Dialogs - Modern 
VectorWorks12.0.1

VectorScript Declaration:

PROCEDURE   CreateCenteredStaticText
(   dialogID :LONGINT;
    controlID :LONGINT;
    text :STRING;
    widthInStdChar :INTEGER
) ;

Python:

def  vs.CreateCenteredStaticText(dialogID, controlID, text, widthInStdChar):
   return None

Description:

Similar to CreateStaticText, but creates static text that is centered in its control field on the dialog.

説明

CreateStaticTextのように、編集不可能なフィールドを作成します。文字列はダイアログのフィールドの中心に作成されます。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。

See Also:

GetDlgCtrlWidthStdCh  



  CreateCheckBox Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreateCheckBox
(   dialogID :LONGINT;
    itemID :LONGINT;
    text :STRING
) ;

Python:

def  vs.CreateCheckBox(dialogID, itemID, text):
   return None

Description:

Creates a check box control in a dialog layout.

説明

チェックボックスを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. チェックボックスアイテム番号
text The display text for the control. チェックボックスの文字列

Example:

PROCEDURE Example;
VAR
	dialog1 :INTEGER;
	result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
BEGIN
	dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
	CreateCheckBox(dialog1, 4, 'Use layer colors');
	SetFirstLayoutItem(dialog1, 4);
	result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

SetBooleanItem   GetBooleanItem  



  CreateCheckBox2 Dialogs - Modern 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   CreateCheckBox2
(   dialogID :LONGINT;
    itemID :LONGINT;
    text :DYNARRAY[] of CHAR;
    iconResPath :DYNARRAY[] of CHAR
) ;

Python:

def  vs.CreateCheckBox2(dialogID, itemID, text, iconResPath):
   return None

Description:

Create a checkbox with an icon.

説明

アイコン付きチェックボックスを作成します。

Parameters:

dialogID The ID of the dialog. ダイアログ番号
itemID The ID of the control. コントロール番号
text The text of this control. コントロールのテキスト
iconResPath The path of the icon resource. アイコンリソースのパス



  CreateCheckBoxGroupBox Dialogs - Modern 
VectorWorks10.5

VectorScript Declaration:

PROCEDURE   CreateCheckBoxGroupBox
(   dialogID :LONGINT;
    itemID :LONGINT;
    name :STRING;
    hasFrame :BOOLEAN
) ;

Python:

def  vs.CreateCheckBoxGroupBox(dialogID, itemID, name, hasFrame):
   return None

Description:

Creates a checkbox group box. The checkbox will have name as its label. If hasFrame is true, the group will have a box drawn around it like a regular group box.

説明

チェックボックスのグループボックスを作成します。チェックボックスのグループボックスにはラベルをつけることができます。hasFrameがTRUEならば、枠線が表示されます。

Parameters:

dialogID ID of the dialog ダイアログ番号
itemID ID of the checkbox group box グループボックスアイテム番号
name Title that appears in the checkbox group box グループボックスのタイトル
hasFrame True if the group box has a frame around it; false otherwise 枠線の設定(TRUE:表示/FALSE:非表示)



  CreateClassPullDownMenu Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   CreateClassPullDownMenu
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    widthInStdChar :INTEGER
) ;

Python:

def  vs.CreateClassPullDownMenu(nDialogID, nComponentID, widthInStdChar):
   return None

Description:

Creates a Layout Manager class pull down menu control.

説明

クラスのプルダウンメニューを作成します。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。

Example:

PROCEDURE Example;
VAR
   dialog1 :INTEGER;
   result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
BEGIN
   dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
   CreateClassPullDownMenu(dialog1, 4, 24);
   SetFirstLayoutItem(dialog1, 4);
   result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

CreateImageControl   GetDlgCtrlWidthStdCh  



  CreateColorPopup Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   CreateColorPopup
(   dialogID :LONGINT;
    itemID :LONGINT;
    widthInStdChar :LONGINT
) ;

Python:

def  vs.CreateColorPopup(dialogID, itemID, widthInStdChar):
   return None

Description:

Create a color popup dialog control that displays the 256 color palette associated with the active document.

The widthInStdChar argument specifies the width of the control. Pass -1 to request the default size, which will be consistent with other attribute controls (currently defaults to 14). This argument allows for special circumstances like a small popup for the Fore and Back color associated with the Pattern attribute control.

説明

アクティブドキュメントのカラーパレットを表示するカラーポップアップコントロールを作成します。

widthInCharactersはコントロールの幅を指定します。 -1をいれるとデフォルトサイズ(デフォルトは14)として認識します。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. コントロールの大きさ

Example:

PROCEDURE Example;
VAR
   dialog1 :INTEGER;
   result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
   CASE item OF
      SetupDialogC:
         BEGIN
            SetColorChoice(dialog1, 4, 1242);
         END;
      1:
         BEGIN
            GetColorChoice(dialog1, 4, result);
            AlrtDialog(Concat('color index: ', result));
         END;
   END;
END;
BEGIN
   dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
   CreateColorPopup(dialog1, 4, 24);
   SetFirstLayoutItem(dialog1, 4);
   result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

GetDlgCtrlWidthStdCh  



  CreateControl Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreateControl
(   dialogID :LONGINT;
    itemID :LONGINT;
    controlKind :LONGINT;
    name :STRING;
    data :LONGINT
) ;

Python:

def  vs.CreateControl(dialogID, itemID, controlKind, name, data):
   return None

Description:

Creates a new extended dialog control item. Supported extended dialog controls include image, system color palette, and slider controls.

Table - Control Types

Index
Control Type
1
Image
2
System Color
3
Slider
10
Image Popup
11
Gradient Slider

説明

イメージ、カラーパレット、スライダーなどのアイテムを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
controlKind The type of control item. アイテムの種類
name The display text of the control item. アイテムの文字列
data Initial data for the control item. アイテムのデータ

Example:

{open the resource file containing the graphics for the dialog}
rsAvailable:= SetVSResourceFile('Images');
{creates a new image control}
 CreateControl(lEditID,5,1,'SplashImage',1010);

{Slider Control Example}
PROCEDURE dialog1_Main;
CONST
	kSlider = 4;
	kLabel  = 5;
	kValue  = 6;
VAR
	dialog1   :INTEGER;
	gSlider   :LONGINT;

PROCEDURE dialog1_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
	CASE item OF
		kSlider:
			BEGIN
				GetControlData(dialog1, kSlider, gSlider);
				SetField(kValue, Concat(gSlider));
			END;
	END;
END;

BEGIN
	gSlider := 1000;
	dialog1 := CreateLayout('Slider Control', False, 'OK', 'Cancel');
	CreateControl     (dialog1, kSlider,  3, '', 1000);
	CreateStaticText  (dialog1, kLabel,   'Slider Value:', -1);
	CreateStaticText  (dialog1, kValue,   ' ', -1);
	SetFirstLayoutItem(dialog1, kSlider);
	SetBelowItem      (dialog1, kSlider,  kLabel,   0, 0);
	SetRightItem      (dialog1, kLabel,   kValue,   0, 0);
	IF RunLayoutDialog(dialog1, dialog1_Handler) = 1 THEN BEGIN
	END;
END;
RUN(dialog1_Main);



  CreateCustomControl Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   CreateCustomControl
(   dialogID :LONGINT;
    componentID :LONGINT;
    widthInPixels :INTEGER;
    heightInPixels :INTEGER
) ;

Python:

def  vs.CreateCustomControl(dialogID, componentID, widthInPixels, heightInPixels):
   return None

Description:

Creates a layout manager control in a VectorScript to be used in conjuction with GS_OverrideControl in an external dialog handler.

説明

レイアウトコントロールをVectorScriptに作成し、外部ダイアログハンドラのGS_OverrideControlと組み合わせて使用します。



  CreateCustThumbPopup Dialogs - Modern 
Vectorworks 2013

VectorScript Declaration:

PROCEDURE   CreateCustThumbPopup
(   dialogID :LONGINT;
    controlID :LONGINT;
    sizeType :INTEGER
) ;

Python:

def  vs.CreateCustThumbPopup(dialogID, controlID, sizeType):
   return None

Description:

Creates a custom thumbnail popup that can be populated with previews of objects in Vectorworks.

説明

Vectorworksの図形のプレビューが表示される、カスタムのサムネイルポップアップを作成します。

Parameters:

dialogID The dialog identifier given by the command to create the dialog. ダイアログ番号
controlID The identifier that should be assigned to the control. コントロール番号
sizeType The size type of the control サイズタイプ



  CreateDataVisPDMenu Dialogs - Modern 
Vectorworks 2024

VectorScript Declaration:

PROCEDURE   CreateDataVisPDMenu
(   dialogID :LONGINT;
    componentID :LONGINT;
    widthInStdChar :INTEGER;
    showDefaultStaticItems :BOOLEAN
) ;

Python:

def  vs.CreateDataVisPDMenu(dialogID, componentID, widthInStdChar, showDefaultStaticItems):
   return BOOLEAN

Description:

Creates a Layout Manager data visualization pull down menu control.

説明

レイアウトダイアログボックスのデータの可視化プルダウンメニューコントロールを作成します。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 表示されているテキストの幅を標準文字数で表します。詳細は GetDlgCtrlWidthStdCh を参照してください。



  CreateDesignLayerPullDownMenu Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   CreateDesignLayerPullDownMenu
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    widthInStdChar :INTEGER
) ;

Python:

def  vs.CreateDesignLayerPullDownMenu(nDialogID, nComponentID, widthInStdChar):
   return None

Description:

Creates a Layout Manager design layer pull down menu control.

説明

デザインレイヤのプルダウンメニューを作成します。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。

See Also:

GetDlgCtrlWidthStdCh  



  CreateEditColorText Dialogs - Modern 
Vectorworks 2022

VectorScript Declaration:

PROCEDURE   CreateEditColorText
(   dialogID :LONGINT;
    itemID :LONGINT;
    widthInStdChar :LONGINT;
    heightInLines :LONGINT
) ;

Python:

def  vs.CreateEditColorText(dialogID, itemID, widthInStdChar, heightInLines):
   return None

Description:

Create a text box allowing collor and collapsing of text.

説明

文字のカラーと折りたたみが可能なテキストボックスを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。
heightInLines Height of the control in lines. 高さ(文字数指定)



  CreateEditInteger Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreateEditInteger
(   dialogID :LONGINT;
    itemID :LONGINT;
    defaultValue :LONGINT;
    widthInStdChar :LONGINT
) ;

Python:

def  vs.CreateEditInteger(dialogID, itemID, defaultValue, widthInStdChar):
   return None

Description:

Creates an editable text field control for INTEGER and LONGINT values.

CreateEditInteger is intended specifically for entry of numeric values; the control returns values in a numeric format, and supports calculations within the control field.

説明

整数型の編集フィールドを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
defaultValue Default value for the field. 初期値
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 幅(文字数指定)

Example:

PROCEDURE Example;
VAR
	dialog1 :INTEGER;
	result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
BEGIN
	dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
	CreateEditInteger(dialog1, 4, 123, 16);
	SetFirstLayoutItem(dialog1, 4);
	result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

GetDlgCtrlWidthStdCh  



  CreateEditPassword Dialogs - Modern 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   CreateEditPassword
(   dialogID :LONGINT;
    itemID :LONGINT;
    widthInStdChar :LONGINT
) ;

Python:

def  vs.CreateEditPassword(dialogID, itemID, widthInStdChar):
   return None

Description:

Creates an password text field control in a dialog layout.

説明

ダイアログボックスレイアウトにパスワードテキストフィールドを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。

Example:

PROCEDURE Example;
VAR
	dialog1 :INTEGER;
	result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
BEGIN
	dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
	CreateEditPassword(dialog1, 4, 16);
	SetFirstLayoutItem(dialog1, 4);
	result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

GetDlgCtrlWidthStdCh  



  CreateEditReal Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreateEditReal
(   dialogID :LONGINT;
    itemID :LONGINT;
    editRealType :LONGINT;
    defaultValue :REAL;
    widthInStdChar :LONGINT
) ;

Python:

def  vs.CreateEditReal(dialogID, itemID, editRealType, defaultValue, widthInStdChar):
   return None

Description:

Creates an editable text field control for REAL values.

CreateEditReal is intended specifically for entry of numeric values; the control returns values in a numeric format, and supports calculations within the control field.

Table - Field Types for EditReal Fields

Index
Field Value
1
REAL value
2
Angular value
3
Dimension
4
X coordinate
5
Y coordinate

説明

実数型の編集フィールドを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
editRealType The type of REAL value being accepted. 数値タイプ
defaultValue Default value for the field. 初期値
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 幅(文字数指定)

Example:

PROCEDURE Example;
VAR
	dialog1 :INTEGER;
	result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
BEGIN
	dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
	CreateEditReal(dialog1, 4, 3, 123, 16);
	SetFirstLayoutItem(dialog1, 4);
	result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

GetDlgCtrlWidthStdCh  



  CreateEditText Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreateEditText
(   dialogID :LONGINT;
    itemID :LONGINT;
    defaultText :STRING;
    widthInStdChar :LONGINT
) ;

Python:

def  vs.CreateEditText(dialogID, itemID, defaultText, widthInStdChar):
   return None

Description:

Creates an editable text field control in a dialog layout.

説明

文字列型の編集フィールドを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
defaultText The default display text for the control. 初期値
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 幅(文字数指定)

Example:

PROCEDURE Example;
VAR
	dialog1 :INTEGER;
	result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
BEGIN
	dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
	CreateEditText(dialog1, 4, 'default text', 16);
	SetFirstLayoutItem(dialog1, 4);
	result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

GetDlgCtrlWidthStdCh  



  CreateEditTextBox Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   CreateEditTextBox
(   dialogID :LONGINT;
    itemID :LONGINT;
    defaultText :STRING;
    widthInStdChar :LONGINT;
    heightInLines :LONGINT
) ;

Python:

def  vs.CreateEditTextBox(dialogID, itemID, defaultText, widthInStdChar, heightInLines):
   return None

Description:

Creates a scrolling multiline editable text field in a dialog layout.

説明

スクロールすることで複数行を編集可能なフィールドを作成します。

Parameters:

dialogID The id of the dialog ダイアログ番号
itemID The id of the text box control. アイテム番号
defaultText The initial text. 初期値
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 幅(文字数指定)
heightInLines Height of the control in lines. 高さ(文字数指定)

Example:

PROCEDURE Example;
VAR
	dialog1 :INTEGER;
	result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
BEGIN
	dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
	CreateEditTextBox(dialog1, 4, 'default text', 24, 16);
	SetFirstLayoutItem(dialog1, 4);
	result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

GetDlgCtrlWidthStdCh  



  CreateEnhancedPullDownMenu Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   CreateEnhancedPullDownMenu
(   dialogID :LONGINT;
    componentID :LONGINT;
    widthInStdChar :INTEGER;
    bShowIconInMainWindow :BOOLEAN
) ;

Python:

def  vs.CreateEnhancedPullDownMenu(dialogID, componentID, widthInStdChar, bShowIconInMainWindow):
   return None

Description:

Creates a Layout Manager enhanced pull down menu control.

説明

グループボックスのプルダウンメニューを作成します。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。

See Also:

GetDlgCtrlWidthStdCh  



  CreateGradient Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

FUNCTION   CreateGradient
( name:STRING ) :HANDLE ;

Python:

def  vs.CreateGradient(name):
   return HANDLE

Description:

Creates a new gradient resource.

説明

グラデーションを新規に作成します。

Parameters:

name A user-specified name by which the newly created gradient will be identified. グラデーションの名前

Result:

Returns a handle to a new gradient resource if successful, otherwise the function returns nil.

返り値

新しく作成されたグラデーションのハンドルを返します。その他の場合はNILを返します。

Example:

gradientHandle := CreateGradient('My Gradient');



  CreateGroupBox Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreateGroupBox
(   dialogID :LONGINT;
    itemID :LONGINT;
    text :STRING;
    hasFrame :BOOLEAN
) ;

Python:

def  vs.CreateGroupBox(dialogID, itemID, text, hasFrame):
   return None

Description:

Creates a new group box control in a dialog layout.

The width of a group box is determined by the width of the longest control enclosed by the group box. The height of the group box is determined by the combined height of the enclosed controls.

While used primarily to contain and highlight related control items, group box controls can also be used to group controls for easier positioning. When used in this fashion, pass a blank string for the display text and set the frame display to FALSE.

説明

グループボックスを作成します。
グループボックスの幅はグループボックスに含まれるもっとも長いアイテムの長さによって決定されます。高さはグループボックスに含まれるアイテムの高さの合計によって決定されます。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. グループボックスアイテム番号
text The display text for the control. グループボックスのタイトル
hasFrame Displays a border for the group box. 枠線の設定(TRUE:表示/FALSE:非表示)

Example:

{ creates a framed group box entitled "Options" }
	CreateGroupBox(lEditID,12,'Options',TRUE);

	CreateCheckBox(lEditID,13,'Use layer colors');
	CreateCheckBox(lEditID,14,'Create link on model layer');



  CreateIconPushButton Dialogs - Modern 
VectorWorks12.5 - obsolete as of Vectorworks 2012

VectorScript Declaration:

PROCEDURE   CreateIconPushButton
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nIconID :INTEGER;
    widthInStdChar :INTEGER
) ;

Python:

def  vs.CreateIconPushButton(nDialogID, nComponentID, nIconID, widthInStdChar):
   return None

Special Notes:

CreateIconPushButton is obsolete as of Vectorworks 2012

Description:

Creates an icon push button with the specified icon ID and width in characters.

説明

アイコンプッシュボタンを作成し、アイコンの番号と幅(文字数)を指定します。廃止予定の関数です。代わりに CreateImagePushButton を使用してください。

Parameters:

nIconID the index of the ICN# resource in the currently open rsrc file (or qtr on Windows) .
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。

Example:

PROCEDURE Example;
VAR
   dialog1 :INTEGER;
   result  :INTEGER;
   boo     :BOOLEAN;
 
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
 
BEGIN
   boo := SetVSResourceFile('IP Resources');
   dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
   CreateIconPushButton(dialog1, 4, 11021, 20);
   SetFirstLayoutItem(dialog1, 4);
   result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

GetDlgCtrlWidthStdCh  



  CreateImageControl Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   CreateImageControl
(   dialogID :LONGINT;
    componentID :LONGINT;
    iWidthPixels :INTEGER;
    iHeightPixels :INTEGER;
    hImage :HANDLE
) ;

Python:

def  vs.CreateImageControl(dialogID, componentID, iWidthPixels, iHeightPixels, hImage):
   return None

Description:

Creates a Layout Manager image control.

説明

イメージコントロールを作成します。



  CreateImageControl2 Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   CreateImageControl2
(   dialogID :LONGINT;
    controlID :LONGINT;
    widthInPixels :INTEGER;
    heightInPixels :INTEGER;
    imageSpecifier :DYNARRAY[] of CHAR
) ;

Python:

def  vs.CreateImageControl2(dialogID, controlID, widthInPixels, heightInPixels, imageSpecifier):
   return None

Parameters:

dialogID The dialog identifier given by the command to create the dialog. ダイアログ番号
controlID The identifier that should be assigned to the control. アイテム番号
widthInPixels The width of the control. Use zero to let the image dictate the dimension
heightInPixels The height of the control. Use zero to let the image dictate the dimension 高さ
imageSpecifier The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)



  CreateImagePushButton Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   CreateImagePushButton
(   dialogID :LONGINT;
    controlID :LONGINT;
    widthInStdChar :INTEGER;
    imageSpecifier :DYNARRAY[] of CHAR
) ;

Python:

def  vs.CreateImagePushButton(dialogID, controlID, widthInStdChar, imageSpecifier):
   return None

Description:

Creates an image push button. Replaces CreateIconPushButton

説明

イメージプッシュボタンを作成します。CreateIconPushButton の代わりに使用してください。

Parameters:

dialogID The dialog identifier given by the command to create the dialog. ダイアログ番号
controlID The identifier that should be assigned to the control. アイテム番号
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ボタンの幅
imageSpecifier The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)



  CreateLayerPDMenu Dialogs - Modern 
Vectorworks 2020

VectorScript Declaration:

PROCEDURE   CreateLayerPDMenu
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    widthInStandardChar :INTEGER
) ;

Python:

def  vs.CreateLayerPDMenu(nDialogID, nComponentID, widthInStandardChar):
   return None

Description:

Creates a Layout Manager layer pull down menu control.

説明

レイヤのプルダウンメニューコントロールを作成します。

Parameters:

widthInStandardChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 幅(文字数指定)



  CreateLayout Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   CreateLayout
(   dialogTitle :STRING;
    hasHelp :BOOLEAN;
    defaultButtonName :STRING;
    cancelButtonName :STRING
) :LONGINT ;

Python:

def  vs.CreateLayout(dialogTitle, hasHelp, defaultButtonName, cancelButtonName):
   return LONGINT

Description:

Creates a new custom dialog layout. After the layout is created, control items for the dialog can be added to the layout.

説明

ダイアログのレイアウトを作成し、ダイアログ番号を返します。

Parameters:

dialogTitle Title of the dialog. ダイアログのタイトル
hasHelp Enables help text for the dialog. ヘルプウインドウの設定(TRUE:表示/FALSE:非表示)
defaultButtonName Text displayed in the default button of the dialog. デフォルトボタンの文字列
cancelButtonName Text displayed in the cancel button of the dialog. キャンセルボタンの文字列

Result:

Returns an index number identifying the new dialog layout.

返り値

新しく作成されたレイアウトのダイアログ番号を返します。

Example:

{ creates a new dialog layout }
	lEditID := CreateLayout('Edit Layer',TRUE,'OK','Cancel');

	CreateGroupBox(lEditID,4,'',FALSE);
	CreateStaticText(lEditID,5,'Layer Name:',-1);
	CreateEditText(lEditID,6,'Layer-1',36);

	CreateGroupBox(lEditID,7,'Visibility',TRUE);
	CreateRadioButton(lEditID,8,'Visible');
	CreateRadioButton(lEditID,9,'Grayed');
	CreateRadioButton(lEditID,10,'Hidden');
	CreateStaticText( lEditID,11,'',6); 

	CreateGroupBox(lEditID,12,'Options',TRUE);
	CreateCheckBox(lEditID,13,'Use layer colors');
	CreateCheckBox(lEditID,14,'Create link on model layer');



  CreateLineAttributePopup Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   CreateLineAttributePopup
(   dialogID :LONGINT;
    itemID :LONGINT
) ;

Python:

def  vs.CreateLineAttributePopup(dialogID, itemID):
   return None

Description:

Create a dialog control that displays both line style and line weight choices available in the current document.

説明

ドキュメントで利用可能か線種と線の太さの選択肢を表示するポップアップコントロールを作成します。



  CreateLineStylePopup Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   CreateLineStylePopup
(   dialogID :LONGINT;
    itemID :LONGINT
) ;

Python:

def  vs.CreateLineStylePopup(dialogID, itemID):
   return None

Description:

Create a dialog control that displays the line style choices available in the active document.

説明

アクティブなドキュメントで利用可能な線種の選択肢を表示するポップアップを作成します。



  CreateLineWeightPopup Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   CreateLineWeightPopup
(   dialogID :LONGINT;
    itemID :LONGINT
) ;

Python:

def  vs.CreateLineWeightPopup(dialogID, itemID):
   return None

Description:

Create a line weight popup dialog control to display list of line weights available in current document.

説明

アクティブなドキュメントで利用可能な線の太さの選択肢を表示するポップアップを作成します。



  CreateListBox Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreateListBox
(   dialogID :LONGINT;
    itemID :LONGINT;
    widthInStdChar :LONGINT;
    heightInLines :LONGINT
) ;

Python:

def  vs.CreateListBox(dialogID, itemID, widthInStdChar, heightInLines):
   return None

Description:

Creates a new list box control in a dialog layout.

説明

リストボックスを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 幅(文字数指定)
heightInLines The height of the control in characters. 高さ(文字数指定)

Example:

{ draws a list box 25 characters wide and 7 rows high }
CreateListBox(2,10,25,7);

See Also:

GetDlgCtrlWidthStdCh  



  CreateListBoxN Dialogs - Modern 
VectorWorks10.5

VectorScript Declaration:

PROCEDURE   CreateListBoxN
(   dialogID :LONGINT;
    itemID :LONGINT;
    widthInStdChar :LONGINT;
    heightInLines :LONGINT;
    isMultipleSelect :BOOLEAN
) ;

Python:

def  vs.CreateListBoxN(dialogID, itemID, widthInStdChar, heightInLines, isMultipleSelect):
   return None

Description:

Creates a new list box control in a dialog layout. With isMultipleSelect true, the list supports multiple selection.

説明

リストボックスを作成します。isMultipleSelectパラメータをTRUEにすると、リストボックス内の項目を複数選択することができます。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 幅(文字数指定)
heightInLines The height of the control in characters. 高さ(文字数指定)
isMultipleSelect Does the list support multiple selection 複数選択の設定(TRUE:可/FALSE:不可)

Example:

{ draws a muliple selection list box 25 characters wide and 7 rows high }
CreateListBoxN(2,10,25,7, true);

See Also:

GetDlgCtrlWidthStdCh  



  CreateMarkerPopup Dialogs - Modern 
VectorWorks10.5

VectorScript Declaration:

PROCEDURE   CreateMarkerPopup
(   dialogID :LONGINT;
    componentID :LONGINT
) ;

Python:

def  vs.CreateMarkerPopup(dialogID, componentID):
   return None

Description:

Creates a popup control that displays the various marker styles available in Vectorworks and allows the user to choose one. Markers are the adornments at the endpoints of line objects and consist of styles like arrow, circle, cross, etc.

説明

マーカポップアップを作成します。

Parameters:

dialogID Id of the dialog ダイアログ番号
componentID Id of the popup control マーカポップアップ番号

Example:

PROCEDURE Example;
VAR
	dialog1	:INTEGER;
	result	:INTEGER;

PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;

BEGIN
	dialog1 := CreateLayout('Untitled Dialog', FALSE, 'OK', 'Cancel');
	CreateMarkerPopup(dialog1, 4);
	SetFirstLayoutItem(dialog1,  4);
	result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);



  CreatePatternPopup Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   CreatePatternPopup
(   dialogID :LONGINT;
    itemID :LONGINT
) ;

Python:

def  vs.CreatePatternPopup(dialogID, itemID):
   return None

Description:

Create a pattern popup dialog control that displays all fill patterns available in current document.

説明

アクティブなドキュメントで利用可能な模様の選択肢を表示するポップアップを作成します。



  CreatePullDownMenu Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreatePullDownMenu
(   dialogID :LONGINT;
    itemID :LONGINT;
    widthInStdChar :LONGINT
) ;

Python:

def  vs.CreatePullDownMenu(dialogID, itemID, widthInStdChar):
   return None

Description:

Creates a new pulldown menu control in a dialog layout.

説明

プルダウンメニューを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 幅(文字数指定)

See Also:

GetDlgCtrlWidthStdCh  



  CreatePullDownMenuGroupBox Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   CreatePullDownMenuGroupBox
(   liDialogID :LONGINT;
    liComponentID :LONGINT;
    widthInStdChar :INTEGER;
    strLabel :STRING;
    bHasFrame :BOOLEAN
) ;

Python:

def  vs.CreatePullDownMenuGroupBox(liDialogID, liComponentID, widthInStdChar, strLabel, bHasFrame):
   return None

Description:

Creates a Layout Manager pull down menu group box.

説明

プルダウンメニューのグループボックスを作成します。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。

See Also:

GetDlgCtrlWidthStdCh  



  CreatePullDownSearch Dialogs - Modern 
Vectorworks 2020

VectorScript Declaration:

PROCEDURE   CreatePullDownSearch
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nWidthInChars :INTEGER
) ;

Python:

def  vs.CreatePullDownSearch(nDialogID, nComponentID, nWidthInChars):
   return None

Description:

Creates a pulldown menu with a search bar at the top.

The contents of the pulldown should be filtered as you type in the search bar.

説明

上部に検索バーのあるプルダウンメニューを作成します。

プルダウン内のコンテンツは、検索バーに入力するごとにフィルタされます。




  CreatePushButton Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreatePushButton
(   dialogID :LONGINT;
    itemID :LONGINT;
    text :STRING
) ;

Python:

def  vs.CreatePushButton(dialogID, itemID, text):
   return None

Description:

Creates a new push button control in a dialog layout.

説明

プッシュボタンを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
text The display text for the control. プッシュボタンの文字列



  CreateRadioButton Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreateRadioButton
(   dialogID :LONGINT;
    itemID :LONGINT;
    text :STRING
) ;

Python:

def  vs.CreateRadioButton(dialogID, itemID, text):
   return None

Description:

Creates a new radio button control in a dialog layout.

Radio button groups can be created by defining two or more radio buttons with consecutive index values. When defined as a button group, VectorScript will handle selection-deselection of controls within the group.

説明

ラジオボタンを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
text The display text for the control. ラジオボタンの文字列

Example:

{ creates a radio button with the specified label }
	CreateRadioButton(lEditID,8,'Visible');

	CreateRadioButton(lEditID,9,'Grayed');
	CreateRadioButton(lEditID,10,'Hidden');
	CreateStaticText( lEditID,11,'',6); 



  CreateRadioButton2 Dialogs - Modern 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   CreateRadioButton2
(   dialogID :LONGINT;
    itemID :LONGINT;
    text :DYNARRAY[] of CHAR;
    iconResPath :DYNARRAY[] of CHAR
) ;

Python:

def  vs.CreateRadioButton2(dialogID, itemID, text, iconResPath):
   return None

Description:

Create a radio button with icon.

説明

アイコン付きのラジオボタンを作成します。

Parameters:

dialogID The ID of the dialog. ダイアログ番号
itemID The ID of the control. コントロール番号
text The text of the control. コントロールテキスト
iconResPath The resource path of the icon. アイコンのリソースパス



  CreateRadioButtonGroupBox Dialogs - Modern 
VectorWorks10.5

VectorScript Declaration:

PROCEDURE   CreateRadioButtonGroupBox
(   dialogID :LONGINT;
    itemID :LONGINT;
    name :STRING;
    hasFrame :BOOLEAN
) ;

Python:

def  vs.CreateRadioButtonGroupBox(dialogID, itemID, name, hasFrame):
   return None

Description:

Creates a radio button group box. The radio button will have name as its label. If hasFrame is true, the group will have a box drawn around it like a regular group box.

説明

ラジオボタンのグループボックスを作成します。ラジオボタンのグループボックスにはラベルをつけることができます。hasFrameがTRUEならば、枠線が表示されます。

Parameters:

dialogID ID of the dialog ダイアログ番号
itemID ID of the radio button group box アイテム番号
name Title that appears in the radio button group box グループボックスのタイトル
hasFrame True whether the group has a frame; false otherwise 枠線の設定(TRUE:表示/FALSE:非表示)



  CreateResizableLayout Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   CreateResizableLayout
(   dialogTitle :STRING;
    hasHelp :BOOLEAN;
    defaultButtonName :STRING;
    cancelButtonName :STRING;
    widthResizable :BOOLEAN;
    heightResizable :BOOLEAN
) :LONGINT ;

Python:

def  vs.CreateResizableLayout(dialogTitle, hasHelp, defaultButtonName, cancelButtonName, widthResizable, heightResizable):
   return LONGINT

Description:

Creates a new resizable Layout Manager dialog.

Resizable dialogs raise the ResizeDialogC event when resized.

説明

リサイズ可能なダイアログのレイアウトを作成します。

リサイズすると、ResizeDialogCイベントが起こります。

返り値

新しく作成されたレイアウトのダイアログ番号を返します。

See Also:

SetEdgeBinding   SetProportionalBinding  



  CreateResourcePopup Dialogs - Modern 
Vectorworks 2021

VectorScript Declaration:

PROCEDURE   CreateResourcePopup
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nWidthInChars :INTEGER
) ;

Python:

def  vs.CreateResourcePopup(nDialogID, nComponentID, nWidthInChars):
   return None

Description:

Creates a text popup similar to a pulldown menu that opens a Resource Manager window.

This is basically the same as the Thumbnail popup but the control only displays the name of the selected item (it does not display its thumbnail), resembling a pulldown menu control.

説明

リソースマネージャウインドウを開くプルダウンメニューのような、文字列のポップアップを作成します。

基本的にサムネイルポップアップと同じですが、プルダウンメニューコントロールと同じような形式で、選択したアイテムの名前のみを表示します(サムネイルは表示しません)。

Parameters:

nDialogID The index of the dialog layout containing the control. ダイアログ番号
nComponentID The index that will identify the control item. アイテム番号
nWidthInChars The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。



  CreateRightStaticText Dialogs - Modern 
VectorWorks12.0.1

VectorScript Declaration:

PROCEDURE   CreateRightStaticText
(   dialogID :LONGINT;
    itemID :LONGINT;
    text :STRING;
    widthInStdChar :INTEGER
) ;

Python:

def  vs.CreateRightStaticText(dialogID, itemID, text, widthInStdChar):
   return None

Description:

Similar to CreateStaticText, but creates static text that is right-justified in its control field on the dialog.

説明

CreateStaticTextのように、編集不可能なフィールドを作成します。文字列はダイアログのフィールドの右に作成されます。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。

See Also:

GetDlgCtrlWidthStdCh  



  CreateSearchEditBox Dialogs - Modern 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   CreateSearchEditBox
(   dialogID :LONGINT;
    itemID :LONGINT;
    promptText :STRING;
    widthInStdChar :LONGINT
) ;

Python:

def  vs.CreateSearchEditBox(dialogID, itemID, promptText, widthInStdChar):
   return None

Description:

Creates a search field control in a dialog layout.

説明

ダイアログレイアウトに検索フィールドコントロールを作成します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログID
itemID The index that will identify the control item. アイテム番号
promptText The default prompt text for the search control. 検索ワードの初期値
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 文字列の表示幅(GetDlgCtrlWidthStdChを参照)

Example:

PROCEDURE Example;
VAR
	dialog1 :INTEGER;
	result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
BEGIN
	dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
	CreateSearchEditBox(dialog1, 4, 'search', 16);
	SetFirstLayoutItem(dialog1, 4);
	result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

GetDlgCtrlWidthStdCh  



  CreateSeparator Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   CreateSeparator
(   dialogID :LONGINT;
    componentID :LONGINT;
    widthInPixels :INTEGER
) ;

Python:

def  vs.CreateSeparator(dialogID, componentID, widthInPixels):
   return None

Description:

Creates a Layout Manager image separator.

説明

セパレータを作成します。



  CreateSheetLayerPullDownMenu Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   CreateSheetLayerPullDownMenu
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    widthInStdChar :INTEGER
) ;

Python:

def  vs.CreateSheetLayerPullDownMenu(nDialogID, nComponentID, widthInStdChar):
   return None

Description:

Creates a Layout Manager sheet layer pull down menu control.

説明

シートレイヤのプルダウンメニューを作成します。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。

See Also:

GetDlgCtrlWidthStdCh  



  CreateStandardIconControl Dialogs - Modern 
VectorWorks11.5

VectorScript Declaration:

PROCEDURE   CreateStandardIconControl
(   dialogID :LONGINT;
    iconControlID :LONGINT;
    iconNumber :INTEGER
) ;

Python:

def  vs.CreateStandardIconControl(dialogID, iconControlID, iconNumber):
   return None

Description:

Creates a standard icon control, which is used to display the application icon or an alert icon. Valid values for iconNumber are:
0 - Vectorworks application icon
1 - Informational icon
2 - Stop icon
3 - Exclamation mark (warning) icon
4 - Question icon

説明

アプリケーションアイコンや警告アイコンで表示される標準アイコンアイテム作成します。
アイコン番号(0:VectorWorksアプリケーションアイコン/1:インフォメーションアイコン/2:ストップアイコン/3:警告アイコン/4:クエスチョンマークアイコン)

Parameters:

dialogID ID of the dialog ダイアログ番号
iconControlID ID of the control within the dialog アイコンアイテム番号
iconNumber Constant, listed above, indicating which icon to display. アイコン番号

Example:

dlog := CreateLayout('Untitled Dialog', False, 'OK', 'Cancel');

	CreateStandardIconControl(dlog, 4, 0);
	SetFirstLayoutItem(dlog, 4);

	result := RunLayoutDialog(dlog, EventHandler);




  CreateStaticText Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CreateStaticText
(   dialogID :LONGINT;
    itemID :LONGINT;
    text :STRING;
    widthInStdChar :LONGINT
) ;

Python:

def  vs.CreateStaticText(dialogID, itemID, text, widthInStdChar):
   return None

Description:

Creates a new static text field control in a dialog layout.

To allow the control to size automatically to the text width, pass -1 as the width parameter of the control.

説明

編集不可能なフィールドを作成します。
文字列の長さで自動的に幅を変更するには、幅のパラメータを-1にします。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
text The display text for the control. 文字列
widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. 幅(文字数指定)

Example:

PROCEDURE Example;
VAR
   dialog1 :INTEGER;
   result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
BEGIN
   dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
   CreateEditText(dialog1, 4, 'default text', 16);
   CreateStaticText(dialog1, 5, 'default text', 16);
   SetFirstLayoutItem(dialog1, 4);
   SetBelowItem(dialog1, 4, 5, 0, 0);
   result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

CreateStyledStatic   GetDlgCtrlWidthStdCh  



  CreateStyledStatic Dialogs - Modern 
Vectorworks 2013

VectorScript Declaration:

PROCEDURE   CreateStyledStatic
(   dialogID :LONGINT;
    componentID :LONGINT;
    text :STRING;
    widthInStdChar :INTEGER;
    style :INTEGER
) ;

Python:

def  vs.CreateStyledStatic(dialogID, componentID, text, widthInStdChar, style):
   return BOOLEAN

Description:

Creates a new static text field control in a dialog layout. Text will have the indicated style.

To allow the control to size automatically to the text width, pass -1 as the width parameter of the control.

0 = eStaticTextTypeRegular
1 = eStaticTextTypeCaption
2 = eStaticTextTypeBold,
3 = eStaticTextTypeReduced

説明

定義済みの文字スタイルセットで、編集不可能なフィールドを作成します。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。
style Type of this static text control. One of: 0 = eStaticTextTypeRegular 1 = eStaticTextTypeCaption 2 = eStaticTextTypeBold, 3 = eStaticTextTypeReduced, 101-116 = Custom size, normal 201-216 = Custom size, bold 編集不可能な文字のタイプ
0 : 標準
1 : 見出し
2 : 太字
3 : 小文字
101-116 : カスタムサイズ(標準)
201-216 : カスタムサイズ(太字)

Result:

Boolean indicating the control was created successfully.

返り値

作成が成功したかどうか

Example:

PROCEDURE Example;
VAR
   dialog1 :INTEGER;
   result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;
BEGIN
   dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
   CreateEditText(dialog1, 4, 'default text', 16);
   CreateStyledStatic(dialog1, 5, 'default text', 16, 2);
   SetFirstLayoutItem(dialog1, 4);
   SetBelowItem(dialog1, 4, 5, 0, 0);
   result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

CreateStaticText   GetDlgCtrlWidthStdCh  



  CreateSwapControl Dialogs - Modern 
VectorWorks11.5

VectorScript Declaration:

PROCEDURE   CreateSwapControl
(   dialogID :LONGINT;
    swapControlID :LONGINT
) ;

Python:

def  vs.CreateSwapControl(dialogID, swapControlID):
   return None

Description:

Create a swap control within a dialog.

This control manages multiple overlapping groups of controls, of which a single group of controls is displayed at a time. The script is able to control which group is displayed based on other data in the dialog. For example, a dialog may present a scrolling list of items on the left, and a swap control on the right. As the user selects items in the list, different sets of controls are enabled on the right. This can be used for a settings (preferences) style dialog or when there are too many choices to use a Tab control effectively.

説明

スワップペインコントロールを作成します。
複数の重なりあったコントロールのグループを、同時に表示される1つのコントロールのグループとして扱えます。ダイアログ内の他のデータに基づいて、どのグループを表示するか設定することができます。
例えば、左側にスクロール可能なリスト、右側にスワップペインコントロールといったダイアログがあったとします。ユーザが左側にあるリストの項目を選択すると、異なる組み合わせのコントロールが右側に表示され選択可能になります。初期設定ダイアログやタブペインコントロールでは効果的でない場合に使われます。

Parameters:

dialogID ID of the dialog. ダイアログ番号
swapControlID ID of the swap control. スワップコントロール番号

See Also:

CreateSwapPane   DisplaySwapPane  



  CreateSwapPane Dialogs - Modern 
VectorWorks11.5

VectorScript Declaration:

PROCEDURE   CreateSwapPane
(   dialogID :LONGINT;
    swapControlID :LONGINT;
    newGroupID :LONGINT
) ;

Python:

def  vs.CreateSwapPane(dialogID, swapControlID, newGroupID):
   return None

Description:

Creates a swap pane within the specified swap control. Within a swap control, only one swap pane is visible at a time.

説明

スワップペインコントロールの中にスワップペインを作成します。
スワップコントロール内では、一度に1つのスワップペインだけが表示されます。

Parameters:

dialogID the ID of the dialog ダイアログ番号
swapControlID the ID of the swap control スワップコントロール番号
newGroupID the ID of the group to be inserted into swap control as a swap pane. グループ番号

Example:

PROCEDURE dialog1_Main;
CONST
	kOK            = 1;
	kCancel        = 2;
	kTabControl    = 4;
	kTabPane_1     = 5;
	kTabPane_2     = 6;
	kSwapControl_1 = 7;
	kSwapControl_2 = 8;
	kSwapPane_11   = 9;
	kSwapPane_21   = 10;
	kSwapPane_12   = 11;
	kSwapPane_22   = 12;
	kButton_11     = 13;
	kButton_21     = 14;
	kButton_12     = 15;
	kButton_22     = 16;
VAR
	dialog1          :INTEGER;

PROCEDURE dialog1_Setup;
BEGIN
	dialog1 := CreateLayout('Tabs and Swaps', False, 'OK', 'Cancel');
	CreateTabControl         (dialog1, kTabControl);
	CreateGroupBox           (dialog1, kTabPane_1,      'Tab Pane 1', True);
	CreateGroupBox           (dialog1, kTabPane_2,      'Tab Pane 2', True);
	CreateSwapControl        (dialog1, kSwapControl_1);
	CreateSwapControl        (dialog1, kSwapControl_2);
	CreateGroupBox           (dialog1, kSwapPane_11,    '', True);
	CreateGroupBox           (dialog1, kSwapPane_21,    '', True);
	CreateGroupBox           (dialog1, kSwapPane_12,    '', True);
	CreateGroupBox           (dialog1, kSwapPane_22,    '', True);
	CreatePushButton         (dialog1, kButton_11,      'Button 1');
	CreatePushButton         (dialog1, kButton_21,      'Button 3');
	CreatePushButton         (dialog1, kButton_12,      'Button 2');
	CreatePushButton         (dialog1, kButton_22,      'Button 4');

	SetFirstLayoutItem(dialog1, kTabControl);
	CreateTabPane     (dialog1, kTabControl,     kTabPane_1);
	SetFirstGroupItem (dialog1, kTabPane_1,      kSwapControl_1);
	CreateSwapPane    (dialog1, kSwapControl_1,  kSwapPane_11);
	SetFirstGroupItem (dialog1, kSwapPane_11,    kButton_11);
	CreateSwapPane    (dialog1, kSwapControl_1,  kSwapPane_12);
	SetFirstGroupItem (dialog1, kSwapPane_12,    kButton_12);
	CreateTabPane     (dialog1, kTabControl,     kTabPane_2);
	SetFirstGroupItem (dialog1, kTabPane_2,      kSwapControl_2);
	CreateSwapPane    (dialog1, kSwapControl_2,  kSwapPane_21);
	SetFirstGroupItem (dialog1, kSwapPane_21,    kButton_21);
	CreateSwapPane    (dialog1, kSwapControl_2,  kSwapPane_22);
	SetFirstGroupItem (dialog1, kSwapPane_22,    kButton_22);
END;

PROCEDURE dialog1_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;

BEGIN
	dialog1_Setup;
	IF RunLayoutDialog(dialog1, dialog1_Handler) = 1 then BEGIN
	END;
END;
RUN(dialog1_Main);

See Also:

CreateSwapControl   DisplaySwapPane  



  CreateSymbolDisplayControl Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   CreateSymbolDisplayControl
(   dialogID :LONGINT;
    itemID :LONGINT;
    symbolName :STRING;
    height :INTEGER;
    width :INTEGER;
    margin :INTEGER;
    renderMode :INTEGER;
    view :INTEGER
) ;

Python:

def  vs.CreateSymbolDisplayControl(dialogID, itemID, symbolName, height, width, margin, renderMode, view):
   return None

Description:

Creates a new symbol display control in the dialog layout. The control displays the specified symbol in the specified rendering mode and view. The actual size of the symbol is not relevent; it is shown as large as possible in the given height and width (the height to width ratio of the symbol is always preserved). To show a blank SymbolDisplay control, use an empty string as the symbolName parameter.

Table - Render Modes

Render Mode Constant
Wireframe 0
Unshaded Polygon 2
Shaded Polygon 3
Shaded Polygon No Lines 4
Final Shaded Polygon 5
Hidden Line 6
Dashed Hidden Line 7
OpenGL 11
Fast RenderWorks 12
Fast RenderWorks with Shadows 13
Final Quality RenderWorks 14
Custom RenderWorks 15
Artistic RenderWorks 17
Sketch 18


Table - Views

View Constant
Top/Plan 2
Front 3
Back 4
Left 5
Right 6
Top 7
Bottom 8
Right Isometric 9
Left Isometric 10
Right Rear Isometric 11
Left Rear Isometric 12
Bottom Right Isometric 13
Bottom Left Isometric 14
Bottom Right Rear Isometric 15
Bottom Left Rear Isometric 16

説明

シンボルを表示するコントロールを作成します。 コントロールには指定されたレンダリングモードと視点で指定されたシンボルを表示します。 空白のコントロールを表示するには、シンボル名を空にしてください。

Parameters:

dialogID The ID of the dialog in which to create the control. ダイアログ番号
itemID The item ID of the control. アイテム番号
symbolName The name of the symbol to display. シンボル名
height The height of the control in pixels. 枠の高さ
width The width of the control in pixels. 枠の幅
margin The margin bewteen the border of the control and the symbol in pixels. 枠とシンボルとの間隔
renderMode The render mode in which to display the symbol. レンダリングモード
view The view in which to display the symbol. 視点

Example:

CreateSymbolDisplayControl( 5, 6, 'Chair', 350, 200, 5, 11, 9 );

This creates a dialog control that displays the symbol called "Chair."  The control is 350 pixels high and 200 pixels wide, with a margin of 5 pixels.  The symbol is rendered in OpenGL mode and displayed in a right isometric view.

PROCEDURE Example;
VAR
	dialog1 :INTEGER;
	int     :INTEGER;

PROCEDURE dialog1_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
END;

BEGIN
	dialog1 := CreateLayout('Example', TRUE, 'OK', 'Cancel');
	CreateSymbolDisplayControl(dialog1,  4,  'Symbol-1', 128, 128, 0, 11, 9);
	SetFirstLayoutItem(dialog1,  4);
	int := RunLayoutDialog(dialog1, dialog1_Handler);
END;
RUN(Example);

See Also:

UpdateSymbolDisplayControl  



  CreateSymDispCtrlN Dialogs - Modern 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   CreateSymDispCtrlN
(   dialogID :LONGINT;
    itemID :LONGINT;
    symbolName :STRING;
    width :INTEGER;
    height :INTEGER;
    margin :INTEGER;
    view :INTEGER;
    renderMode :INTEGER;
    component :INTEGER;
    scaleByZoom :BOOLEAN
) ;

Python:

def  vs.CreateSymDispCtrlN(dialogID, itemID, symbolName, width, height, margin, view, renderMode, component, scaleByZoom):
   return None

Description:

Creates a new symbol display control in the dialog layout. The control displays the specified symbol in the specified rendering mode and view. Specified image component is used. The actual size of the symbol is not relevant; it is shown as large as possible in the given height and width (the height to width ratio of the symbol is always preserved). To show a blank SymbolDisplay control, use an empty string as the symbolName parameter.

Table - Render Modes

Render Mode Constant
Wireframe 0
Unshaded Polygon 2
Shaded Polygon 3
Shaded Polygon No Lines 4
Final Shaded Polygon 5
Hidden Line 6
Dashed Hidden Line 7
OpenGL 11
Fast RenderWorks 12
Fast RenderWorks with Shadows 13
Final Quality RenderWorks 14
Custom RenderWorks 15
Artistic RenderWorks 17
Sketch 18


Table - Views

View Constant
Top/Plan 2
Front 3
Back 4
Left 5
Right 6
Top 7
Bottom 8
Right Isometric 9
Left Isometric 10
Right Rear Isometric 11
Left Rear Isometric 12
Bottom Right Isometric 13
Bottom Left Isometric 14
Bottom Right Rear Isometric 15
Bottom Left Rear Isometric 16


Table - Components

Component Constant
3D 0
2D 1
2D Cut 2
Not set 4

説明

シンボルを表示するコントロールを作成します。コントロールには指定したシンボルを指定したレンダリングモードとビューで表示します。指定したイメージコンポーネントを使用します。シンボルの実際のサイズと関連性は持ちません。指定した高さ(height)と幅(width)パラメータに基づいた最大限の大きさで表示されます(シンボル高さと幅の比率は常に保持されます)。空白のコントロールを表示するには、シンボル名(symbolName)パラメータを空にします。

Table - Render Modes

Render Mode Constant
Wireframe 0
Unshaded Polygon 2
Shaded Polygon 3
Shaded Polygon No Lines 4
Final Shaded Polygon 5
Hidden Line 6
Dashed Hidden Line 7
OpenGL 11
Fast RenderWorks 12
Fast RenderWorks with Shadows 13
Final Quality RenderWorks 14
Custom RenderWorks 15
Artistic RenderWorks 17
Sketch 18


Table - Views

View Constant
Top/Plan 2
Front 3
Back 4
Left 5
Right 6
Top 7
Bottom 8
Right Isometric 9
Left Isometric 10
Right Rear Isometric 11
Left Rear Isometric 12
Bottom Right Isometric 13
Bottom Left Isometric 14
Bottom Right Rear Isometric 15
Bottom Left Rear Isometric 16


Table - Components

Component Constant
3D 0
2D 1
2D Cut 2
Not set 4

Parameters:

dialogID The ID of the dialog in which to create the control. ダイアログ番号
itemID The item ID of the control. アイテム番号
symbolName The name of the symbol to display. シンボル名
width The width of the control in pixels. 枠の幅(ピクセル値)
height The height of the control in pixels. 枠の高さ(ピクセル値).
margin The margin bewteen the border of the control and the symbol in pixels. 枠とシンボルとの間隔(ピクセル値)
view The view in which to display the symbol. ビュー
renderMode The render mode in which to display the symbol. レンダリングモード
component The image component. コンポーネント
scaleByZoom Whether the sizing is done by zoom or layer scale. ズームまたはレイヤの縮尺によるサイズ調整

See Also:

UpdateSymDispCtrlN  



  CreateTabControl Dialogs - Modern 
VectorWorks10.5

VectorScript Declaration:

PROCEDURE   CreateTabControl
(   dialogID :LONGINT;
    itemID :LONGINT
) ;

Python:

def  vs.CreateTabControl(dialogID, itemID):
   return None

Description:

Creates a tab control within a dialog. The tab control manages the display of multiple panes of information and provides tab buttons that allow the user to swtich between panes.

To create a tab control in a dialog, first define a group for each tab pane. Add other controls to the groups and arrange them. Then call CreateTabControl with an id. Finally, call CreateTabPane for each pane providing the id of the group that defines that pane.

説明

タブペインコントロールを作成します。タブペインコントロールは、情報を複数のタブペインに表示し、タブボタンでタブペイン間の切り替えができるようにします。

タブペインコントロールを定義するには、最初にそれぞれのタブペイン用のグループを作成します。グループにアイテムを追加し位置揃えをします。
そして、番号をつけてCreateTabControl をコールします。最後に「CreateTabPane」をコールして、それぞれのタブペインに表示するグループを指定します。

Parameters:

dialogID The id of the dialog that contains this Tab control. ダイアログ番号
itemID The id of the Tab control. アイテム番号

Example:

Procedure TabControls;

const
	kTabControlID = 10;
	kTabPaneID1 = 20;
	kTabPaneID2 = 30;
	kTabPaneID3	= 40;
	
var
	dlogID, result  : LONGINT;
	
Procedure DialogProc(VAR item: LONGINT; data: LONGINT);
begin
	case item of
		SetupDialogC:
			begin
				result := 0;
			end;

		end;
end;

begin
	dlogID := CreateLayout('Sample Tab Dialog', false, 'OK', 'Cancel');

	{ Tab Group 1 }
	CreateGroupBox(dlogID, kTabPaneID1, 'Tab 1', FALSE);
	
	CreatePushButton(dlogID, 21, 'Button 1');
	SetFirstGroupItem(dlogID, kTabPaneID1, 21);	
	CreatePushButton(dlogID, 22, 'Button 2');
	SetBelowItem(dlogID, 21, 22, 0, 0);
	CreatePushButton(dlogID, 23, 'Button 3');
	SetBelowItem(dlogID, 22, 23, 0, 0);
	
	
	{ Tab Group 2 }
	CreateGroupBox(dlogID, kTabPaneID2, 'Tab 2', FALSE);
	
	CreatePushButton(dlogID, 31, 'Button 4');
	SetFirstGroupItem(dlogID, kTabPaneID2, 31);
	CreatePushButton(dlogID, 32, 'Button 5');
	SetRightItem(dlogID, 31, 32, 0, 0);
	CreatePushButton(dlogID, 33, 'Button 6');
	SetRightItem(dlogID, 32, 33, 0, 0);
	
	
	{ Tab Group 3 }
	CreateGroupBox(dlogID, kTabPaneID3, 'Tab 3', FALSE);
	
	CreatePushButton(dlogID, 41, 'Button 7');
	SetFirstGroupItem(dlogID, kTabPaneID3, 41);
	CreatePushButton(dlogID, 42, 'Button 8');
	SetRightItem(dlogID, 41, 42, 0, 0);
	CreatePushButton(dlogID, 43, 'Button 9');
	SetBelowItem(dlogID, 42, 43, 0, 0);
	

	{ Create tab control 1 }
	CreateTabControl(dlogID, kTabControlID);
	SetFirstLayoutItem(dlogID, kTabControlID);
	
	{ Add the tab panes to tab control }
	CreateTabPane(dlogID, kTabControlID, kTabPaneID1);
	CreateTabPane(dlogID, kTabControlID, kTabPaneID2);
	CreateTabPane(dlogID, kTabControlID, kTabPaneID3);
	
	result := RunLayoutDialog(dlogID, DialogProc);
end;
Run(TabControls);

See Also:

CreateTabPane   CreateGroupBox   RunLayoutDialog  



  CreateTabPane Dialogs - Modern 
VectorWorks10.5

VectorScript Declaration:

PROCEDURE   CreateTabPane
(   dialogID :LONGINT;
    itemID :LONGINT;
    groupID :LONGINT
) ;

Python:

def  vs.CreateTabPane(dialogID, itemID, groupID):
   return None

Description:

Creates a tab pane within a tab control on a dialog.

To define a tab pane, create a group control and add items to the group. Arrange the items within the group. Then call CreateTabPane to add a new tab pane to a tab control. Specify the group that defines the layout of that tab pane.

説明

タブペインコントロールの中にタブペインを作成します。

タブペインを定義するには、グループを作成しグループにアイテムを追加します。
グループ内のアイテムの位置揃えをします。
そして、CreateTabPane でタブペインコントロールの中にタブペインを作成します。タブペインに表示するグループを指定します。

Parameters:

dialogID The id of the dialog. ダイアログ番号
itemID The id of the Tab Control to which this tab pane will be added. アイテム番号
groupID The id of the group that defines the tab pane. グループ番号

Example:

{ Create tab control }
	CreateTabControl(dlogID, kTabControlID);
	
	{ Add the tab panes to tab control }
	CreateTabPane(dlogID, kTabControlID, kTabPaneID1);
	CreateTabPane(dlogID, kTabControlID, kTabPaneID2);
	CreateTabPane(dlogID, kTabControlID, kTabPaneID3);

See Also:

CreateTabControl   CreateGroupBox   RunLayoutDialog  



  CreateThreeStateCheckBox Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   CreateThreeStateCheckBox
(   dialogID :LONGINT;
    componentID :LONGINT;
    strName :STRING
) ;

Python:

def  vs.CreateThreeStateCheckBox(dialogID, componentID, strName):
   return None

Description:

Creates a Layout Manager three state checkbox.

説明

3状態チェックボックスを作成します。



  CreateThumbnailPopup Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   CreateThumbnailPopup
(   dialogID :LONGINT;
    controlID :LONGINT
) ;

Python:

def  vs.CreateThumbnailPopup(dialogID, controlID):
   return None

Description:

Creates a thumbnail popup that can be populated with previews of objects in Vectorworks

説明

Vectorworksの図形のプレビューが表示される、ポップアップを作成します。



  CreateTreeControl Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   CreateTreeControl
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    widthInStdChar :INTEGER;
    heightInLines :INTEGER
) ;

Python:

def  vs.CreateTreeControl(nDialogID, nComponentID, widthInStdChar, heightInLines):
   return None

Description:

Creates a Layout Manager tree control.

説明

ツリーアイテムを作成します。

Parameters:

widthInStdChar The width of the displayed text in standard character count. See GetDlgCtrlWidthStdCh. ダイアログでの表示幅は標準文字の文字数となります。詳細は GetDlgCtrlWidthStdCh を参照してください。

Example:

PROCEDURE Example;
VAR
   dialog1 :INTEGER;
   result  :INTEGER;
   widthInStdChar, heightInLines :INTEGER;
   root1, root2, child1, child2 :INTEGER;

PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
   CASE item OF
      SetupDialogC:
         BEGIN
            root1 := InsertTreeControlItem(dialog1, 4, 'root1', -1, 0);
            child1 := InsertTreeControlItem(dialog1, 4, 'child1', root1, 0);
            child2 := InsertTreeControlItem(dialog1, 4, 'child2', root1, child1);
            root2 := InsertTreeControlItem(dialog1, 4, 'root2', -1, root1);
            child1 := InsertTreeControlItem(dialog1, 4, 'child1', root2, 0);
            child2 := InsertTreeControlItem(dialog1, 4, 'child2', root2, child1);
         END;
   END;
END;

BEGIN
   dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
   widthInStdChar := 28;
   heightInLines := 8;
   CreateTreeControl(dialog1, 4, widthInStdChar, heightInLines);
   SetFirstLayoutItem(dialog1, 4);
   result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

GetTreeControlSelectedItem   InsertTreeControlItem   RemoveTreeControlItem   GetDlgCtrlWidthStdCh  



  DeleteAllItems Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   DeleteAllItems
(   dialogID :LONGINT;
    itemID :LONGINT
) ;

Python:

def  vs.DeleteAllItems(dialogID, itemID):
   return None

Description:

Deletes all rows from the specified list box.

説明

リストボックスからすべての行を削除します。

Parameters:

dialogID ID of the dialog ダイアログ番号
itemID ID of the list box リストボックスアイテム番号



  DeregisterDialogFromTimerEvents Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   DeregisterDialogFromTimerEvents
( dialogID:LONGINT ) ;

Python:

def  vs.DeregisterDialogFromTimerEvents(dialogID):
   return None

Description:

Removes the dialog from the timer event registry system.

説明

タイマーイベントレジストリからダイアログを削除します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号



  DeselectEditText Dialogs - Modern 
VectorWorks12.0.1

VectorScript Declaration:

PROCEDURE   DeselectEditText
(   dialogID :LONGINT;
    controlID :LONGINT
) ;

Python:

def  vs.DeselectEditText(dialogID, controlID):
   return None

Description:

Deselects all text in the specified edit control.

説明

すべての文字列型の編集フィールドの選択状態を解除します。



  DisplaySwapPane Dialogs - Modern 
VectorWorks11.5

VectorScript Declaration:

PROCEDURE   DisplaySwapPane
(   dialogID :LONGINT;
    swapControlID :LONGINT;
    groupNumber :LONGINT
) ;

Python:

def  vs.DisplaySwapPane(dialogID, swapControlID, groupNumber):
   return None

Description:

Causes the specified swap pane to be displayed within the specified swap control.

This is called from the dialog's event handling routine.

説明

スワップコントロール内に指定したスワップペインを表示します。
この関数はダイアログのイベントハンドラとして利用できます。

Parameters:

dialogID the ID of the dialog ダイアログ番号
swapControlID the ID of the swap control スワップコントロール番号
groupNumber 1-based index of the swap pane to be displayed グループ番号(1から)

Example:

Procedure DialogProc(VAR item: LONGINT; data: LONGINT);
BEGIN
	CASE item OF
		SetupDialogC:
		BEGIN
			result := 0;
		END;

		100:	DisplaySwapPane(dlogID, 10, 1);  { Display pane 1 }
		101:	DisplaySwapPane(dlogID, 10, 2);  { Display pane 2 }
		102:	DisplaySwapPane(dlogID, 10, 3);  { Display pane 3 }

	END;
END;

See Also:

CreateSwapControl   CreateSwapPane  



  DisplayTabPane Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   DisplayTabPane
(   dialogID :LONGINT;
    tabControlID :LONGINT;
    groupNumber :LONGINT
) ;

Python:

def  vs.DisplayTabPane(dialogID, tabControlID, groupNumber):
   return None

Description:

Causes the specified swap pane to be displayed within the specified swap control.

This is called from the dialog's event handling routine.

説明

スワップコントロール内に指定したスワップペインを表示します。

Parameters:

dialogID the ID of the dialog ダイアログ番号
tabControlID the ID of the swap control スワップコントロール番号
groupNumber 1-based index of the swap pane to be displayed 表示したい枠番号(1から)

Example:

Procedure DialogProc(VAR item: LONGINT; data: LONGINT);
BEGIN
	CASE item OF
		SetupDialogC:
		BEGIN
			result := 0;
		END;

		100:	DisplaySwapPane(dlogID, 10, 1);  { Display pane 1 }
		101:	DisplaySwapPane(dlogID, 10, 2);  { Display pane 2 }
		102:	DisplaySwapPane(dlogID, 10, 3);  { Display pane 3 }

	END;
END;

See Also:

CreateSwapControl   CreateSwapPane  



  EnableItem Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   EnableItem
(   dialogID :LONGINT;
    componentID :LONGINT;
    enableState :BOOLEAN
) ;

Python:

def  vs.EnableItem(dialogID, componentID, enableState):
   return None

Description:

Sets the enable state of a dialog item.

説明

アイテムの有効/無効を設定します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier of the component to enable or disable given the state. アイテム番号
enableState True if the component should be enabled, false otherwise. TRUE : 有効 / FALSE : 無効



  EnableLBDropOnIndices Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   EnableLBDropOnIndices
(   dialogID :LONGINT;
    componentID :LONGINT;
    iStartIndex :INTEGER;
    iEndIndex :INTEGER;
    bEnable :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.EnableLBDropOnIndices(dialogID, componentID, iStartIndex, iEndIndex, bEnable):
   return BOOLEAN

Description:

Enables or disables drag and drop to occur within the specified indices.

説明

指定した番号内でのドラッグ&ドロップ操作を有効/無効にします。



  EnableTextEdit Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   EnableTextEdit
(   dialogID :LONGINT;
    componentID :LONGINT;
    editableState :BOOLEAN
) ;

Python:

def  vs.EnableTextEdit(dialogID, componentID, editableState):
   return None

Description:

Enables text editing for the given component.

説明

テキストフィールドの編集可/不可を設定します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier of the text component. アイテム番号
editableState True if this text component should be editable, false otherwise. アイテムの設定(TRUE:編集可/FALSE:編集不可 )



  ExpandTreeControlItem Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   ExpandTreeControlItem
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nItemID :INTEGER;
    bExpand :BOOLEAN
) ;

Python:

def  vs.ExpandTreeControlItem(nDialogID, nComponentID, nItemID, bExpand):
   return None

Description:

Expands or collapses the specified tree control item.

説明

指定したツリーアイテムを開くまたは折りたたみます。



  GetActiveEditItem Dialogs - Modern 
VectorWorks12.0.1

VectorScript Declaration:

FUNCTION   GetActiveEditItem
( dialogID:LONGINT ) :LONGINT ;

Python:

def  vs.GetActiveEditItem(dialogID):
   return LONGINT

Description:

Returns the active edit control in the specified dialog. If no edit control has the focus, -1 is returned.

説明

アクティブな編集フィールドの値を返します。アクティブな編集フィールドがなければ、-1を返します。



  GetActivePane Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   GetActivePane
(   dialogID :LONGINT;
    tabControlID :LONGINT
) :LONGINT ;

Python:

def  vs.GetActivePane(dialogID, tabControlID):
   return LONGINT

Description:

Returns the currently displayed tab or swap pane in the specified tab or swap control.

This is called from the dialog's event handling routine.

説明

現在表示されているタブかスワップパネルを返します。

イベントハンドリングルーチンで使います。

Parameters:

dialogID the ID of the dialog ダイアログ番号
tabControlID the ID of the swap control コントロール番号

Example:

Procedure DialogProc(VAR item: LONGINT; data: LONGINT);
BEGIN
	CASE item OF
		SetupDialogC:
		BEGIN
			result := 0;
		END;

		100:	DisplaySwapPane(dlogID, 10, 1);  { Display pane 1 }
		101:	DisplaySwapPane(dlogID, 10, 2);  { Display pane 2 }
		102:	DisplaySwapPane(dlogID, 10, 3);  { Display pane 3 }

	END;
END;

See Also:

CreateSwapControl   CreateSwapPane  



  GetBooleanItem Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   GetBooleanItem
(   dialogID :LONGINT;
    componentID :LONGINT;
  VAR  outState :BOOLEAN
) ;

Python:

def  vs.GetBooleanItem(dialogID, componentID):
   return outState

Description:

Determines if a radio or checkbox button is selected or not.

説明

チェックボックスまたはラジオボタンの選択状態を返します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier for the radio or checkbox button component. アイテム番号
outState True if the button is selected, false otherwise. TRUE:選択されています。 FALSE:選択されていません。



  GetChoiceCount Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   GetChoiceCount
(   dialogID :LONGINT;
    componentID :LONGINT;
  VAR  outCount :INTEGER
) ;

Python:

def  vs.GetChoiceCount(dialogID, componentID):
   return outCount

Description:

Gets the number of items in the component that contains the choices.

説明

プルダウンメニューやリストアイテムの項目数を返します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier for the component that contains the choices. アイテム番号
outCount The number of items in the component. 項目数



  GetChoiceIndex Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   GetChoiceIndex
(   dialogID :LONGINT;
    componentID :LONGINT;
    itemText :STRING;
  VAR  itemIndex :INTEGER
) ;

Python:

def  vs.GetChoiceIndex(dialogID, componentID, itemText):
   return itemIndex

Description:

Finds the index of the given string in a layout manager list box or pull down menu. The index is zero based and is set to -1 if the item is not found.

説明

リストボックスやプルダウンメニューで、特定のストリングを検索します。インデックスは0から始まり、見つからなかったときは、-1を返します。



  GetChoiceStringFromStoryBoundData Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   GetChoiceStringFromStoryBoundData
(   boundType :INTEGER;
    boundStory :INTEGER;
    layerLevelType :STRING;
  VAR  choiceString :STRING
) ;

Python:

def  vs.GetChoiceStringFromStoryBoundData(boundType, boundStory, layerLevelType):
   return choiceString

Description:

Gets the story bound choice string from story bound data.

説明

ストーリの高さ基準データから、ストーリの高さ基準の選択ストリングを返します。

Parameters:

boundType Bounding type: 0 - DefaultWallHeight; 1 - LayerZ; 2 - Story. 高さ基準のタイプ : 0 - 初期設定の壁の高さ; 1 - レイヤ高さ Z; 2 - 高さ基準.
boundStory The story identified by 'boundType' = (2 - Story). If 'boundStory' = 0 then it is this story (the object's story); If 'boundStory' = 1 then it is the story above; If 'boundStory' = 2 then it is the story below. 高さ基準のタイプ boundType = 2 の場合、0 : 図形の高さ基準; 1 : 上のストーリ; 2 : 下のストーリ
layerLevelType The layer type which defines this bound. レイヤのタイプ
choiceString Returns the choice string that represents the story bound data. ストーリの高さ基準の選択ストリング

See Also:

GetStoryBoundChoiceStrings   GetStoryBoundDataFromChoiceString  



  GetChoiceText Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   GetChoiceText
(   dialogID :LONGINT;
    componentID :LONGINT;
    itemIndex :INTEGER;
  VAR  itemText :STRING
) ;

Python:

def  vs.GetChoiceText(dialogID, componentID, itemIndex):
   return itemText

Description:

Using the index, gets the text of the menu item of the given component.

説明

インデックスを使用して、プルダウンメニューやリストアイテムのテキストを返します。

Parameters:

dialogID The dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier of the control that contains the menu items from which the text will be retrieved from. アイテム番号
itemIndex The item index that contains the desired text. 項目番号
itemText The text of the item. 項目の文字列



  GetColorButton Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   GetColorButton
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  red :LONGINT;
  VAR  green :LONGINT;
  VAR  blue :LONGINT
) ;

Python:

def  vs.GetColorButton(dialogID, itemID):
   return (red, green, blue)

Description:

Gets the color of a modern dialog color button.

説明

カラーボタンの色を返します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the color button. カラーボタンアイテム番号
red The red component of the color. 色の赤成分
green The green component of the color. 色の緑成分
blue The blue component of the color. 色の青成分

See Also:

SetColorButton  



  GetColorChoice Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   GetColorChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  colorIndex :INTEGER
) ;

Python:

def  vs.GetColorChoice(dialogID, itemID):
   return colorIndex

Description:

Get current choice for color popup dialog control.

説明

選択されているカラーポップアップコントロールを返します。

返り値

カラーパレット番号

Example:

PROCEDURE Example;
VAR
   dialog1 :INTEGER;
   result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
   CASE item OF
      SetupDialogC:
         BEGIN
            SetColorChoice(dialog1, 4, 1242);
         END;
      1:
         BEGIN
            GetColorChoice(dialog1, 4, result);
            AlrtDialog(Concat('color index: ', result));
         END;
   END;
END;
BEGIN
   dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
   CreateColorPopup(dialog1, 4, 24);
   SetFirstLayoutItem(dialog1, 4);
   result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);



  GetComponentRect Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   GetComponentRect
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
  VAR  nLeft :INTEGER;
  VAR  nTop :INTEGER;
  VAR  nRight :INTEGER;
  VAR  nBottom :INTEGER
) :BOOLEAN ;

Python:

def  vs.GetComponentRect(nDialogID, nComponentID):
   return (BOOLEAN, nLeft, nTop, nRight, nBottom)

Description:

Retrieves the bounding rect coordinates of the specified Layout Manager component.

説明

指定したレイアウトダイアログのコンポーネントの四角形の領域の座標を返します。



  GetComponentTextWidth Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   GetComponentTextWidth
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
  VAR  nWidthInLMUnits :INTEGER
) :BOOLEAN ;

Python:

def  vs.GetComponentTextWidth(nDialogID, nComponentID):
   return (BOOLEAN, nWidthInLMUnits)

Description:

Retrieves the static text's width in Layout Manager Units.

説明

指定したレイアウトダイアログの単位でテキストフィールドの幅を返します。



  GetControlData Dialogs - Modern 
VectorWorks8.5

VectorScript Declaration:

PROCEDURE   GetControlData
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  data :LONGINT
) ;

Python:

def  vs.GetControlData(dialogID, itemID):
   return data

Description:

Returns information about the specified extended control item.

説明

指定したアイテムのデータを返します。

Parameters:

dialogID Index of dialog layout containing the control item. ダイアログ番号
itemID Index of the control item. アイテム番号
data Current setting of the control. アイテムのデータ



  GetDlgCtrlWidthStdCh Dialogs - Modern 
Vectorworks 2019

VectorScript Declaration:

FUNCTION   GetDlgCtrlWidthStdCh
( str:DYNARRAY[] of CHAR ) :INTEGER ;

Python:

def  vs.GetDlgCtrlWidthStdCh(str):
   return INTEGER

Description:

Returns the width in standard characters for dialog control creation.

The width is different than the number of symbols (Len) as in some languages (Japanese for example) the symbols are very different in size on the dialog.

E.g. CreateStaticText

説明

ダイアログコントロールの作成用に、標準文字の幅を返します。

言語によって(例:日本語など)、ダイアログボックス内でのシンボルのサイズは大きく異なるため、この幅はシンボル数(Len)とは異なります。

E.g. CreateStaticText

Parameters:

str The string used to calculate the std character count. 文字列

Result:

Return the number of std characters in the input string.

返り値

入力したストリング内での標準文字数を返します。

See Also:

CreateStaticText   CreateCenteredStaticText   CreateStyledStatic   CreateEditInteger   CreateEditReal   CreateEditText   CreateEditTextBox   CreateListBox   CreateListBoxN   CreateLB   CreatePullDownMenu   CreateEnhancedPullDownMenu   CreateColorPopup   CreatePullDownMenuGroupBox   CreateTreeControl   CreateClassPullDownMenu   CreateDesignLayerPullDownMenu   CreateSheetLayerPullDownMenu  



  GetEditInteger Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetEditInteger
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  value :LONGINT
) :BOOLEAN ;

Python:

def  vs.GetEditInteger(dialogID, itemID):
   return (BOOLEAN, value)

Description:

Returns the numeric value from the specified INTEGER numeric edit field control.

説明

整数型の編集フィールドに入力されている整数値を返します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the control item. 整数型の編集フィールドアイテム番号
value The value contained in the field. 整数値

Result:

A BOOLEAN value indicating the success of the operation.

返り値

正しく取得できた場合はTRUEを返します。



  GetEditReal Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetEditReal
(   dialogID :LONGINT;
    itemID :LONGINT;
    editRealType :LONGINT;
  VAR  value :REAL
) :BOOLEAN ;

Python:

def  vs.GetEditReal(dialogID, itemID, editRealType):
   return (BOOLEAN, value)

Description:

Returns the numeric value from the specified REAL numeric edit field control.

説明

実数型の編集フィールドに入力されている実数値を返します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the control item. 実数型の編集フィールドアイテム番号
editRealType The type of REAL value being returned. 数値タイプ
value The value contained in the field. 実数値

Result:

A BOOLEAN value indicating the success of the operation.

返り値

正しく取得できた場合はTRUEを返します。

Example:

PROCEDURE Dialog_Handler(var item :LONGINT; data :LONGINT);

PROCEDURE InvalidValue(controlID :INTEGER);
BEGIN
	item := -1;
	SelField(controlID);
	SysBeep;
END;

BEGIN
	CASE item OF
	     	SetupDialogC: SetEditReal(dialogID, 11, 3, elevation);
     		1: IF NOT(GetEditReal(dialogID, 11, 3, elevation)) 
                 THEN InvalidValue(11);
	END;
END;



  GetGradientSlider Dialogs - Modern 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   GetGradientSlider
(   dialogID :LONGINT;
    componentID :LONGINT;
    segmentIndex :INTEGER;
  VAR  spotPosition :REAL;
  VAR  midpointPosition :REAL;
  VAR  red :LONGINT;
  VAR  green :LONGINT;
  VAR  blue :LONGINT;
  VAR  opacity :INTEGER
) ;

Python:

def  vs.GetGradientSlider(dialogID, componentID, segmentIndex):
   return (spotPosition, midpointPosition, red, green, blue, opacity)

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号
segmentIndex Segment from which to get the data. 変化位置番号
spotPosition Position of the segment's color marker relative to left-most point of the slider. 変化点の位置
midpointPosition Position of the segment's midpoint marker relative to color marker immediately to left. 変化の中心点の位置
red Red component of the color spot's color. 変化点の色の赤成分
green Red component of the color spot's color. 変化点の色の緑成分
blue Blue component of the color spot's color. 変化点の色の青成分
opacity Opacity for the color at the spot position. 変化点の色の不透明度

Example:

GetGradientSlider(dialogID, componentID, 4, spotPosition, midpointPosition, red, green, blue,opacity);

See Also:

SetGradientSlider   InsertGradientSliSeg  



  GetGradientSliderData Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   GetGradientSliderData
(   dialogID :LONGINT;
    componentID :LONGINT;
    segmentIndex :INTEGER;
  VAR  spotPosition :REAL;
  VAR  midpointPosition :REAL;
  VAR  red :LONGINT;
  VAR  green :LONGINT;
  VAR  blue :LONGINT
) ;

Python:

def  vs.GetGradientSliderData(dialogID, componentID, segmentIndex):
   return (spotPosition, midpointPosition, red, green, blue)

Description:

Gets the spot position, midpoint position and color of the specified gradient slider segment.

説明

グラデーションスライダーにある変化位置の変化点、変化の中心点の位置と色を返します。

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号
segmentIndex Segment from which to get the data. (segment indexes begin with 1) 変化位置番号(最も左を1とする)
spotPosition Position of the segment's color marker relative to left-most point of the slider. (position >= 0.0 and position <= 1.0) 変化点の位置(0.0以上1.0以下)
midpointPosition Position of the segment's midpoint marker relative to color marker immediately to left. (position >= 0.0 and position <= 1.0) 変化の中心点の位置(0.0以上1.0以下)
red Red component of the color spot's color. (red >= 0 and red <= 255) 変化点の色の赤成分(0以上255以下)
green Green component of the color spot's color. (green >= 0 and green <= 255) 変化点の色の緑成分(0以上255以下)
blue Blue component of the color spot's color. (blue >= 0 and blue <= 255) 変化点の色の青成分(0以上255以下)

Example:

GetGradientSliderData(dialogID, componentID, 4, 0.7, 0.3, 255, 255, 255);



  GetGradientSliderSelectedMarker Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   GetGradientSliderSelectedMarker
(   dialogID :LONGINT;
    componentID :LONGINT;
  VAR  segmentIndex :INTEGER;
  VAR  markerType :INTEGER
) ;

Python:

def  vs.GetGradientSliderSelectedMarker(dialogID, componentID):
   return (segmentIndex, markerType)

Description:

Gets the selected marker for the specified gradient slider.

Note: use the number, 1, to identify a color marker and the number, 2, to identify a midpoint marker.

説明

グラデーションスライダーの選択されている点を返します。

注:1ならば変化点、2ならば変化の中心点です。

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号
segmentIndex Index to segment containing selected marker. (segment indexes begin with 1) 変化位置番号(最も左を1とする)
markerType Type of marker selected. (1 = color marker, 2 = midpoint marker) 点の種類(1:変化点/2:変化の中心点)

Example:

GetGradientSliderSelectedMarker(dialogID, componentID, segmentIndex, markerType);



  GetIconPushButtonState Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   GetIconPushButtonState
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
  VAR  bPressed :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.GetIconPushButtonState(nDialogID, nComponentID):
   return (BOOLEAN, bPressed)

Description:

Retrieves the state of the specified Layout Manager icon push button (pressed or not pressed).

説明

指定したアイコンプッシュボタンの状態(押された、または押されていないなど)を返します。



  GetImagePopupObject Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

FUNCTION   GetImagePopupObject
(   dialogID :LONGINT;
    componentID :LONGINT;
    itemIndex :INTEGER
) :STRING ;

Python:

def  vs.GetImagePopupObject(dialogID, componentID, itemIndex):
   return STRING

Description:

Returns the object name for the specified image popup item.

説明

イメージポップアップメニューのメニュー項目番号から図形の名前を返します。

Parameters:

dialogID Index to the dialog layout that contains the image popup component. ダイアログ番号
componentID Index to a specific image popup component. イメージポップアップメニューアイテム番号
itemIndex Image popup item index for object to be retrieved. イメージポップアップメニューのメニュー項目番号

Result:

Returns name of object stored at specified image popup index.

返り値

イメージポップアップメニューのメニュー項目番号から図形の名前を返します。

Example:

objectName := GetImagePopupObject(dialogID, componentID, 4);

See Also:

InsertImagePopupObjectItem   GetNumImagePopupItems   GetImagePopupObjectItemIndex   SetImagePopupSelectedItem   GetImagePopupSelectedItem   RemoveImagePopupItem   RemoveAllImagePopupItems  



  GetImagePopupObjectItemIndex Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

FUNCTION   GetImagePopupObjectItemIndex
(   dialogID :LONGINT;
    componentID :LONGINT;
    objectName :STRING
) :INTEGER ;

Python:

def  vs.GetImagePopupObjectItemIndex(dialogID, componentID, objectName):
   return INTEGER

Description:

Returns item index for the specified object.

説明

イメージポップアップメニュー内の図形の名前からメニュー項目番号を返します。

Parameters:

dialogID Index to the dialog layout that contains the image popup component. ダイアログ番号
componentID Index to a specific image popup component. イメージポップアップメニューアイテム番号
objectName Name of object for which the image popup index should be retrieved. イメージポップアップメニュー内の図形の名前

Result:

Returns the image popup index for the specified object.

返り値

イメージポップアップメニュー内の図形の名前からメニュー項目番号を返します。

Example:

imagePopupIndex := GetImagePopupObjectItemIndex(dialogID, componentID, 'Symbol-1');

See Also:

InsertImagePopupObjectItem   GetNumImagePopupItems   GetImagePopupObject   SetImagePopupSelectedItem   GetImagePopupSelectedItem   RemoveImagePopupItem   RemoveAllImagePopupItems  



  GetImagePopupSelectedItem Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

FUNCTION   GetImagePopupSelectedItem
(   dialogID :LONGINT;
    componentID :LONGINT
) :INTEGER ;

Python:

def  vs.GetImagePopupSelectedItem(dialogID, componentID):
   return INTEGER

Description:

Gets the selected image popup item.

説明

イメージポップアップメニューの選択されているメニュー項目番号を返します。

Parameters:

dialogID Index to the dialog layout that contains the image popup component. ダイアログ番号
componentID Index to a specific image popup component. イメージポップアップメニューアイテム番号

Result:

Returns the image popup index for the currently selected item.

返り値

選択されたイメージポップアップメニューのメニュー項目番号を返します。

Example:

selectedItemIndex := GetImagePopupSelectedItem(dialogID, componentID);

See Also:

InsertImagePopupObjectItem   GetNumImagePopupItems   GetImagePopupObject   GetImagePopupObjectItemIndex   SetImagePopupSelectedItem   RemoveImagePopupItem   RemoveAllImagePopupItems  



  GetItemText Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   GetItemText
(   dialogID :LONGINT;
    componentID :LONGINT;
  VAR  text :STRING
) ;

Python:

def  vs.GetItemText(dialogID, componentID):
   return text

Description:

Gets the text that is contained in the given componentID.

説明

テキストフィールドに入力された文字列を返します。(255文字以下)

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier of the component that the text will be retrieved from. アイテム番号
text The text of the component. テキストフィールドに入力された文字列



  GetLayoutDialogPosition Dialogs - Modern 
VectorWorks11.0

VectorScript Declaration:

FUNCTION   GetLayoutDialogPosition
(   dialogID :LONGINT;
  VAR  left :INTEGER;
  VAR  top :INTEGER;
  VAR  right :INTEGER;
  VAR  bottom :INTEGER
) :BOOLEAN ;

Python:

def  vs.GetLayoutDialogPosition(dialogID):
   return (BOOLEAN, left, top, right, bottom)

Description:

This function will retrieve the screen location of the dialog window, in pixels.

This function can be useful for displaying a dialog in a position in which it was placed during prior use.

説明

ダイアログウインドウの位置を検索し、ピクセルで返します。

Parameters:

dialogID Index of the dialog. ダイアログ番号
left Location of left edge of dialog, in pixels. 左(ピクセル)
top Location of top of dialog, in pixels. 上(ピクセル)
right Location of right edge of dialog, in pixels. 右(ピクセル)
bottom Location of bottom edge of dialog, in pixels. 下(ピクセル)

Result:

true - success - the location of the dialog window was retrieved.
false - failure - the location of the dialog window was not retrieved, likely because it does not currently exist, or the dialogID is invalid. The dialog window will exist anytime between the Setup message and OK/Cancel message.

返り値

TRUE:ダイアログウインドウの位置が検索されました。
FALSE:ダイアログウインドウの位置が検索されませんでした。存在していないか、ダイアログ番号が無効のようです。ダイアログウインドウはSetupメッセージとOK/Cancelメッセージの間にあります。

See Also:

SetLayoutDialogPosition  



  GetLayoutDialogSize Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   GetLayoutDialogSize
(   dialogID :LONGINT;
  VAR  width :INTEGER;
  VAR  height :INTEGER
) ;

Python:

def  vs.GetLayoutDialogSize(dialogID):
   return (width, height)

Description:

Retrieves a Layout Manager dialog's size, in pixels.

説明

レイアウトダイアログのサイズを返します。



  GetLBHeaderTextWidth Dialogs - Modern 
Vectorworks 2009

VectorScript Declaration:

FUNCTION   GetLBHeaderTextWidth
(   className :STRING;
    allowForSortIcon :BOOLEAN
) :INTEGER ;

Python:

def  vs.GetLBHeaderTextWidth(className, allowForSortIcon):
   return INTEGER

Description:

Produces the width in pixels that will show the given string without truncation in a listbrowser column header. This will provide a guaranteed appropriate width for InsertLBColumn.

説明

リストブラウザの列ヘッダで文字列が短縮されずに表示される幅をピクセルで返します。InsertLBColumnで幅を適切に設定する際に利用します。



  GetLineAttributeData Dialogs - Modern 
VectorWorks12.0 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   GetLineAttributeData
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  lineStyle :INTEGER;
  VAR  lineWeight :INTEGER
) ;

Python:

def  vs.GetLineAttributeData(dialogID, itemID):
   return (lineStyle, lineWeight)

Special Notes:

GetLineAttributeData is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use GetLineTypeAttriData instead.

説明

選択されている線種と線の太さを返します。線種はインデックス(2、-1~-32)、線の太さはミル。

See Also:

GetLineTypeAttriData  



  GetLineStyleChoice Dialogs - Modern 
VectorWorks12.0 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   GetLineStyleChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  lineStyle :INTEGER
) ;

Python:

def  vs.GetLineStyleChoice(dialogID, itemID):
   return lineStyle

Special Notes:

GetLineStyleChoice is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use GetLineTypeChoice instead.

説明

選択されている線種を返します。線種はインデックス(2、-1~-32)。

See Also:

GetLineTypeChoice  



  GetLineTypeAtIndex Dialogs - Modern 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   GetLineTypeAtIndex
(   dialogID :LONGINT;
    itemID :LONGINT;
    index :INTEGER;
  VAR  lineType :LONGINT
) ;

Python:

def  vs.GetLineTypeAtIndex(dialogID, itemID, index):
   return lineType

Description:

Get the line type at the specified index in the line style control.

説明

線種ポップアップコントロールで指定した項目のラインタイプのインデックスを返します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the line style control. ポップアップコントロールのアイテム番号
index The choice index. 項目番号
lineType The internal index (reference number) of the line type. ラインタイプのインデックス



  GetLineTypeAttriData Dialogs - Modern 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   GetLineTypeAttriData
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  lineType :LONGINT;
  VAR  lineWeight :INTEGER
) ;

Python:

def  vs.GetLineTypeAttriData(dialogID, itemID):
   return (lineType, lineWeight)

Description:

Get the current choices for the combined line style and line weight dialog control. The line type value is the line type internal index (reference number). The line weight value is in mils.

説明

線種と線の太さポップアップコントロール選択されているラインタイプのインデックスと線の太さ(ミル)を返します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the line attribute control. ポップアップコントロールのアイテム番号
lineType The internal index (reference number) of the line type. ラインタイプのインデックス
lineWeight The line weight.The value is in mils. 線の太さ



  GetLineTypeChoice Dialogs - Modern 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   GetLineTypeChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  lineType :LONGINT
) ;

Python:

def  vs.GetLineTypeChoice(dialogID, itemID):
   return lineType

Description:

Get current choice of line style popup dialog control. Choice is the internal index (reference number) of the line type.

説明

線種ポップアップコントロールで選択されている項目のラインタイプのインデックスを返します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the line style control. ポップアップコントロールのアイテム番号
lineType The internal index (reference number) of the line type. ラインタイプのインデックス



  GetLineWeightChoice Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   GetLineWeightChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  lineWeight :INTEGER
) ;

Python:

def  vs.GetLineWeightChoice(dialogID, itemID):
   return lineWeight

Description:

Get current choice for a line weight dialog control. The value is in mils.

説明

選択されている線の太さを返します。線の太さはミル。



  GetMarkerChoice Dialogs - Modern 
VectorWorks12.0 - obsolete as of VectorWorks 2008

VectorScript Declaration:

PROCEDURE   GetMarkerChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  index :INTEGER;
  VAR  style :INTEGER;
  VAR  angle :INTEGER;
  VAR  size :REAL
) ;

Python:

def  vs.GetMarkerChoice(dialogID, itemID):
   return (index, style, angle, size)

Special Notes:

GetMarkerChoice is obsolete as of VectorWorks 2008

Description:

OBSOLETE procedure for VW2008
Get current choice for Marker popup dialog control.

説明

選択されているマーカスタイルを返します。

VW2008で使用できなくなった関数/手続きです。
GetMarkerValueをご利用ください。

Example:

PROCEDURE Example;
VAR
   int, dialogID   :INTEGER;
   index, style, angle :INTEGER;
   size :REAL;

PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
   CASE item OF
      SetupDialogC:
         BEGIN
            index := 1;
            style := 2;
            angle := 3;
            size  := .125;
            SetMarkerChoice(dialogID, 4, index, style, angle, size);
         END;
      5: 
         BEGIN
            GetMarkerChoice(dialogID, 4, index, style, angle, size);
            AlrtDialog(Concat(
	            'index: ', index, Chr(13), 
	            'style: ', style, Chr(13), 
	            'angle: ', angle, Chr(13), 
	            'size: ', size));
         END;
   END;
END;

BEGIN
   dialogID := CreateLayout('Test', False, 'OK', '');
   CreateMarkerPopup(dialogID, 4);
   CreatePushButton(dialogID, 5, '  Display Values  ');
   SetFirstLayoutItem(dialogID, 4);
   SetBelowItem(dialogID, 4, 5, 0, 2);
   int := RunLayoutDialog(dialogID, Dialog_Handler);
END;
RUN(Example);

See Also:

SetMarkerChoice  



  GetMarkerPopupSelectedItem Dialogs - Modern 
VectorWorks10.5

VectorScript Declaration:

FUNCTION   GetMarkerPopupSelectedItem
(   dialogID :LONGINT;
    componentID :LONGINT;
  VAR  style :INTEGER;
  VAR  angle :INTEGER;
  VAR  size :INTEGER
) :INTEGER ;

Python:

def  vs.GetMarkerPopupSelectedItem(dialogID, componentID):
   return (INTEGER, style, angle, size)

Description:

This is a deprecated function. Use GetMarkerChoice instead.

Returns the 1-based index number of the selected item in the specified marker popup menu item. If return value is 8, a custom marker is selected.

説明

選択されているマーカスタイルを番号(1から始まる)で返します。カスタムが選択されている場合は8を返します。

Parameters:

dialogID ID of the dialog ダイアログ番号
componentID ID of the marker popup item マーカポップアップ番号
style On return, indicates the style of the selected marker. Valid styles: 0 - kFilledArrowMarker 1 - kEmptyArrowMarker 2 - kOpenArrowMarker 3 - kFilledBallMarker 4 - kEmptyBallMarker 5 - kSlashMarker 6 - kCrossMarker スタイル(1:塗りつぶし矢印/2:閉矢印/3:開矢印/4:黒丸/5:空白丸/6:斜線/7:十字線)
angle On return, indicates the angle of the selected marker, for arrow markers 角度
size On return, indicates the size of the selected marker 長さ



  GetMarkerValue Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   GetMarkerValue
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  style :INTEGER;
  VAR  angle :INTEGER;
  VAR  length :REAL;
  VAR  width :REAL;
  VAR  basis :INTEGER;
  VAR  thickness :REAL
) ;

Python:

def  vs.GetMarkerValue(dialogID, itemID):
   return (style, angle, length, width, basis, thickness)

Description:

Gets MarkerPopup value in dialog (replaces MarkerPopup procedures prior to VW2008).

説明

選択されているマーカポップアップの値を返します。(VW2008より前のバージョンのマーカポップアップ手続きの代わりになります。)

Parameters:

dialogID ID of the dialog ダイアログ番号
itemID ID of the marker popup control マーカポップアップ番号
style On return, indicates the style of the selected marker タイプ
angle On return, indicates the angle of the selected marker (deg) 角度(度数)
length On return, indicates the length of the selected marker (inches) 長さ(インチ)
width On return, indicates the width of the selected marker (inches) 幅(インチ)
basis On return, indicates the thickness basis of the selected marker. 太さ
thickness On return, indicates the thickness of the selected marker. カスタム設定の太さ

Example:

PROCEDURE Example;
VAR
   int, dialogID   :INTEGER;
   style, angle, thicknessBasis :INTEGER;
   width, length, thickness :REAL;

PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
   CASE item OF
      SetupDialogC:
         BEGIN
            style := 130;
            angle := 0;
            width  := .125;
		length := .125;
		thickness := 0;
		thicknessBasis := 0;
            SetMarkerValue(dialogID, 4, style, angle, width, length, thicknessBasis, thickness);
         END;
      5: 
         BEGIN
           GetMarkerValue(dialogID, 4, style, angle, width, length, thicknessBasis, thickness);

            AlrtDialog(Concat(
               'style: ', style, Chr(13), 
               'angle: ', angle, Chr(13), 
		 'width: ', width,Chr(13),
               'length: ', length, Chr(13),
		  'thickness: ', thickness, Chr(13),
		  'thicknessBasis: ', thicknessBasis));

         END;
   END;
END;

BEGIN
   dialogID := CreateLayout('Test', False, 'OK', '');
   CreateMarkerPopup(dialogID, 4);
   CreatePushButton(dialogID, 5, '  Display Values  ');
   SetFirstLayoutItem(dialogID, 4);
   SetBelowItem(dialogID, 4, 5, 0, 2);
   int := RunLayoutDialog(dialogID, Dialog_Handler);
END;
RUN(Example);

See Also:

SetmarkerValue  



  GetMultilineText Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   GetMultilineText
(   dialogID :LONGINT;
    componentID :LONGINT;
  VAR  text :DYNARRAY[] of CHAR
) ;

Python:

def  vs.GetMultilineText(dialogID, componentID):
   return text

Description:

Gets the text that is contained in the given componentID.

説明

テキストフィールドに入力された文字列を返します。

Parameters:

dialogID The dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier of the component that the text will be retrieved from. アイテム番号
text The text of the component. テキストフィールドに入力された文字列



  GetNumGradientSliderSegments Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

FUNCTION   GetNumGradientSliderSegments
(   dialogID :LONGINT;
    componentID :LONGINT
) :INTEGER ;

Python:

def  vs.GetNumGradientSliderSegments(dialogID, componentID):
   return INTEGER

Description:

Gets the number of segments in the gradient slider.

Note: a gradient slider must always have at least 2 segments.

説明

グラデーションスライダーの変化位置の数を返します。

注:グラデーションスライダーには少なくとも2つの変化点がなければなりません。

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号

Result:

Retuns number of segments in gradient slider.

(a segment consists of a color marker and the associated midpoint marker immediately to the right)

返り値

グラデーションスライダーの変化位置の数を返します。

Example:

numSegments := GetNumGradientSliderSegments(dialogID, componentID);



  GetNumImagePopupItems Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

FUNCTION   GetNumImagePopupItems
(   dialogID :LONGINT;
    componentID :LONGINT
) :INTEGER ;

Python:

def  vs.GetNumImagePopupItems(dialogID, componentID):
   return INTEGER

Description:

Returns the number of items in the image popup.

説明

イメージポップアップメニュー内のメニュー項目数を返します。

Parameters:

dialogID Index to the dialog layout that contains the image popup component. ダイアログ番号
componentID Index to a specific image popup component. イメージポップアップメニューアイテム番号

Result:

Returns the number of items in the specified image popup.

返り値

イメージポップアップメニュー内のメニュー項目数を返します。

Example:

numImagePopupItems := GetNumImagePopupItems(dialogID, componentID);

See Also:

InsertImagePopupObjectItem   GetImagePopupObject   GetImagePopupObjectItemIndex   SetImagePopupSelectedItem   GetImagePopupSelectedItem   RemoveImagePopupItem   RemoveAllImagePopupItems  



  GetNumLineTypeItems Dialogs - Modern 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   GetNumLineTypeItems
(   dialogID :LONGINT;
    itemID :LONGINT
) :INTEGER ;

Python:

def  vs.GetNumLineTypeItems(dialogID, itemID):
   return INTEGER

Description:

Returns the number of line types in the line style control.

説明

線種ポップアップコントロール内のラインタイプの数を返します

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the line style control. ポップアップコントロールのアイテム番号



  GetPatternData Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   GetPatternData
(   dialogID :LONGINT;
    itemID :LONGINT;
  VAR  patternIndex :INTEGER;
  VAR  foreColor :INTEGER;
  VAR  backColor :INTEGER
) ;

Python:

def  vs.GetPatternData(dialogID, itemID):
   return (patternIndex, foreColor, backColor)

Description:

Get current choice for pattern popup dialog control, and the displayed foreground and background color indexes.

説明

選択されている模様ポップアップコントロールの情報を返します。



  GetPopUpChoiceIndex Dialogs - Modern 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   GetPopUpChoiceIndex
(   dialogID :LONGINT;
    componentID :LONGINT;
    itemText :STRING;
  VAR  itemIndex :INTEGER
) ;

Python:

def  vs.GetPopUpChoiceIndex(dialogID, componentID, itemText):
   return itemIndex

Description:

Gets the zero based index of the first choice in the pop-up which has itemText name. If there is no choice named itemText in the pop-up itemIndex is set to -1.

説明

ポップアップの中から文字列を検索し一致するインデックス(0基準)を取得します。存在しない場合、-1を返します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout CreateLayout もしくは CreateResizableLayoutの結果得られるダイアログID
componentID The identifier of the component which choice index will be retrieved from by a given choice name. 構成要素ID。与えられた選択名をもとに抽出された選択インデックスにより特定されます。
itemText The name of the choice which index will be obtained. インデックスを取得する元となる選択肢名
itemIndex The index of the given choice's string in the pop-up. If there are duplicate choice name itemIndex is the index of the first choice having itemText name. 与えられた文字列のポップアップ中のインデックス。itemIndex が指す名前が複数ある場合、 itemTextという選択肢名の最初のもの.



  GetSelectedChoiceIndex Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   GetSelectedChoiceIndex
(   dialogID :LONGINT;
    componentID :LONGINT;
    startIndex :INTEGER;
  VAR  outSelectedIndex :INTEGER
) ;

Python:

def  vs.GetSelectedChoiceIndex(dialogID, componentID, startIndex):
   return outSelectedIndex

Description:

Gets the index of the selected choice.

説明

選択されている項目の番号を返します。

Parameters:

dialogID The dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier for the component that contains the choices. アイテム番号
startIndex The index at which to start looking for a selected item. 検索開始項目番号
outSelectedIndex The index of the selected item or -1 if there is no selected item. 選択されている項目の番号、-1の場合選択されていない。



  GetSelectedChoiceInfo Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   GetSelectedChoiceInfo
(   dialogID :LONGINT;
    componentID :LONGINT;
    startIndex :INTEGER;
  VAR  outSelectedIndex :INTEGER;
  VAR  outSelectedChoiceText :STRING
) ;

Python:

def  vs.GetSelectedChoiceInfo(dialogID, componentID, startIndex):
   return (outSelectedIndex, outSelectedChoiceText)

Description:

Gets the index of the selected item and the text of the selected item in a menu.

説明

選択されている項目の番号と文字列を返します。

Parameters:

dialogID The dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier for the component that contains the choices. アイテム番号
startIndex The index at which to start looking for a selected item. 検索開始項目番号
outSelectedIndex The index of the selected item or -1 if there is no selected item. 選択されている項目の番号、-1の場合選択されていない。
outSelectedChoiceText The text of the selected item if it was found, otherwise this parameter is unchanged from when this function was called. 選択されている項目の文字列



  GetSelectionRange Dialogs - Modern 
VectorWorks12.0.1

VectorScript Declaration:

PROCEDURE   GetSelectionRange
(   dialogID :LONGINT;
    controlID :LONGINT;
  VAR  startPos :INTEGER;
  VAR  endPos :INTEGER
) ;

Python:

def  vs.GetSelectionRange(dialogID, controlID):
   return (startPos, endPos)

Description:

Returns the range of the current selection for the specified control.

説明

指定したコントロール内の選択範囲の始点と終点を返します。



  GetStoryBoundChoiceStrings Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   GetStoryBoundChoiceStrings
(   story :HANDLE;
    topBound :BOOLEAN;
  VAR  strings :ARRAY
) ;

Python:

def  vs.GetStoryBoundChoiceStrings(story, topBound):
   return strings

Description:

Gets the choice strings for a story bound control.

説明

ストーリの高さ基準コントロールの選択ストリングを返します。

Parameters:

story The story relative to which to get the strings. Nil gets a generic list of strings. ストーリのハンドル、またはNIL。
topBound Whether to get the strings for a top bound or a bottom bound. 高さ基準(上)と高さ基準(下)のどちらか指定
strings Returns the strings. 選択ストリング

See Also:

GetStoryBoundDataFromChoiceString   GetChoiceStringFromStoryBoundData  



  GetStoryBoundDataFromChoiceString Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   GetStoryBoundDataFromChoiceString
(   choiceString :STRING;
  VAR  boundType :INTEGER;
  VAR  boundStory :INTEGER;
  VAR  layerLevelType :STRING
) ;

Python:

def  vs.GetStoryBoundDataFromChoiceString(choiceString):
   return (boundType, boundStory, layerLevelType)

Description:

Gets the story bound data from a story bound choice string.

説明

ストーリの高さ基準選択ストリングから、ストーリの高さ基準データを返します。

Parameters:

choiceString The choice string that represents the story bound data. ストーリの高さ基準の選択ストリング
boundType Returns the bounding type: 0 - DefaultWallHeight; 1 - LayerZ; 2 - Story. 高さ基準のタイプ : 0 - デフォルトの壁の高さ; 1 - レイヤ高さ Z; 2 - 高さ基準.
boundStory Returns the story identified by 'boundType' = (2 - Story). If 'boundStory' = 0 then it is this story (the object's story); If 'boundStory' = 1 then it is the story above; If 'boundStory' = 2 then it is the story below. 高さ基準のタイプ boundType = 2 の場合、0 : 図形の高さ基準; 1 : 上のストーリ; 2 : 下のストーリ
layerLevelType Returns the layer type which defines this bound. レイヤタイプ

See Also:

GetStoryBoundChoiceStrings   GetChoiceStringFromStoryBoundData  



  GetStoryChoiceStrsN Dialogs - Modern 
Vectorworks 2017

VectorScript Declaration:

PROCEDURE   GetStoryChoiceStrsN
(   story :HANDLE;
  VAR  strings :ARRAY;
    boundSelection :INTEGER
) ;

Python:

def  vs.GetStoryChoiceStrsN(story, boundSelection):
   return strings

Description:

Gets story bound strings to supply to the bound popup. Can request strings for top bound, bottom bound, or dual (both) bounds.

説明

ストーリの高さ基準コントロールの選択ストリングを返します。上、下、両方についてのストリングを取得できます。

Parameters:

story The story relative to which to get the strings. Nil gets a generic list of strings. ストーリのハンドル、またはNIL。
strings Returns the strings. 選択ストリング
boundSelection Type of bounds strings being requested: 0 for Top Bound; 1 for Dual Bound (combines both top and bottom); 2 for Bottom Bound. 高さ基準のタイプ
0 - 高さ基準(上); 1 - 両方(高さ基準上と下をあわせたもの); 2 - 高さ基準(下);



  GetThreeStateCheckBoxState Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   GetThreeStateCheckBoxState
(   dialogID :LONGINT;
    componentID :LONGINT;
  VAR  iState :INTEGER
) ;

Python:

def  vs.GetThreeStateCheckBoxState(dialogID, componentID):
   return iState

Description:

Retrieves the state of a Layout Manager three state checkbox.

説明

3状態チェックボックスの状態を返します。



  GetTreeControlItemData Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   GetTreeControlItemData
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nItemID :INTEGER;
  VAR  nUserData :LONGINT
) ;

Python:

def  vs.GetTreeControlItemData(nDialogID, nComponentID, nItemID):
   return nUserData

Description:

Retrieves the user data of the specified item from a tree control.

説明

指定したツリーアイテムのユーザデータを返します。



  GetTreeControlItemText Dialogs - Modern 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   GetTreeControlItemText
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nItemID :INTEGER;
  VAR  itemText :STRING
) :BOOLEAN ;

Python:

def  vs.GetTreeControlItemText(nDialogID, nComponentID, nItemID):
   return (BOOLEAN, itemText)

Description:

Retrieves the item text of the specified item from a tree control.

説明

ツリーコントロールから指定した項目のテキストを返します。



  GetTreeControlSelectedItem Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   GetTreeControlSelectedItem
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
  VAR  nItemID :INTEGER
) :BOOLEAN ;

Python:

def  vs.GetTreeControlSelectedItem(nDialogID, nComponentID):
   return (BOOLEAN, nItemID)

Description:

Retrieves the itemID of the selected item from a Layout Manager tree control.

説明

選択されているツリーアイテムの項目番号を返します。



  GetTreeControlTextSelectedItem Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   GetTreeControlTextSelectedItem
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
  VAR  itemText :STRING
) :BOOLEAN ;

Python:

def  vs.GetTreeControlTextSelectedItem(nDialogID, nComponentID):
   return (BOOLEAN, itemText)

Description:

Retrieves the item text of the selected item from a tree control.

説明

ツリーコントロールから選択した項目のテキストを返します。



  InsertEnhancedPullDownMenuItem Dialogs - Modern 
VectorWorks12.5 - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   InsertEnhancedPullDownMenuItem
(   dialogID :LONGINT;
    componentID :LONGINT;
    strName :STRING;
    iIconID :INTEGER
) :INTEGER ;

Python:

def  vs.InsertEnhancedPullDownMenuItem(dialogID, componentID, strName, iIconID):
   return INTEGER

Special Notes:

InsertEnhancedPullDownMenuItem is obsolete as of Vectorworks 2012

Description:

Inserts the item into the specified Layout Manager enhanced pull down menu control.

説明

指定した拡張プルダウンメニューに項目を挿入します。廃止予定の関数です。代わりに InsertEnhanPullDownMenuItem を使用してください。



  InsertEnhanPullDownMenuItem Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   InsertEnhanPullDownMenuItem
(   dialogID :LONGINT;
    controlID :LONGINT;
    strName :STRING;
    imageSpecifier :DYNARRAY[] of CHAR
) :INTEGER ;

Python:

def  vs.InsertEnhanPullDownMenuItem(dialogID, controlID, strName, imageSpecifier):
   return INTEGER

Description:

Inserts a image Replaces InsertEnhancedPulldownMenuItem

説明

InsertEnhancedPulldownMenuItem の代わりに、イメージを挿入します。

Parameters:

imageSpecifier The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)



  InsertGradientSliderSegment Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

FUNCTION   InsertGradientSliderSegment
(   dialogID :LONGINT;
    componentID :LONGINT;
    spotPosition :REAL;
    red :LONGINT;
    green :LONGINT;
    blue :LONGINT
) :INTEGER ;

Python:

def  vs.InsertGradientSliderSegment(dialogID, componentID, spotPosition, red, green, blue):
   return INTEGER

Description:

Inserts a new segment into the gradient slider and initializes its data to the specified values.

説明

グラデーションスライダーに新しい変化位置を挿入し、指定した値でそのデータを初期化します。

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号
spotPosition Position of the segment's color marker relative to left-most point of the slider. (position >= 0.0 and position <= 1.0) 変化点の位置(0.0以上1.0以下)
red Red component of the color spot's color. (red >= 0 and red <= 255) 変化点の色の赤成分(0以上255以下)
green Green component of the color spot's color. (green >= 0 and green <= 255) 変化点の色の緑成分(0以上255以下)
blue Blue component of the color spot's color. (blue >= 0 and blue <= 255) 変化点の色の青成分(0以上255以下)

Result:

Returns index to new segment.

返り値

新しい変化位置の番号を返します。

Example:

segmentIndex := InsertGradientSliderSegment(dialogID, componentID, 0.4, 255, 255, 255);



  InsertGradientSliSeg Dialogs - Modern 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   InsertGradientSliSeg
(   dialogID :LONGINT;
    componentID :LONGINT;
    spotPosition :REAL;
    red :LONGINT;
    green :LONGINT;
    blue :LONGINT;
    opacity :INTEGER
) :INTEGER ;

Python:

def  vs.InsertGradientSliSeg(dialogID, componentID, spotPosition, red, green, blue, opacity):
   return INTEGER

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号
spotPosition Position of the segment's color marker relative to left-most point of the slider. The value should be >= 0.0 and <= 1.0, which represents a percentage distance across the slider. 変化点の位置(0.0以上1.0以下)
red Red component of the color spot's color. 変化点の色の赤成分(0以上255以下)
green Green component of the color spot's color. 変化点の色の緑成分(0以上255以下)
blue Blue component of the color spot's color. 変化点の色の緑成分(0以上255以下)
opacity Opacity for the color at the spot position. 変化点の色の不透明度

Result:

Returns index to new segment.

返り値

グラデーションスライダに新しい変化点を挿入し、変化点の番号を返します。 指定した値でそのデータを初期化します。

Example:

segmentIndex := InsertGradientSliSeg(dialogID, componentID, 0.4, 255, 255, 255, 100);

See Also:

GetGradientSlider   SetGradientSlider  



  InsertImagePopupObjectItem Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

FUNCTION   InsertImagePopupObjectItem
(   dialogID :LONGINT;
    componentID :LONGINT;
    objectName :STRING
) :INTEGER ;

Python:

def  vs.InsertImagePopupObjectItem(dialogID, componentID, objectName):
   return INTEGER

Description:

Inserts the specified object into the image popup.

Note: the image popup only supports the following object types: gradients, hatches, images, record formats, render backgrounds, symbol folders, symbols, textures, vectorscript palettes, vectorscripts, worksheets.

説明

図形をイメージポップアップメニューに挿入します。

注:イメージポップアップメニューは以下の図形タイプにのみ対応しています。
グラデーション、ハッチング、イメージ、レコードフォーマット、レンダリング背景、シンボルフォルダ、シンボル、テクスチャ、VectorScriptパレット、VectorScript、ワークシート

Parameters:

dialogID Index to the dialog layout that contains the image popup component. ダイアログ番号
componentID Index to a specific image popup component. イメージポップアップメニューアイテム番号
objectName Name of the object to insert. 挿入する図形の名前

Result:

Returns an image popup index to the object inserted.

返り値

挿入された図形の項目番号を返します。

Example:

PROCEDURE dialog1_Main;
VAR
	dialog1 :INTEGER;
	int     :INTEGER;
	str     :STRING;

PROCEDURE dialog1_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
	CASE item OF
		SetupDialogC:
			BEGIN
				str := GetSDName(FSymDef);
				int := InsertImagePopupObjectItem(dialog1, 4, str);
				SetImagePopupSelectedItem(dialog1, 4, int);
			END;
	END;
END;

BEGIN
	dialog1 := CreateLayout('Image Pop-Up', FALSE, 'OK', '');
	CreateControl(dialog1, 4, 10, '', 0);
	SetFirstLayoutItem(dialog1, 4);
	int := RunLayoutDialog(dialog1, dialog1_Handler);
END;
RUN(dialog1_Main);

See Also:

GetNumImagePopupItems   GetImagePopupObject   GetImagePopupObjectItemIndex   SetImagePopupSelectedItem   GetImagePopupSelectedItem   RemoveImagePopupItem   RemoveAllImagePopupItems  



  InsertImagePopupResource Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   InsertImagePopupResource
(   dialogID :LONGINT;
    componentID :LONGINT;
    listID :LONGINT;
    index :LONGINT
) :LONGINT ;

Python:

def  vs.InsertImagePopupResource(dialogID, componentID, listID, index):
   return LONGINT

Description:

Inserts the indicated item of the specified resource list into the indicated image popup and returns the image popup index of the inserted item.

説明

リソースファイルから指定された項目を、イメージポップアップメニューに挿入します。挿入された項目のイメージポップアップのインデックスを返します。

Parameters:

dialogID index to the dialog layout that contains the image popup component. ダイアログ番号
componentID index to a specific image popup component. イメージポップアップメニュー番号
listID an ID for a resource list created by the BuildResourceList function. リソースリスト番号
index an index into the list. リソース番号

Example:

{ Add all items in the resource list to the image popup. }
for index:=1 to numItems do
   index := InsertImagePopupResource(dialogID, kImagePopupID, listID,   index);



  InsertImagePopupSeparator Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   InsertImagePopupSeparator
(   liDialogID :LONGINT;
    liComponentID :LONGINT;
    strLabel :STRING
) :INTEGER ;

Python:

def  vs.InsertImagePopupSeparator(liDialogID, liComponentID, strLabel):
   return INTEGER

Description:

Inserts a separator with the specified label at the end of the image popup list.

説明

イメージポップアップメニューリストの末尾に指定したラベルがある状態で、セパレータを挿入します。



  InsertPropClassOrLayerItem Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   InsertPropClassOrLayerItem
(   dialogID :LONGINT;
    controlID :LONGINT;
    strLabel :STRING;
    imageSpecifier :DYNARRAY[] of CHAR
) :BOOLEAN ;

Python:

def  vs.InsertPropClassOrLayerItem(dialogID, controlID, strLabel, imageSpecifier):
   return BOOLEAN

Description:

Inserts a class or layer item in the proposed section of a Class, Design Layer, or Sheet Layer Layout Manager Pull Down.

説明

クラス項目またはレイヤ項目を、クラス、デザインレイヤ、またはシートレイヤのプルダウンメニューの任意の場所に挿入します。

Parameters:

dialogID The dialog identifier given by the command to create the dialog. ダイアログ番号
controlID The control identifier. アイテム番号
strLabel Text for the label of the Pull Down. 項目の文字列
imageSpecifier The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)



  InsertProposedClassOrLayerItem Dialogs - Modern 
VectorWorks 2008 - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   InsertProposedClassOrLayerItem
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    strLabel :STRING;
    nIconIndex :INTEGER
) :BOOLEAN ;

Python:

def  vs.InsertProposedClassOrLayerItem(nDialogID, nComponentID, strLabel, nIconIndex):
   return BOOLEAN

Special Notes:

InsertProposedClassOrLayerItem is obsolete as of Vectorworks 2012

Description:

Inserts a class or layer item in the proposed section of a Class, Design Layer, or Sheet Layer Layout Manager Pull Down.

説明

クラス項目またはレイヤ項目を、クラス、デザインレイヤ、またはシートレイヤのプルダウンメニューの任意の場所に挿入します。廃止予定の関数です。代わりに InsertPropClassOrLayerItem を使用してください。



  InsertTreeControlItem Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   InsertTreeControlItem
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    strItemLabel :STRING;
    nParentID :INTEGER;
    nAfterID :INTEGER
) :INTEGER ;

Python:

def  vs.InsertTreeControlItem(nDialogID, nComponentID, strItemLabel, nParentID, nAfterID):
   return INTEGER

Description:

Inserts an item into a Layout Manager tree control.

説明

ツリーアイテムに項目を挿入します。



  IsClassChoiceSelected Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   IsClassChoiceSelected
(   dialogID :LONGINT;
    componentID :LONGINT
) :BOOLEAN ;

Python:

def  vs.IsClassChoiceSelected(dialogID, componentID):
   return BOOLEAN

Description:

Returns if 'By Class' is the selected choice in a marker, line style, or color popup control.

説明

マーカー、線種、色のポップアップで「クラス属性」が選択されているかを返します。

Parameters:

dialogID Id of the dialog ダイアログ番号
componentID Id of the popup control ポップアップのアイテム番号



  IsItemEnabled Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   IsItemEnabled
(   nDialogID :LONGINT;
    nComponentID :LONGINT
) :BOOLEAN ;

Python:

def  vs.IsItemEnabled(nDialogID, nComponentID):
   return BOOLEAN

Description:

Determines if the specified item is currently enabled.

説明

指定したアイテムの有効/無効を返します。



  IsItemVisible Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   IsItemVisible
(   nDialogID :LONGINT;
    nComponentID :LONGINT
) :BOOLEAN ;

Python:

def  vs.IsItemVisible(nDialogID, nComponentID):
   return BOOLEAN

Description:

Determines if the specified item is currently visible.

説明

指定したアイテムの表示/非表示を返します。



  NotifyPullDownClicked Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   NotifyPullDownClicked
(   nDialogID :LONGINT;
    nComponentID :LONGINT
) ;

Python:

def  vs.NotifyPullDownClicked(nDialogID, nComponentID):
   return None

Description:

Sends an item hit notification when the pull down menu is clicked, allowing developers to dynamically populate the menu.

説明

プルダウンメニューがクリックされたことを返します。動的メニューを生成することができます。



  RefreshItem Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   RefreshItem
(   liDialogID :LONGINT;
    liComponentID :LONGINT
) ;

Python:

def  vs.RefreshItem(liDialogID, liComponentID):
   return None

Description:

Refreshes the specified item.

説明

指定したアイテムを更新します。



  RegisterDialogForTimerEvents Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   RegisterDialogForTimerEvents
(   dialogID :LONGINT;
    timerDelayInMilliseconds :LONGINT
) ;

Python:

def  vs.RegisterDialogForTimerEvents(dialogID, timerDelayInMilliseconds):
   return None

Description:

Register the dialog so that it can receive events periodically using the given time delay. Using the command will make Vectorworks send the event 'DialogTimerEventMessageC' to the dialog handler on the specified time interval.

説明

ダイアログを登録して一定時間ごとにイベントを受け取れるようにします。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
timerDelayInMilliseconds The amount of time in milliseconds between each event DialogTimerEventMessageC that is going to be sent to the dialog handler function. 「DialogTimerEventMessageC.」を呼び出す間隔(ミリ秒)



  RemoveAllImagePopupItems Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   RemoveAllImagePopupItems
(   dialogID :LONGINT;
    componentID :LONGINT
) ;

Python:

def  vs.RemoveAllImagePopupItems(dialogID, componentID):
   return None

Description:

Removes all items from the image popup.

説明

イメージポップアップメニューからすべてのメニュー項目を削除します。

Parameters:

dialogID Index to the dialog layout that contains the image popup component. ダイアログ番号
componentID Index to a specific image popup component. イメージポップアップメニューアイテム番号

Example:

RemoveAllImagePopupItems(dialogID, componentID);

See Also:

InsertImagePopupObjectItem   GetNumImagePopupItems   GetImagePopupObject   GetImagePopupObjectItemIndex   SetImagePopupSelectedItem   GetImagePopupSelectedItem   RemoveImagePopupItem  



  RemoveChoice Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   RemoveChoice
(   dialogID :LONGINT;
    componentID :LONGINT;
    itemIndex :INTEGER
) ;

Python:

def  vs.RemoveChoice(dialogID, componentID, itemIndex):
   return None

Description:

Remove a menu item from a control that can display a menu.

説明

プルダウンメニューやリストアイテムにある項目を削除します。

Parameters:

dialogID The dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier of the control that will have its menu item removed. アイテム番号
itemIndex The zero-based index of the menu item to remove. 項目番号



  RemoveEnhancedPullDownMenuItemRange Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   RemoveEnhancedPullDownMenuItemRange
(   dialogID :LONGINT;
    componentID :LONGINT;
    iStartItemIndexToRemove :INTEGER;
    iEndItemIndexToRemove :INTEGER
) ;

Python:

def  vs.RemoveEnhancedPullDownMenuItemRange(dialogID, componentID, iStartItemIndexToRemove, iEndItemIndexToRemove):
   return None

Description:

Removes the specified range of items from the specified Layout Manager enhanced pull down menu control.

説明

グループボックスのプルダウンメニューにある指定した範囲の項目を削除します。



  RemoveGradientSliderSegment Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   RemoveGradientSliderSegment
(   dialogID :LONGINT;
    componentID :LONGINT;
    segmentIndex :INTEGER
) ;

Python:

def  vs.RemoveGradientSliderSegment(dialogID, componentID, segmentIndex):
   return None

Description:

Removes the specified segment from the gradient slider.

Note: a gradient slider must always have at least 2 segments.

説明

グラデーションスライダーから変化位置を削除します。

注:グラデーションスライダーには少なくとも2つの変化点がなければなりません。

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号
segmentIndex Index to segment to be removed. (segment indexes begin with 1) 変化位置番号(最も左を1とする)

Example:

RemoveGradientSliderSegment(dialogID, componentID, 4);



  RemoveImagePopupItem Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   RemoveImagePopupItem
(   dialogID :LONGINT;
    componentID :LONGINT;
    itemIndex :INTEGER
) ;

Python:

def  vs.RemoveImagePopupItem(dialogID, componentID, itemIndex):
   return None

Description:

Removes the specified item from the image popup.

説明

イメージポップアップメニューからメニュー項目を削除します。

Parameters:

dialogID Index to the dialog layout that contains the image popup component. ダイアログ番号
componentID Index to a specific image popup component. イメージポップアップメニューアイテム番号
itemIndex Index to item to be removed. 削除するメニュー項目番号

Example:

RemoveImagePopupItem(dialogID, componentID, 4);

See Also:

InsertImagePopupObjectItem   GetNumImagePopupItems   GetImagePopupObject   GetImagePopupObjectItemIndex   SetImagePopupSelectedItem   GetImagePopupSelectedItem   RemoveAllImagePopupItems  



  RemoveListBoxTabStop Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   RemoveListBoxTabStop
(   dialogID :LONGINT;
    itemID :LONGINT
) ;

Python:

def  vs.RemoveListBoxTabStop(dialogID, itemID):
   return None

Description:

Removes the last tab stop from a Layout Manager list box.

説明

リストボックスから最後のタブストップを削除します。

Parameters:

dialogID ID of the dialog ダイアログ番号
itemID ID of the list box リストボックスアイテム番号

See Also:

AddListBoxTabStop  



  RemoveTreeControlItem Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   RemoveTreeControlItem
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nItemID :INTEGER
) :BOOLEAN ;

Python:

def  vs.RemoveTreeControlItem(nDialogID, nComponentID, nItemID):
   return BOOLEAN

Description:

Removes an item from a Layout Manager tree control.

説明

ツリーアイテムから項目を削除します。



  RunLayoutDialog Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   RunLayoutDialog
(   dialogID :LONGINT;
    callback :PROCEDURE
) :LONGINT ;

Python:

def  vs.RunLayoutDialog(dialogID, callback):
   return LONGINT

Description:

Displays the specified dialog and initiates the dialog event loop. The dialog event loop is specified in a procedure subroutine that is passed as a parameter to the function.

説明

指定したダイアログ番号とサブルーチンの名前で、ダイアログイベントループを実行します。

Parameters:

dialogID The index of the dialog to be displayed. ダイアログ番号
callback The event loop subroutine for the dialog. サブルーチンの名前

Result:

Returns a LONGINT value indicating the button pressed to exit the dialog.

返り値

最後に押されたボタンの種類(1:OK/2:キャンセル)を返します。



  RunLayoutDialogN Dialogs - Modern 
Vectorworks 2018

VectorScript Declaration:

FUNCTION   RunLayoutDialogN
(   dialogID :LONGINT;
    callback :PROCEDURE;
    enableContextualHelp :BOOLEAN
) :LONGINT ;

Python:

def  vs.RunLayoutDialogN(dialogID, callback, enableContextualHelp):
   return LONGINT

Description:

Displays the specified dialog and initiates the dialog event loop. The dialog event loop is specified in a procedure subroutine that is passed as a parameter to the function.

説明

指定したダイアログボックス番号とサブルーチンの名前で、ダイアログボックスイベントループを実行します。

Parameters:

dialogID The index of the dialog to be displayed. ダイアログ番号
callback The event loop subroutine for the dialog. サブルーチンの名前
enableContextualHelp Determines whether or not contextual help is accessible ヘルプへのアクセスボタンを表示する/しない

Result:

Returns a LONGINT value indicating the button pressed to exit the dialog.

返り値

最後に押されたボタンの種類(1:OK/2:キャンセル)を返します。



  RunNamedDialog Dialogs - Modern 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   RunNamedDialog
(   dialogID :LONGINT;
    callback :PROCEDURE;
    univName :STRING
) :LONGINT ;

Python:

def  vs.RunNamedDialog(dialogID, callback, univName):
   return LONGINT

Description:

Displays the specified dialog with universal name and initiates the dialog event loop. The dialog event loop is specified in a procedure subroutine that is passed as a parameter to the function.

説明

指定したダイアログをユニバーサルな名前で表示し、ダイアログイベントループを実行します。ダイアログイベントループはこの関数に渡すパラメーターのサブルーチン関数で指定します。

Parameters:

dialogID The index of the dialog to be displayed 表示するダイアログのインデックス番号
callback The event loop subroutine for the dialog ダイアログのイベントループサブルーチン
univName The universal name of the dialog ダイアログのユニバーサルな名前

Result:

Returns a LONGINT value indicating the button pressed to exit the dialog.

返り値

ダイアログ終了時に押されたボタンの番号をLONGINT値で返します。

See Also:

RunLayoutDialog  



  RunNamedDialogN Dialogs - Modern 
Vectorworks 2018

VectorScript Declaration:

FUNCTION   RunNamedDialogN
(   dialogID :LONGINT;
    callback :PROCEDURE;
    univName :STRING;
    enableContextualHelp :BOOLEAN
) :LONGINT ;

Python:

def  vs.RunNamedDialogN(dialogID, callback, univName, enableContextualHelp):
   return LONGINT

Description:

Displays the specified dialog with universal name and initiates the dialog event loop. The dialog event loop is specified in a procedure subroutine that is passed as a parameter to the function.

説明

指定したダイアログをユニバーサルな名前で表示し、ダイアログイベントループを実行します。ダイアログイベントループはこの関数に渡すパラメーターのサブルーチン関数で指定します。

Parameters:

dialogID The index of the dialog to be displayed 表示するダイアログのインデックス番号
callback The event loop subroutine for the dialog ダイアログのイベントループサブルーチン
univName The universal name of the dialog ダイアログのユニバーサルな名前
enableContextualHelp Determines whether or not contextual help is accessible ヘルプへのアクセスボタンを表示する/しない

Result:

Returns a LONGINT value indicating the button pressed to exit the dialog.

返り値

ダイアログ終了時に押されたボタンの番号をLONGINT値で返します。

See Also:

RunLayoutDialogN  



  SelectChoice Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   SelectChoice
(   dialogID :LONGINT;
    componentID :LONGINT;
    itemIndex :INTEGER;
    selectState :BOOLEAN
) ;

Python:

def  vs.SelectChoice(dialogID, componentID, itemIndex, selectState):
   return None

Description:

Set the selection state of the given item in a control of choices.

説明

プルダウンメニューやリストアイテムにある項目の選択状態を設定します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier for the component that contains the choices. アイテム番号
itemIndex The index of the item to set the selection state for. 項目番号
selectState True if the item at the given index should be selected. False otherwise. 選択状態(TRUE:選択する/FALSE:選択しない)



  SelectClassChoice Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   SelectClassChoice
(   dialogID :LONGINT;
    componentID :LONGINT;
    select :BOOLEAN
) ;

Python:

def  vs.SelectClassChoice(dialogID, componentID, select):
   return None

Description:

Use to select the class option in a popup that ShowByClassChoice has been called on. This function must be called with FALSE param if the popup currently has the class selection and the script wishes to change to a non-class selection.

説明

ShowByClassChoice を呼び出している際の、ポップアップのクラスオプションの選択状態を設定します。

Parameters:

dialogID Id of the dialog ダイアログ番号
componentID Id of the popup control ポップアップのアイテム番号
select TRUE if setting by class or FALSE if programmatically restoring the value to a non-class setting after class setting was applied TRUE : クラス属性を使用します。FALSE : クラス属性を使用しないに戻す。



  SelectEditText Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   SelectEditText
(   dialogID :LONGINT;
    componentID :LONGINT
) ;

Python:

def  vs.SelectEditText(dialogID, componentID):
   return None

Description:

Activates the given text component and selects its text.

説明

テキストフィールドを選択状態にします。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier of the component that is to be activated and selected. アイテム番号



  SelectTreeControlItem Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   SelectTreeControlItem
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nItemID :INTEGER
) ;

Python:

def  vs.SelectTreeControlItem(nDialogID, nComponentID, nItemID):
   return None

Description:

Selects the specified tree control item.

説明

指定したツリーアイテムの項目を選択します。



  SetBelowItem Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetBelowItem
(   dialogID :LONGINT;
    srcItemID :LONGINT;
    belowtItemID :LONGINT;
    indent :INTEGER;
    lineSpacing :INTEGER
) ;

Python:

def  vs.SetBelowItem(dialogID, srcItemID, belowtItemID, indent, lineSpacing):
   return None

Description:

Places the specified control item below a previously inserted control item. Additional positioning can be performed by specifying x- and y-offsets (in pixels) from the initial insert position. Indent is in number of characters. LineSpacing is in pixels.

説明

基準とするアイテムの下に、アイテムを配置します。挿入点からX軸、Y軸方向のオフセットを設定できます。

Parameters:

dialogID The index of the dialog layout being defined. ダイアログ番号
srcItemID The index of the anchor control item. 基準となるアイテム番号
belowtItemID The index of the control item being placed. 配置するアイテム番号
indent Left-right (x) control offset value. インデント
lineSpacing Up-down (y) control offset value. 行間



  SetBooleanItem Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   SetBooleanItem
(   dialogID :LONGINT;
    componentID :LONGINT;
    setState :BOOLEAN
) ;

Python:

def  vs.SetBooleanItem(dialogID, componentID, setState):
   return None

Description:

Selects or deselects the specified check box or radio button.

説明

チェックボックスまたはラジオボタンの選択状態を設定します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier for the radio or checkbox button component. アイテム番号
setState The selection state to set for the given component. 設定する選択状態



  SetColorButton Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   SetColorButton
(   dialogID :LONGINT;
    itemID :LONGINT;
    red :LONGINT;
    green :LONGINT;
    blue :LONGINT
) ;

Python:

def  vs.SetColorButton(dialogID, itemID, red, green, blue):
   return None

Description:

Sets the color of a modern dialog color button. Set all colors to 0 for black. Set all colors to 65535 for white.

説明

カラーボタンの色を設定します。黒ならばすべての色の成分を0、白ならばすべての色の成分を65535にします。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the color button. アイテム番号
red The red component of the color. 色の赤成分
green The green component of the color. 色の緑成分
blue The blue component of the color. 色の青成分

Example:

PROCEDURE SetColorControl(dialogID, controlID :LONGINT; colorIndex :STRING);
VAR
	r, g, b :LONGINT;
BEGIN
	IF colorIndex <> '' THEN BEGIN
		ColorIndexToRGB(Str2Num(colorIndex), r, g, b);
		SetColorButton(dialogID, controlID, r, g, b);
	END;
END;

See Also:

GetColorButton  



  SetColorChoice Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetColorChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
    colorIndex :INTEGER
) ;

Python:

def  vs.SetColorChoice(dialogID, itemID, colorIndex):
   return None

Description:

Sets the choice for the color popup dialog control to the specified color index.

説明

色ポップアップの色を設定します。

Example:

PROCEDURE Example;
VAR
   dialog1 :INTEGER;
   result  :INTEGER;
PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
   CASE item OF
      SetupDialogC:
         BEGIN
            SetColorChoice(dialog1, 4, 1242);
         END;
      1:
         BEGIN
            GetColorChoice(dialog1, 4, result);
            AlrtDialog(Concat('color index: ', result));
         END;
   END;
END;
BEGIN
   dialog1 := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
   CreateColorPopup(dialog1, 4, 24);
   SetFirstLayoutItem(dialog1, 4);
   result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);



  SetComponentIndeterminate Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   SetComponentIndeterminate
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    bIndeterminateState :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.SetComponentIndeterminate(nDialogID, nComponentID, bIndeterminateState):
   return BOOLEAN

Description:

Determines if the specified Layout Manager attribute control (line, weight, color, etc) should be set to the third, indeterminate state.

説明

指定された属性(線種、太さ、色など)を、3番目の未定の状態に設定します。



  SetComponentSize Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   SetComponentSize
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nWidthPixels :INTEGER;
    nHeightPixels :INTEGER
) :BOOLEAN ;

Python:

def  vs.SetComponentSize(nDialogID, nComponentID, nWidthPixels, nHeightPixels):
   return BOOLEAN

Description:

Sets the width and height of the specified Layout Manager component.

説明

指定したレイアウトダイアログのコンポーネントの幅と高さを設定します。



  SetControlData Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetControlData
(   dialogID :LONGINT;
    itemID :LONGINT;
    data :LONGINT
) ;

Python:

def  vs.SetControlData(dialogID, itemID, data):
   return None

Description:

Sets the data for the specified extended control item.

In image controls, for example, this call can be used to set the ID of the image resource being displayed.

This function can only be called from within the dialog event handler subroutine.

説明

指定したアイテムのデータを設定します。

この手続きはダイアログのイベントハンドラサブルーチンでのみ使用できます。

Parameters:

dialogID The index of the dialog containing the control. ダイアログ番号
itemID The index of the dialog control item. アイテム番号
data New data for the control item. アイテムのデータ



  SetControlText Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   SetControlText
(   DlogID :INTEGER;
    ItemID :INTEGER;
    newtext :STRING
) ;

Python:

def  vs.SetControlText(DlogID, ItemID, newtext):
   return None

Description:

Sets the text of radio button, check box, push button controls.

説明

ラジオボタン、チェックボックス、ボタンに表示する文字列を設定します。

Parameters:

DlogID ID of the dialog ダイアログ番号
ItemID ID of the control アイテム番号
newtext Text to insert 文字列



  SetEdgeBinding Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetEdgeBinding
(   dialogID :LONGINT;
    itemID :LONGINT;
    boundToLeft :BOOLEAN;
    boundToRight :BOOLEAN;
    boundToTop :BOOLEAN;
    boundToBottom :BOOLEAN
) ;

Python:

def  vs.SetEdgeBinding(dialogID, itemID, boundToLeft, boundToRight, boundToTop, boundToBottom):
   return None

Description:

Binds edges of a dialog control to its parent. This function sets bindings to be fixed. To change any of them to be proportional, use SetProportionalBinding.

説明

レイアウトダイアログに対してコントロールの縁を固定(TRUE)します。

See Also:

CreateResizableLayout   SetProportionalBinding  



  SetEditColorTextStyl Dialogs - Modern 
Vectorworks 2022

VectorScript Declaration:

FUNCTION   SetEditColorTextStyl
(   dialogID :LONGINT;
    itemID :LONGINT;
    strStyle :DYNARRAY[] of CHAR;
  VAR  outValue :DYNARRAY[] of CHAR;
  VAR  outParam2 :DYNARRAY[] of CHAR
) :BOOLEAN ;

Python:

def  vs.SetEditColorTextStyl(dialogID, itemID, strStyle):
   return (BOOLEAN, outValue, outParam2)

Description:

Set styles for the control, providing or requesting data. More info of the choices can be found in the developer.vectorworks.net

説明

コントロール、提供または要求するデータにスタイルを設定します。詳細についてはdeveloper.vectorworks.netをご参照ください。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index that will identify the control item. アイテム番号
strStyle The parameter configures the control by key-value pairs configuring the control. It can point to a file full path containing configuration for reusability このパラメーターは、コントロールを構成するキーと値のペアによってコントロールを構成します。 再利用性の構成を含むファイルのフルパスを指すことができます。
outValue Some set style commands produce value. The value will be packed up in a string which the user must take care as needed. 一部のsetstyleコマンドは値を生成します。 値は文字列にパックされ、ユーザーは必要に応じて注意する必要があります。
outParam2 Some style commands return parameter, The value will be packed up in a string which the user must take care as needed. 一部のスタイルコマンドはパラメータを返します。値は文字列にパックされ、ユーザーは必要に応じて注意する必要があります。



  SetEditInteger Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetEditInteger
(   dialogID :LONGINT;
    itemID :LONGINT;
    value :LONGINT
) ;

Python:

def  vs.SetEditInteger(dialogID, itemID, value):
   return None

Description:

Sets the numeric value of the specified INTEGER numeric edit field control.

説明

整数型の編集フィールドに整数値を設定します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the control item. 整数型の編集フィールドアイテム番号
value The new value for the field. 整数値



  SetEditReal Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetEditReal
(   dialogID :LONGINT;
    itemID :LONGINT;
    editRealType :LONGINT;
    value :REAL
) ;

Python:

def  vs.SetEditReal(dialogID, itemID, editRealType, value):
   return None

Description:

Sets the numeric value of the specified REAL numeric edit field control.

Table - Field Types for EditReal Fields

Index
Field Value
1
REAL value
2
Angular value
3
Dimension
4
X coordinate
5
Y coordinate

説明

実数型の編集フィールドに実数値を設定します。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the control item. 実数型の編集フィールドアイテム番号
editRealType The type of REAL value displayed in the field. 数値タイプ
value The new value for the field. 実数値



  SetFirstGroupItem Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetFirstGroupItem
(   dialogID :LONGINT;
    groupID :LONGINT;
    firstItemID :LONGINT
) ;

Python:

def  vs.SetFirstGroupItem(dialogID, groupID, firstItemID):
   return None

Description:

Places the first item of a layout group into the specified group box control item. The control is inserted in the top left corner of the group box, and all other controls in the group are placed relative to this item.

説明

グループボックス内の最初のアイテムを設定します。

Parameters:

dialogID The index of the dialog layout being defined. ダイアログ番号
groupID The index of the group box control accepting the first item. グループボックス番号
firstItemID The index of the control item to be placed in the group box. アイテム番号

Example:

SetFirstLayoutItem(lEditID,4);

{inserts the first control in a group box}
SetFirstGroupItem(lEditID,4,5);
	
SetBelowItem(lEditID,4,6,0,0);
SetFirstGroupItem(lEditID,6,7);
SetBelowItem(lEditID,6,8,0,0);



  SetFirstLayoutItem Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetFirstLayoutItem
(   dialogID :LONGINT;
    firstItemID :LONGINT
) ;

Python:

def  vs.SetFirstLayoutItem(dialogID, firstItemID):
   return None

Description:

Initializes dialog control layout by placing the specified control item in the top left corner of the layout. All other controls in the layout are positioned relative to the control item placed with this function.

説明

レイアウト内の最初のアイテムを設定します。

Parameters:

dialogID The index of the dialog layout being defined. ダイアログ番号
firstItemID The index of the control item to be placed. アイテム番号

Example:

{positions the first control in the dialog}
SetFirstLayoutItem(lEditID,4);

SetFirstGroupItem(lEditID,4,5);	
SetBelowItem(lEditID,4,6,0,0);
SetFirstGroupItem(lEditID,6,7);
SetBelowItem(lEditID,6,8,0,0);



  SetFocusOnItem Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   SetFocusOnItem
(   liDialogID :LONGINT;
    liComponentID :LONGINT
) ;

Python:

def  vs.SetFocusOnItem(liDialogID, liComponentID):
   return None

Description:

Sets the keyboard input focus on the specified item.

説明

指定したアイテムにキーボードからの入力フォーカスを設定します。



  SetGradientSlider Dialogs - Modern 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   SetGradientSlider
(   dialogID :LONGINT;
    componentID :LONGINT;
  VAR  segmentIndex :INTEGER;
    spotPosition :REAL;
    midpointPosition :REAL;
    red :LONGINT;
    green :LONGINT;
    blue :LONGINT;
    opacity :INTEGER
) ;

Python:

def  vs.SetGradientSlider(dialogID, componentID, segmentIndex, spotPosition, midpointPosition, red, green, blue, opacity):
   return segmentIndex

Description:

Note: you must use a variable, initialized to the segment index, to pass as a parameter. After the data has been set, this variable will contain the index of the segment, which may have changed because of the spot position specified.

説明

グラデーションスライダーの変化位置の変化点の位置、変化の中心点の位置や色、不透明度を設定します。

注:変化位置の番号には初期化した変数を使わなければなりません。変化点の位置が変更されデータが設定された後は、変数に変化位置の番号を返します。

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号
segmentIndex Segment for which to set the data. 変化位置番号(最も左を1とする)
spotPosition Position of the segment's color marker relative to left-most point of the slider. 変化点の位置(0.0以上1.0以下)
midpointPosition Position of the segment's midpoint marker relative to color marker immediately to left. 変化の中心点の位置(0.0以上1.0以下)
red Red component of the color spot's color. 変化点の色の赤成分(0以上255以下)
green Green component of the color spot's color. 変化点の色の緑成分(0以上255以下)
blue Blue component of the color spot's color. 変化点の色の青成分(0以上255以下)
opacity Opacity for the color at the spot position. 変化点の不透明度

Example:

segmentIndex := 4;
SetGradientSlider(dialogID, componentID, segmentIndex, 0.9, 0.5, 255, 255, 255,100);

See Also:

GetGradientSlider   InsertGradientSliSeg  



  SetGradientSliderData Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   SetGradientSliderData
(   dialogID :LONGINT;
    componentID :LONGINT;
  VAR  segmentIndex :INTEGER;
    spotPosition :REAL;
    midpointPosition :REAL;
    red :LONGINT;
    green :LONGINT;
    blue :LONGINT
) ;

Python:

def  vs.SetGradientSliderData(dialogID, componentID, segmentIndex, spotPosition, midpointPosition, red, green, blue):
   return segmentIndex

Description:

Sets the spot position, midpoint position and color of the specified gradient slider segment.

Note: you must use a variable, initialized to the segment index, to pass as a parameter. After the data has been set, this variable will contain the index of the segment, which may have changed because of the spot position specified.

説明

グラデーションスライダーの変化位置の変化点の位置、変化の中心点の位置や色を設定します。

注:変化位置の番号には初期化した変数を使わなければなりません。変化点の位置が変更されデータが設定された後は、変数に変化位置の番号を返します。

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号
segmentIndex Segment for which to set the data. (segment indexes begin with 1) 変化位置番号(最も左を1とする)
spotPosition Position of the segment's color marker relative to left-most point of the slider. (position >= 0.0 and position <= 1.0) 変化点の位置(0.0以上1.0以下)
midpointPosition Position of the segment's midpoint marker relative to color marker immediately to left. (position >= 0.0 and position <= 1.0) 変化の中心点の位置(0.0以上1.0以下)
red Red component of the color spot's color. (red >= 0 and red <= 255) 変化点の色の赤成分(0以上255以下)
green Green component of the color spot's color. (green >= 0 and green <= 255) 変化点の色の緑成分(0以上255以下)
blue Blue component of the color spot's color. (blue >= 0 and blue <= 255) 変化点の色の青成分(0以上255以下)

Example:

segmentIndex := 4;
SetGradientSliderData(dialogID, componentID, segmentIndex, 0.9, 0.5, 255, 255, 255);



  SetGradientSliderSelectedMarker Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   SetGradientSliderSelectedMarker
(   dialogID :LONGINT;
    componentID :LONGINT;
    segmentIndex :INTEGER;
    markerType :INTEGER
) ;

Python:

def  vs.SetGradientSliderSelectedMarker(dialogID, componentID, segmentIndex, markerType):
   return None

Description:

Sets the selected marker for the specified gradient slider.

Note: use the number, 1, to specify a color marker and the number, 2, to specify a midpoint marker.

説明

グラデーションスライダーの点を選択します。

注:変化点は1、変化の中心点は2を使います。

Parameters:

dialogID Index to the dialog layout that contains the gradient slider component. ダイアログ番号
componentID Index to a specific gradient slider component. グラデーションスライダーアイテム番号
segmentIndex Index to segment in which to select marker. (segment indexes begin with 1) 変化位置番号(最も左を1とする)
markerType Type of marker to select. (1 = color marker, 2 = midpoint marker) 点の種類(1:変化点/2:変化の中心点)

Example:

SetGradientSliderSelectedMarker(dialogID, componentID, 4, 2);
{ selects midpoint marker in segment with index of 4 }



  SetHelpText Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   SetHelpText
(   dialogID :LONGINT;
    componentID :LONGINT;
    helpText :DYNARRAY[] of CHAR
) ;

Python:

def  vs.SetHelpText(dialogID, componentID, helpText):
   return None

Description:

Sets the help text for the given component.

説明

ヘルプフィールドに表示する文字列を設定します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier of the component for which to set the help text. アイテム番号
helpText The help text to set for the given component. ヘルプフィールドに表示する文字列を設定します。



  SetIconPushButtonState Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   SetIconPushButtonState
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    bPressed :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.SetIconPushButtonState(nDialogID, nComponentID, bPressed):
   return BOOLEAN

Description:

Retrieves the state of the specified Layout Manager icon push button (pressed or not pressed).

説明

指定したアイコンプッシュボタンの状態(押された、押されていないなど)を設定します。



  SetImageControlHandle Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetImageControlHandle
(   dialogID :LONGINT;
    componentID :LONGINT;
    hImage :HANDLE
) ;

Python:

def  vs.SetImageControlHandle(dialogID, componentID, hImage):
   return None

Description:

Sets the image definition node handle for the specified Layout Manager image control.

説明

指定したイメージのイメージ定義ノードハンドルを設定します。



  SetImageControlPath Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

FUNCTION   SetImageControlPath
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    strPath :STRING
) :BOOLEAN ;

Python:

def  vs.SetImageControlPath(nDialogID, nComponentID, strPath):
   return BOOLEAN

Description:

Sets the image control path for the specified layout manager image control. Use with CreateImageControl.

説明

指定したイメージのイメージパスを設定します。CreateImageControlと共に使用します。



  SetImagePopupSelectedItem Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

PROCEDURE   SetImagePopupSelectedItem
(   dialogID :LONGINT;
    componentID :LONGINT;
    itemIndex :INTEGER
) ;

Python:

def  vs.SetImagePopupSelectedItem(dialogID, componentID, itemIndex):
   return None

Description:

Sets the selected image popup item. The itemIndex parameter is 1-based.

説明

イメージポップアップメニューを設定します。

Parameters:

dialogID Index to the dialog layout that contains the image popup component. ダイアログ番号
componentID Index to a specific image popup component. イメージポップアップメニューアイテム番号
itemIndex Index to item to select. メニュー項目番号

Example:

SetImagePopupSelectedItem(dialogID, componentID, 4);

See Also:

InsertImagePopupObjectItem   GetNumImagePopupItems   GetImagePopupObject   GetImagePopupObjectItemIndex   GetImagePopupSelectedItem   RemoveImagePopupItem   RemoveAllImagePopupItems  



  SetItemClickable Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   SetItemClickable
(   dialogID :LONGINT;
    componentID :LONGINT;
    clickable :BOOLEAN
) ;

Python:

def  vs.SetItemClickable(dialogID, componentID, clickable):
   return None

Description:

Sets the specified item to generate events when clicked. Currently only static text and images are supported.

説明

指定されたコントロールがクリックイベントを受け取れるようにします。現在は静的文字列と画像が対応している。



  SetItemText Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   SetItemText
(   dialogID :LONGINT;
    componentID :LONGINT;
    text :DYNARRAY[] of CHAR
) ;

Python:

def  vs.SetItemText(dialogID, componentID, text):
   return None

Description:

Sets the text for the specified text component.

説明

テキストフィールドに表示する文字列を設定します。

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout ダイアログ番号
componentID The identifier of the text component. アイテム番号
text The text that should be placed in the text component. 表示する文字列



  SetItemToolTipText Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   SetItemToolTipText
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    strToolTip :STRING;
    strSubToolTip :STRING;
    nIndex :INTEGER;
    nSubIndex :INTEGER
) ;

Python:

def  vs.SetItemToolTipText(nDialogID, nComponentID, strToolTip, strSubToolTip, nIndex, nSubIndex):
   return None

Description:

Sets the tooltip text for list browsers, list boxes, edit controls, pull down menus, and enhanced static text. Parameters nIndex and nSubIndex are used for list browsers and list boxes only.

説明

リストブラウザ、編集フィールド、プルダウンメニューの、ツールチップとして表示される文字列を設定します。nIndexとnSubIndexはリストブラウザのみで使用されます。



  SetLayoutDialogPosition Dialogs - Modern 
VectorWorks11.0

VectorScript Declaration:

FUNCTION   SetLayoutDialogPosition
(   dialogID :LONGINT;
    left :INTEGER;
    top :INTEGER
) :BOOLEAN ;

Python:

def  vs.SetLayoutDialogPosition(dialogID, left, top):
   return BOOLEAN

Description:

This function moves the dialog window to the given location. Call this function to override the default automatic positioning of the dialog window. The dialog will be pinned so that it is at least partly onscreen.

This function can be useful for displaying a dialog in a position in which it was placed during prior use.

説明

指定した位置にダイアログウインドウを移動します。

Parameters:

dialogID Index of the dialog. ダイアログ番号
left Location of left edge of dialog in pixels. 左(ピクセル)
top Location of top edge of dialog in pixels. 上(ピクセル)

Result:

true - success - the dialog window was moved.
false - failure - the dialog window was not moved, likely because it does not currently exist, or the dialogID is invalid. The dialog window will exist anytime between the Setup message and OK/Cancel message.

返り値

TRUE:ダイアログウインドウの移動に成功しました。
FALSE:ダイアログウインドウの移動に失敗しました。既に存在しているか、ダイアログ番号が無効です。ダイアログウインドウはSetupメッセージからOK/Cancelメッセージの間は常に存在しています。

See Also:

GetLayoutDialogPosition  



  SetLayoutDialogSize Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetLayoutDialogSize
(   dialogID :LONGINT;
    width :INTEGER;
    height :INTEGER
) ;

Python:

def  vs.SetLayoutDialogSize(dialogID, width, height):
   return None

Description:

Sets a Layout Manager dialog's size, in pixels.

説明

レイアウトダイアログをピクセル単位で設定します。



  SetLayoutOption Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   SetLayoutOption
(   dialogID :LONGINT;
    option :INTEGER;
    value :LONGINT
) :BOOLEAN ;

Python:

def  vs.SetLayoutOption(dialogID, option, value):
   return BOOLEAN

Description:

Set options for a specific Layout Manager dialog. For use by certain alert dialogs that want centered "OK" button.

説明

レイアウトダイアログのオプションを設定します。



  SetLBImageIndexes Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   SetLBImageIndexes
(   dialogID :LONGINT;
    controlID :LONGINT;
    itemIndex :INTEGER;
    subItemIndex :INTEGER;
    imageSpecifier0 :DYNARRAY[] of CHAR;
    imageSpecifier1 :DYNARRAY[] of CHAR;
    imageSpecifier2 :DYNARRAY[] of CHAR
) :BOOLEAN ;

Python:

def  vs.SetLBImageIndexes(dialogID, controlID, itemIndex, subItemIndex, imageSpecifier0, imageSpecifier1, imageSpecifier2):
   return BOOLEAN

Description:

Sets the images for the list browser row, Replaces SetLBMultImageIndexes

説明

リストブラウザの行にイメージを設定します。SetLBMultImageIndexesの代わりに使用してください。

Parameters:

dialogID The dialog identifier given by the command to create the dialog. ダイアログ番号
controlID The identifier of the control to be updated. アイテム番号
imageSpecifier0 The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)
imageSpecifier1 The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)
imageSpecifier2 The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)



  SetLineAttributeData Dialogs - Modern 
VectorWorks12.0 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetLineAttributeData
(   dialogID :LONGINT;
    itemID :LONGINT;
    lineStyle :INTEGER;
    lineWeight :INTEGER
) ;

Python:

def  vs.SetLineAttributeData(dialogID, itemID, lineStyle, lineWeight):
   return None

Special Notes:

SetLineAttributeData is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use SetLineTypeAttriData instead.

説明

線種と線の太さポップアップを設定します。線種と線の太さの両方を指定できます。

See Also:

SetLineTypeAttriData  



  SetLineStyleChoice Dialogs - Modern 
VectorWorks12.0 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetLineStyleChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
    lineStyle :INTEGER
) ;

Python:

def  vs.SetLineStyleChoice(dialogID, itemID, lineStyle):
   return None

Special Notes:

SetLineStyleChoice is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use SetLineTypeChoice instead.

説明

線種ポップアップを設定します。

See Also:

SetLineTypeChoice  



  SetLineTypeAttriData Dialogs - Modern 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   SetLineTypeAttriData
(   dialogID :LONGINT;
    itemID :LONGINT;
    lineType :LONGINT;
    lineWeight :INTEGER
) ;

Python:

def  vs.SetLineTypeAttriData(dialogID, itemID, lineType, lineWeight):
   return None

Description:

Set current choices for the line attribute dialog control. Both the line type and the line weight in mils can be specified.

説明

線種と線の太さポップアップを設定します。ラインタイプと線の太さの両方を指定できます。

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the line attribute control. アイテム番号
lineType The internal index (reference number) of the line type. ラインタイプのインデックス
lineWeight The line weight.The value is in mils. 線の太さ



  SetLineTypeChoice Dialogs - Modern 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   SetLineTypeChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
    lineType :LONGINT
) ;

Python:

def  vs.SetLineTypeChoice(dialogID, itemID, lineType):
   return None

Description:

Set the current choice of the line style popup dialog control to the specified line type.

説明

線種ポップアップで選択中の項目に指定したラインタイプを設定します

Parameters:

dialogID The index of the dialog layout containing the control. ダイアログ番号
itemID The index of the line style control. 線種ポップアップのアイテム番号
lineType The internal index (reference number) of the line type. ライタイプのインデックス



  SetLineWeightChoice Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetLineWeightChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
    lineWeight :INTEGER
) ;

Python:

def  vs.SetLineWeightChoice(dialogID, itemID, lineWeight):
   return None

Description:

Set the current choice of the line weight dialog control to the value specified in mils.

説明

線の太さポップアップを設定します。



  SetListBoxTabStops Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   SetListBoxTabStops
(   dialogID :LONGINT;
    componentID :LONGINT;
    tabStops :ARRAY
) ;

Python:

def  vs.SetListBoxTabStops(dialogID, componentID, tabStops):
   return None

Description:

Set tab stops for list control.

説明

リストコントロールにタブストップを設定します。



  SetMarkerChoice Dialogs - Modern 
VectorWorks12.0 - obsolete as of VectorWorks 2008

VectorScript Declaration:

PROCEDURE   SetMarkerChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
    index :INTEGER;
    style :INTEGER;
    angle :INTEGER;
    size :REAL
) ;

Python:

def  vs.SetMarkerChoice(dialogID, itemID, index, style, angle, size):
   return None

Special Notes:

SetMarkerChoice is obsolete as of VectorWorks 2008

Description:

OBSOLETE procedure for VW2008

Set current choice for Marker popup dialog control. Index is the standing position of marker; it is -1 for customized, otherwise 1-based index.
Style is the chosen shape of arrow head . Style is zero-based. The angle parameter must be in range 0 to 90 degrees, depending on the style. Size is per Inches. Style, angle and size may be changed by user in VW preferences.
Further, the function can find a specific Index , given the right Style, Angle & Size. In such case index should be set to -1. If the given properties correspond to one of indecies, then -1 is replaced with that specific index.
When using pre-defined arrow heads, style & angle & size may be passed zero and just fill in the proper index to set the current.

説明

マーカポップアップを設定します。角度パラメータは、0から90度の範囲でなければなりません。

VW2008で使用できなくなった関数/手続きです。
SetMarkerValueをご利用ください。

Example:

PROCEDURE dialog1_Main;
VAR
	int, dialog1   :INTEGER;
	index, style, angle, size :INTEGER;

PROCEDURE dialog1_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
	CASE item OF
		SetupDialogC:
			BEGIN
				index := 1;
				style := 2;
				angle := 3;
				size  := 4;
				SetMarkerChoice(dialog1, 4, index, style, angle, size);
			END;
		5: 
			BEGIN
				GetMarkerChoice(dialog1, 4, index, style, angle, size);
				AlrtDialog(Concat('index: ', index, Chr(13), 'style: ', style, Chr(13), 'angle: ', angle, Chr(13), 'size: ', size));
			END;
	END;
END;

BEGIN
	dialog1 := CreateLayout('Test', False, 'OK', '');
	CreateMarkerPopup(dialog1, 4);
	CreatePushButton(dialog1, 5, '  Display Values  ');
	SetFirstLayoutItem(dialog1, 4);
	SetBelowItem(dialog1, 4, 5, 0, 2);
	int := RunLayoutDialog(dialog1, dialog1_Handler);
END;
RUN(dialog1_Main);

See Also:

GetMarkerChoice  



  SetMarkerValue Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   SetMarkerValue
(   dialogID :LONGINT;
    itemID :LONGINT;
    style :INTEGER;
    angle :INTEGER;
    length :REAL;
    width :REAL;
    basis :INTEGER;
    thickness :REAL
) ;

Python:

def  vs.SetMarkerValue(dialogID, itemID, style, angle, length, width, basis, thickness):
   return None

Description:

Sets MarkerPopup value in dialog (replaces MarkerPopup procedures prior to VW2008).

説明

マーカポップアップの値を設定します。(VW2008より前のバージョンのマーカポップアップ手続きの代わりになります。)

Parameters:

dialogID ID of the dialog ダイアログ番号
itemID ID of the marker popup control マーカポップアップ番号
style Marker Style タイプ
angle Marker Angle 角度
length Marker Length (In Inches) 長さ(インチ)
width Marker Width (In Inches) 幅(インチ)
basis Marker Thickness Basis 太さ
thickness Marker Thickness カスタム設定の太さ

Example:

PROCEDURE Example;
VAR
   int, dialogID   :INTEGER;
   style, angle, thicknessBasis :INTEGER;
   width, length, thickness :REAL;

PROCEDURE Dialog_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
   CASE item OF
      SetupDialogC:
         BEGIN
            style := 130;
            angle := 0;
            width  := .125;
		length := .125;
		thickness := 0;
		thicknessBasis := 0;
            SetMarkerValue(dialogID, 4, style, angle, width, length, thicknessBasis, thickness);
         END;
      5: 
         BEGIN
           GetMarkerValue(dialogID, 4, style, angle, width, length, thicknessBasis, thickness);

            AlrtDialog(Concat(
               'style: ', style, Chr(13), 
               'angle: ', angle, Chr(13), 
		 'width: ', width,Chr(13),
               'length: ', length, Chr(13),
		  'thickness: ', thickness, Chr(13),
		  'thicknessBasis: ', thicknessBasis));

         END;
   END;
END;

BEGIN
   dialogID := CreateLayout('Test', False, 'OK', '');
   CreateMarkerPopup(dialogID, 4);
   CreatePushButton(dialogID, 5, '  Display Values  ');
   SetFirstLayoutItem(dialogID, 4);
   SetBelowItem(dialogID, 4, 5, 0, 2);
   int := RunLayoutDialog(dialogID, Dialog_Handler);
END;
RUN(Example);

See Also:

GetMarkerValue  



  SetPatternData Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetPatternData
(   dialogID :LONGINT;
    itemID :LONGINT;
    patternIndex :INTEGER;
    foreColor :INTEGER;
    backColor :INTEGER
) ;

Python:

def  vs.SetPatternData(dialogID, itemID, patternIndex, foreColor, backColor):
   return None

Description:

Set current choice and colors for the pattern popup dialog control.

説明

模様ポップアップを設定します。



  SetProportionalBinding Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetProportionalBinding
(   dialogID :LONGINT;
    itemID :LONGINT;
    leftProportional :BOOLEAN;
    rightProportional :BOOLEAN;
    topProportional :BOOLEAN;
    bottomProportional :BOOLEAN
) ;

Python:

def  vs.SetProportionalBinding(dialogID, itemID, leftProportional, rightProportional, topProportional, bottomProportional):
   return None

Description:

Sets a dialog control's bindings to be proportional. Proportional bindings maintain a distance that is a ratio of the initial position to the width (or height, as appropriate) of the parent. To change a control's bindings to be fixed, use SetEdgeBinding.

説明

レイアウトダイアログに対してコントロールの位置が比例距離を保つ設定をします。

See Also:

CreateResizableLayout   SetEdgeBinding  



  SetRightItem Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetRightItem
(   dialogID :LONGINT;
    srcItemID :LONGINT;
    rightItemID :LONGINT;
    indent :INTEGER;
    lineSpacing :INTEGER
) ;

Python:

def  vs.SetRightItem(dialogID, srcItemID, rightItemID, indent, lineSpacing):
   return None

Description:

Places the specified control item to the right of a previously inserted control item.
Additional positioning can be performed by specifying x- and y-offsets (in pixels) from the initial insert position.

説明

基準とするアイテムの右に、アイテムを配置します。挿入点からX軸、Y軸方向のオフセットを設定できます。

Parameters:

dialogID The index of the dialog layout being defined. ダイアログ番号
srcItemID The index of the anchor control item. 基準となるアイテム番号
rightItemID The index of the control item being placed. 配置するアイテム番号
indent Left-right (x) control offset value. インデント
lineSpacing Up-down (y) control offset value. 行間



  SetSelectionRange Dialogs - Modern 
VectorWorks12.0.1

VectorScript Declaration:

PROCEDURE   SetSelectionRange
(   dialogID :LONGINT;
    controlID :LONGINT;
    startPos :INTEGER;
    endPos :INTEGER
) ;

Python:

def  vs.SetSelectionRange(dialogID, controlID, startPos, endPos):
   return None

Description:

Sets the range of the current selection for the specified control.

説明

指定したコントロール内の選択範囲の始点と終点を設定します。



  SetSliderLiveUpdate Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   SetSliderLiveUpdate
(   dialogID :LONGINT;
    componentID :LONGINT;
    liveUpdate :BOOLEAN
) ;

Python:

def  vs.SetSliderLiveUpdate(dialogID, componentID, liveUpdate):
   return None

Description:

Sets the specified slider to generate events during a drag.

説明

スライダーアイテムのイベントをライブアップデートにするかを設定します。



  SetStaticTextColor Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   SetStaticTextColor
(   dialogID :LONGINT;
    componentID :LONGINT;
    red :INTEGER;
    green :INTEGER;
    blue :INTEGER
) ;

Python:

def  vs.SetStaticTextColor(dialogID, componentID, red, green, blue):
   return None

Description:

Sets the color for the Layout Manager static Text

説明

編集不可能なフィールドに色を指定します。



  SetStaticTextColorN Dialogs - Modern 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   SetStaticTextColorN
(   dialogID :LONGINT;
    componentID :LONGINT;
    tint :INTEGER
) ;

Python:

def  vs.SetStaticTextColorN(dialogID, componentID, tint):
   return None

Parameters:

tint Tint number. See Appendix for the available values. 色合い番号。使用可能な値については付録(Appendix)を参照してください。



  SetStaticTextStyle Dialogs - Modern 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   SetStaticTextStyle
(   dialogID :LONGINT;
    componentID :LONGINT;
    style :INTEGER
) ;

Python:

def  vs.SetStaticTextStyle(dialogID, componentID, style):
   return None

Description:

Sets the style for the Layout Manager static Text

Plain 0
Bold 1
Italic 2
Underline 4

Can combine styles (bold + italic = 3)

説明

編集不可能なフィールドに文字スタイルを指定します。

なし 0
ボールド 1
イタリック 2
アンダーライン 4

スタイルの組み合わせ可能 (ボールド + イタリック = 3)



  SetThreeStateCheckBoxState Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   SetThreeStateCheckBoxState
(   dialogID :LONGINT;
    componentID :LONGINT;
    iState :INTEGER
) ;

Python:

def  vs.SetThreeStateCheckBoxState(dialogID, componentID, iState):
   return None

Description:

Sets the state of a Layout Manager three state checkbox.

説明

3状態チェックボックスの状態を設定します。



  SetTreeControlItemData Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   SetTreeControlItemData
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nItemID :INTEGER;
    nUserData :LONGINT
) ;

Python:

def  vs.SetTreeControlItemData(nDialogID, nComponentID, nItemID, nUserData):
   return None

Description:

Sets the user data of the specified item from a tree control.

説明

指定したツリーアイテムのユーザデータを設定します。



  SetVSResourceFile Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   SetVSResourceFile
( fileName:DYNARRAY[] of CHAR ) :BOOLEAN ;

Python:

def  vs.SetVSResourceFile(fileName):
   return BOOLEAN

Description:

Sets the active resource file for a script. The resource file is opened for the duration of script execution.

The name of the resource file should be specified without the file extension.

説明

リソースファイルを開きます。ファイルの名前は、拡張子を含まない名前で指定します。

Parameters:

fileName The name of the resource file to be opened. ファイルの名前

Result:

A BOOLEAN value indicating the success of the file open operation.

返り値

ファイルが開けた場合はTRUEを返します。

See Also:

GetResourceString  



  ShowByClassChoice Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   ShowByClassChoice
(   dialogID :LONGINT;
    componentID :LONGINT
) ;

Python:

def  vs.ShowByClassChoice(dialogID, componentID):
   return None

Description:

Adds a 'By Class' choice to a marker, line style, or color popup control. (Dialog must be running)

説明

マーカー、線種、色のポップアップに「クラス属性」選択を追加します。

Parameters:

dialogID Id of the dialog ダイアログ番号
componentID Id of the popup control ポップアップのアイテム番号



  ShowEditTileDialog Dialogs - Modern 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   ShowEditTileDialog
( tileHandle:HANDLE ) ;

Python:

def  vs.ShowEditTileDialog(tileHandle):
   return None

Description:

Displays the edit tile dialog for the specified tile allowing the user to specify whether they wish to edit the tile's geometry or settings.

説明

タイル編集ダイアログを表示します。タイルの形状と設定のどちらを編集するか選択することができます。

Parameters:

tileHandle The tile for which the dialog should be displayed. 編集ダイアログを表示するタイル

Example:

ShowEditTileDialog(tileHandle);

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  



  ShowEditTileSettingsDialog Dialogs - Modern 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   ShowEditTileSettingsDialog
VAR tileHandle:HANDLE ) ;

Python:

def  vs.ShowEditTileSettingsDialog(tileHandle):
   return tileHandle

Description:

Displays the edit tile settings dialog for the specified tile.

説明

タイル設定編集ダイアログを表示します。

Parameters:

tileHandle The tile to display in dialog; passing a handle initialized to nil indicates that a new tile resource should be created and displayed in the dialog. 編集ダイアログを表示するタイル; ハンドルの値がnilの場合、新しいタイルリソースが作成されダイアログに表示されます。

Example:

ShowEditTileSettingsDialog(tileHandle);
{ displays the specified tile resource in the dialog }

tileHandle := nil;
ShowEditTileSettingsDialog(tileHandle);
{ creates a new tile resource and displays it in the dialog }

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  



  ShowEnhancedPullDownMenuGroupIcon Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   ShowEnhancedPullDownMenuGroupIcon
(   liDialogID :LONGINT;
    liComponentID :LONGINT;
    bShowGroupIcon :BOOLEAN
) ;

Python:

def  vs.ShowEnhancedPullDownMenuGroupIcon(liDialogID, liComponentID, bShowGroupIcon):
   return None

Description:

Determines if the group icon should be shown in the specified enhanced pull down menu.

説明

指定したグループボックスのプルダウンメニューにグループアイコンを表示する/しないを設定します。



  ShowItem Dialogs - Modern 
VectorWorks11.5

VectorScript Declaration:

PROCEDURE   ShowItem
(   dialogID :LONGINT;
    item :INTEGER;
    show :BOOLEAN
) ;

Python:

def  vs.ShowItem(dialogID, item, show):
   return None

Description:

Sets the visibility of the referenced dialog control.

説明

ダイアログアイテムの表示/非表示を設定します。

Parameters:

dialogID ID of the currently executing dialog. ダイアログ番号
item Item ID of dialog control to show or hide. アイテム番号
show New visibility state of dialog control. アイテム設定(TRUE:表示/FALSE:非表示 )

Example:

PROCEDURE dialogID_Main;
VAR
	dialogID :INTEGER;

PROCEDURE dialogID_Setup;
BEGIN
	dialogID := CreateLayout('Example Dialog', FALSE, 'OK', 'Cancel');
	CreateRadioButton (dialogID,  4,  'Option One');
	CreateEditReal    (dialogID,  5,  1, 0.0, 16);
	CreateRadioButton (dialogID,  6,  'Option Two');
	CreateEditReal    (dialogID,  7,  1, 0.0, 16);
	SetFirstLayoutItem(dialogID,  4);
	SetRightItem      (dialogID,  4,   5,  0, 0);
	SetBelowItem      (dialogID,  4,   6,  0, 0);
	SetRightItem      (dialogID,  6,   7,  0, 0);
END;

PROCEDURE dialogID_Handler(VAR item :LONGINT; data :LONGINT);
BEGIN
	CASE item OF
		SetupDialogC:
			BEGIN
				SetItem(4, TRUE);
				ShowItem(dialogID, 7, FALSE);
			END;
		 4:
			BEGIN
				ShowItem(dialogID, 5, TRUE);
				ShowItem(dialogID, 7, FALSE);
			END;
		 6:
			BEGIN
				ShowItem(dialogID, 7, TRUE);
				ShowItem(dialogID, 5, FALSE);
			END;
	END;
END;

BEGIN
	dialogID_Setup;
	IF RunLayoutDialog(dialogID, dialogID_Handler) = 1 then BEGIN
	END;
END;
RUN(dialogID_Main);



  ShowNewTileDialog Dialogs - Modern 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   ShowNewTileDialog
:HANDLE ;

Python:

def  vs.ShowNewTileDialog():
   return HANDLE

Description:

Displays the new tile dialog.

説明

新しいタイルダイアログを表示します。

Result:

Returns a handle to a new tile resource if successful, otherwise the function returns nil.

返り値

成功すると、新しいタイルリソースへのハンドルを返します。そのほかの場合は、nilを返します。

Example:

tileHandle := ShowNewTileDialog;

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  



  UpdateImageControl2 Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   UpdateImageControl2
(   dialogID :LONGINT;
    controlID :LONGINT;
    imageSpecifier :DYNARRAY[] of CHAR
) ;

Python:

def  vs.UpdateImageControl2(dialogID, controlID, imageSpecifier):
   return None

Description:

Updates the image control created with CreateImageControl2

説明

CreateImageControl2 で作成されたイメージコントロールを更新します。

Parameters:

dialogID The dialog identifier given by the command to create the dialog. ダイアログ番号
controlID The identifier of the control to be updated. アイテム番号
imageSpecifier The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)



  UpdateImageControl3 Dialogs - Modern 
Vectorworks 2018

VectorScript Declaration:

FUNCTION   UpdateImageControl3
(   dialogID :LONGINT;
    controlID :LONGINT;
    imageFullPath :DYNARRAY[] of CHAR
) :BOOLEAN ;

Python:

def  vs.UpdateImageControl3(dialogID, controlID, imageFullPath):
   return BOOLEAN

Description:

Updates the image control.

Returns false if the image cannot be found or set to the control, otherwise returns true.

This function directly looks for the image file with the input file path, while UpdateImageControl2() only looks into the Vectorworks resrouces folder.

説明

イメージコントロールを更新します。

イメージが見つからない場合とコントロールに指定できない場合はFALSEを返します。それ以外の場合にTRUEを返します。

この関数は指定したファイルパスにあるイメージを直接探します。UpdateImageControl2() では resrouces フォルダのみ探します。

Parameters:

dialogID The dialog identifier given by the command to create the dialog. ダイアログ番号
controlID The identifier of the control to be updated. アイテム番号
imageFullPath The full path to the image. イメージのフルパス

Result:

Returns false if the image cannot be found or set to the control, otherwise returns true.

返り値

イメージが見つからない場合とコントロールに指定できない場合はFALSEを返します。それ以外の場合にTRUEを返します。

See Also:

UpdateImageControl2  



  UpdateImagePushButton Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   UpdateImagePushButton
(   dialogID :LONGINT;
    controlID :LONGINT;
    imageSpecifier :DYNARRAY[] of CHAR
) ;

Python:

def  vs.UpdateImagePushButton(dialogID, controlID, imageSpecifier):
   return None

Description:

Updates the image button created with CreateImagePushButton.

説明

CreateImagePushButton で作成したイメージボタンを更新します。

Parameters:

dialogID The dialog identifier given by the command to create the dialog. ダイアログ番号
controlID The identifier of the control to be updated. アイテム番号
imageSpecifier The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile". イメージの識別文字( 拡張子なしのリソースファイル名 / イメージファイルパス の形で指定します)



  UpdateSymbolDisplayControl Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   UpdateSymbolDisplayControl
(   dialogID :LONGINT;
    itemID :LONGINT;
    symbolName :STRING;
    renderMode :INTEGER;
    view :INTEGER
) ;

Python:

def  vs.UpdateSymbolDisplayControl(dialogID, itemID, symbolName, renderMode, view):
   return None

Description:

Updates a pre-existing symbol display control in the dialog with a new symbol, rendering mode, or view. The dialog ID and item ID must refer to symbol display control created with CreateSymbolDisplayControl. To show a blank SymbolDisplay control, use an empty string as the symbolName parameter.

Table - Render Modes

Render Mode Constant
Wireframe 0
Unshaded Polygon 2
Shaded Polygon 3
Shaded Polygon No Lines 4
Final Shaded Polygon 5
Hidden Line 6
Dashed Hidden Line 7
OpenGL 11
Fast RenderWorks 12
Fast RenderWorks with Shadows 13
Final Quality RenderWorks 14
Custom RenderWorks 15
Artistic RenderWorks 17
Sketch 18


Table - Views

View Constant
Top/Plan 2
Front 3
Back 4
Left 5
Right 6
Top 7
Bottom 8
Right Isometric 9
Left Isometric 10
Right Rear Isometric 11
Left Rear Isometric 12
Bottom Right Isometric 13
Bottom Left Isometric 14
Bottom Right Rear Isometric 15
Bottom Left Rear Isometric 16

説明

シンボルを表示するコントロールを更新します。 空白のコントロールを表示するには、シンボル名を空にしてください。

Parameters:

dialogID The ID of the dialog in which to create the control. ダイアログ番号
itemID The item ID of the control. アイテム番号
symbolName The name of the symbol to display. シンボル名
renderMode The render mode in which to display the symbol. レンダリングモード
view The standard view in which to display the symbol. 視点

Example:

CreateSymbolDisplayControl( 5, 6, 'Chair', 350, 200, 5, 11, 9 );
{Other code}
UpdateSymbolDisplayControl( 5, 6, 'Chair', 0, 3 );

This creates a dialog control that displays the symbol called "Chair."  The control is 350 pixels high and 200 pixels wide, with a margin of 5 pixels.  The symbol is rendered in OpenGL mode and displayed in a right isometric view.  It then later updates the control to display the same symbol rendered in Wireframe in a front view.

See Also:

CreateSymbolDisplayControl  



  UpdateSymDispCtrlN Dialogs - Modern 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   UpdateSymDispCtrlN
(   dialogID :LONGINT;
    itemID :LONGINT;
    symbolName :STRING;
    view :INTEGER;
    renderMode :INTEGER;
    component :INTEGER;
    scaleByZoom :BOOLEAN
) ;

Python:

def  vs.UpdateSymDispCtrlN(dialogID, itemID, symbolName, view, renderMode, component, scaleByZoom):
   return None

Description:

Updates a pre-existing symbol display control in the dialog with a new symbol, rendering mode, view or image component. The dialog ID and item ID must refer to symbol display control created with CreateSymDispCtrlN. To show a blank SymbolDisplay control, use an empty string as the symbolName parameter.

Table - Render Modes

Render Mode Constant
Wireframe 0
Unshaded Polygon 2
Shaded Polygon 3
Shaded Polygon No Lines 4
Final Shaded Polygon 5
Hidden Line 6
Dashed Hidden Line 7
OpenGL 11
Fast RenderWorks 12
Fast RenderWorks with Shadows 13
Final Quality RenderWorks 14
Custom RenderWorks 15
Artistic RenderWorks 17
Sketch 18


Table - Views

View Constant
Top/Plan 2
Front 3
Back 4
Left 5
Right 6
Top 7
Bottom 8
Right Isometric 9
Left Isometric 10
Right Rear Isometric 11
Left Rear Isometric 12
Bottom Right Isometric 13
Bottom Left Isometric 14
Bottom Right Rear Isometric 15
Bottom Left Rear Isometric 16


Table - Components

Component Constant
3D 0
2D 1
2D Cut 2
Not set 4

説明

ダイアログボックスの既存のシンボルを表示するコントロールを、指定した新しいシンボル、レンダリングモード、ビューまたはイメージコンポーネントで更新します。 dialogIDとitemIDは、CreateSymDispCtrlNで作成したシンボル表示コントロールを参照する必要があります。空白のコントロールを表示したい場合は、symbolNameパラメータを空にします。

Table - Render Modes

Render Mode Constant
Wireframe 0
Unshaded Polygon 2
Shaded Polygon 3
Shaded Polygon No Lines 4
Final Shaded Polygon 5
Hidden Line 6
Dashed Hidden Line 7
OpenGL 11
Fast RenderWorks 12
Fast RenderWorks with Shadows 13
Final Quality RenderWorks 14
Custom RenderWorks 15
Artistic RenderWorks 17
Sketch 18


Table - Views

View Constant
Top/Plan 2
Front 3
Back 4
Left 5
Right 6
Top 7
Bottom 8
Right Isometric 9
Left Isometric 10
Right Rear Isometric 11
Left Rear Isometric 12
Bottom Right Isometric 13
Bottom Left Isometric 14
Bottom Right Rear Isometric 15
Bottom Left Rear Isometric 16


Table - Components

Component Constant
3D 0
2D 1
2D Cut 2
Not set 4

Parameters:

dialogID The ID of the dialog in which to create the control. ダイアログ番号
itemID The item ID of the control. アイテム番号
symbolName The name of the symbol to display. シンボル名
view The view in which to display the symbol. 視点
renderMode The render mode in which to display the symbol. レンダリングモード
component The image component. コンポーネント
scaleByZoom Whether the sizing is done by zoom or layer scale. サイズ調整(ズーム/レイヤの縮尺)

See Also:

CreateSymDispCtrlN  



  VerifyLayout Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   VerifyLayout
( dialogID:LONGINT ) :BOOLEAN ;

Python:

def  vs.VerifyLayout(dialogID):
   return BOOLEAN

Description:

Checks a specified dialog layout for correct layout definition.

説明

作成したレイアウトの整合性をチェックします。

Parameters:

dialogID The index of the dialog layout to be verified. ダイアログ番号

Result:

Returns FALSE if a problem was encountered defining the dialog, otherwise returns TRUE.

返り値

整合性に問題がなければTRUEを返します。問題があればFALSEを返します。

Example:

{verify the dialog layou is properly constructed}
	dialogOK := VerifyLayout(lEditID);

	IF (dialogOK & rsAvailable) THEN
	BEGIN
		lmtestResult := RunLayoutDialog(lEditID,DriveSplashDialog);
	END;