VectorScript Declaration:

PROCEDURE   AlertCritical

(   text :DYNARRAY[] of CHAR;     advice :DYNARRAY[] of CHAR ) ;

Python:

def  vs.AlertCritical(text, advice):

   return None

Description:

Informs the user of a serious problem that requires intervention or correction before work can continue.

説明

作業を継続する前に訂正が必要な問題が発生したことをユーザに知らせます。

Parameters:

text	The information to be displayed.	本文として表示する文字列
advice	The text to be added in a smaller font under the main information message.	本文の下に小さなフォントで注釈文として表示する文字列

Example:

AlertCritical('Out of Memory', '');

See Also:

AlertInform   AlertQuestion   AlertInformDontShowAgain   AlertQuestionDontShowAgain   AlertCriticalHLink   AlertInformHLink   AlertInformHLinkN  

VectorScript Declaration:

PROCEDURE   AlertCriticalHLink

(   text :DYNARRAY[] of CHAR;     adviceBeforeLink :DYNARRAY[] of CHAR;     linkTitle :DYNARRAY[] of CHAR;     linkURL :DYNARRAY[] of CHAR;     adviceAfterLink :DYNARRAY[] of CHAR ) ;

Python:

def  vs.AlertCriticalHLink(text, adviceBeforeLink, linkTitle, linkURL, adviceAfterLink):

   return None

Description:

Informs the user of a serious problem that requires intervention or correction before work can continue. Provides a hyperlink (HLink) to further help the user resolve the problem.

説明

リンク付きのストップアラートダイアログボックスを表示します。作業を継続する前に訂正が必要な問題が発生したことをユーザに知らせます。

Parameters:

text	The information to be displayed.	本文として表示する文字列
adviceBeforeLink	The text to be added in a smaller font under the main information message and above the hyperlink.	本文とハイパーリンクの間に表示する、小さなフォントで注釈文として表示する文字列
linkTitle	The clickable text of the hyperlink to be added under the adviceBeforeLink text and above the adviceAfterLink text. The text to be added will be in the same smaller font as the adviceBeforeLink text.	注釈(adviceBeforeLink)の下に表示する、ハイパーリンクとしてクリック可能な文字列。注釈と同じ小さなフォントで表示される。
linkURL	The URL that a user will be directed to when the user clicks on the linkTitle text.	ハイパーリンクをクリックしたときに開くURL
adviceAfterLink	The text to be added under the hyperlink. The text to be added will be in the same smaller font as the adviceBeforeLink text.	ハイパーリンクの下に表示する文字列。注釈と同じ小さなフォントで表示される。

Example:

AlertCriticalHLink('Serious Problem with X', 'Please visit', 'our website', 'https://www.vectorworks.net', 'for more information on how to resolve the problem with X.');

See Also:

AlertCritical   AlertInform   AlertQuestion   AlertInformDontShowAgain   AlertQuestionDontShowAgain   AlertInformHLink   AlertInformHLinkN  

VectorScript Declaration:

PROCEDURE   AlertInform

(   text :DYNARRAY[] of CHAR;     advice :DYNARRAY[] of CHAR;     minorAlert :BOOLEAN ) ;

Python:

def  vs.AlertInform(text, advice, minorAlert):

   return None

Description:

Displays an alert dialog which provides the user with information about the result of a command. It offers no user choices.

説明

プログラムの実行結果を警告ダイアログに表示します。ユーザに選択肢は提供しません。

Parameters:

text	The information to be displayed.	本文として表示する文字列
advice	The text to be added in a smaller font under the main information message.	本文の下に小さなフォントで注釈文として表示する文字列
minorAlert	The severity of the alert: minor(true) or major(false).	アラートの重要度（TRUE：低／FALSE：高）

Example:

AlertInform('That item is not a valid item', '',isMinorAlert);

See Also:

AlertQuestion   AlertCritical   AlertInformDontShowAgain   AlertQuestionDontShowAgain   AlertCriticalHLink   AlertInformHLink   AlertInformHLinkN  

VectorScript Declaration:

PROCEDURE   AlertInformDontShowAgain

(   text :DYNARRAY[] of CHAR;     advice :DYNARRAY[] of CHAR;     minorAlert :BOOLEAN;     arrOptions :ARRAY ) ;

Python:

def  vs.AlertInformDontShowAgain(text, advice, minorAlert, arrOptions):

   return None

Description:

Displays an alert dialog which provides the user with information about the result of a command with an option to not show the dialog again. It offers no user choices.

The parameter 'arrOptions' is of type ARRAY [1..3] OF STRING;
arrOpt[1] - Saved setting category to save checkbox value
arrOpt[2] - Saved setting item to save checkbox value
arrOpt[3] - Specify the string to use in overriding the default 'Dont show this dialog again' checkbox string

説明

二度と表示しないオプション付きのアラートダイアログ表示します。

'arrOptions' の型は ARRAY [1..3] OF STRING;
arrOpt[1] - チェックボックスの値を保存するための保存設定のカテゴリー
arrOpt[2] - チェックボックスの値を保存するための保存設定の要素
arrOpt[3] - 「二度とこのダイアログを表示しない」チェックボックスの文字列

Parameters:

text	The information to be displayed.	本文として表示する文字列
advice	The text to be added in a smaller font under the main information message.	本文の下に小さなフォントで注釈文として表示する文字列
minorAlert	The severity of the alert: minor(true) or major(false).	アラートの重要度（TRUE：低／FALSE：高）
arrOptions	ARRAY [1..3] OF STRING; arrOpt[1] - Saved setting category to save checkbox value arrOpt[2] - Saved setting item to save checkbox value arrOpt[3] - Specify a string to use in overriding the default 'Dont show this dialog again' checkbox string	ARRAY [1..3] OF STRING; arrOpt[1] - チェックボックスの値を保存するための保存設定のカテゴリー arrOpt[2] - チェックボックスの値を保存するための保存設定の要素 arrOpt[3] - 「二度とこのダイアログを表示しない」チェックボックスの文字列

Example:

PROCEDURE Example;

VAR
	arrayText : ARRAY[1..3] OF STRING;

BEGIN
	arrayText[1] := 'DontShowDialogAgainCategory';
	arrayText[2] := 'DontShowDialogAgainItem'; {Should be unique for every AlertInformDontShowAgain}
	arrayText[3] := '';

	AlertInformDontShowAgain('This is an invalid item.', '', false, arrayText);
END;

RUN(Example);

See Also:

AlertInform   AlertQuestion   AlertCritical   AlertQuestionDontShowAgain   AlertCriticalHLink   AlertInformHLink   AlertInformHLinkN  

VectorScript Declaration:

PROCEDURE   AlertInformHLink

(   text :DYNARRAY[] of CHAR;     adviceBeforeLink :DYNARRAY[] of CHAR;     linkTitle :DYNARRAY[] of CHAR;     linkURL :DYNARRAY[] of CHAR;     adviceAfterLink :DYNARRAY[] of CHAR;     minorAlert :BOOLEAN ) ;

Python:

def  vs.AlertInformHLink(text, adviceBeforeLink, linkTitle, linkURL, adviceAfterLink, minorAlert):

   return None

Description:

Displays an alert dialog which provides the user with information about the result of a command. It offers no user choices. It provides a hyperlink (HLink) to further help the user.

説明

コマンドの実行結果に関する情報と共にリンク付きのアラートダイアログボックスを表示します。

Parameters:

text	The information to be displayed.	本文として表示する文字列
adviceBeforeLink	The text to be added in a smaller font under the main information message and above the hyperlink.	本文とハイパーリンクの間に表示する、小さなフォントで注釈文として表示する文字列
linkTitle	The clickable text of the hyperlink to be added under the adviceBeforeLink text and above the adviceAfterLink text. The text to be added will be in the same smaller font as the adviceBeforeLink text.	注釈(adviceBeforeLink)の下に表示する、ハイパーリンクとしてクリック可能な文字列。注釈と同じ小さなフォントで表示される。
linkURL	The URL that a user will be directed to when the user clicks on the linkTitle text.	ハイパーリンクをクリックしたときに開くURL
adviceAfterLink	The text to be added under the hyperlink. The text to be added will be in the same smaller font as the adviceBeforeLink text.	ハイパーリンクの下に表示する文字列。注釈と同じ小さなフォントで表示される。
minorAlert	The severity of the alert: minor(true) or major(false).	アラートの重要度（TRUE：低／FALSE：高）

Example:

AlertInformHLink('That item is not a valid item', 'Please visit', 'our website', 'https://www.vectorworks.net', 'for more information on what is a valid item.', false);

See Also:

AlertInform   AlertQuestion   AlertCritical   AlertInformDontShowAgain   AlertQuestionDontShowAgain   AlertCriticalHLink   AlertInformHLinkN  

VectorScript Declaration:

PROCEDURE   AlertInformHLinkN

(   text :DYNARRAY[] of CHAR;     adviceBeforeLink :DYNARRAY[] of CHAR;     linkTitle :DYNARRAY[] of CHAR;     linkURL :DYNARRAY[] of CHAR;     adviceAfterLink :DYNARRAY[] of CHAR;     minorAlert :BOOLEAN;     arrOptions :ARRAY ) ;

Python:

def  vs.AlertInformHLinkN(text, adviceBeforeLink, linkTitle, linkURL, adviceAfterLink, minorAlert, arrOptions):

   return None

Description:

Displays an alert dialog which provides the user with information about the result of a command with an option to not show the dialog again. It offers no user choices. It provides a hyperlink (HLink) to further help the user.

The parameter 'arrOptions' is of type ARRAY [1..3] OF STRING;
arrOpt[1] - Saved setting category to save checkbox value
arrOpt[2] - Saved setting item to save checkbox value
arrOpt[3] - Specify the string to use in overriding the default 'Dont show this dialog again' checkbox string

説明

コマンドの実行結果に関する情報と共に「再表示しない」オプションとリンク付きのアラートダイアログボックスを表示します。「arrOptions」の型は、ARRAY [1..3] OF STRINGです。arrOpt[1]:値を保存する設定ファイルのカテゴリ名、arrOpt[2]:設定ファイルの項目名、arrOpt[3]:「再表示しない」チェックボックスの文字列

Parameters:

text	The information to be displayed.	本文として表示する文字列
adviceBeforeLink	The text to be added in a smaller font under the main information message and above the hyperlink.	本文とハイパーリンクの間に表示する、小さなフォントで注釈文として表示する文字列
linkTitle	The clickable text of the hyperlink to be added under the adviceBeforeLink text and above the adviceAfterLink text. The text to be added will be in the same smaller font as the adviceBeforeLink text.	注釈(adviceBeforeLink)の下に表示する、ハイパーリンクとしてクリック可能な文字列。注釈と同じ小さなフォントで表示される。
linkURL	The URL that a user will be directed to when the user clicks on the linkTitle text.	ハイパーリンクをクリックしたときに開くURL
adviceAfterLink	The text to be added under the hyperlink. The text to be added will be in the same smaller font as the adviceBeforeLink text.	ハイパーリンクの下に表示する文字列。注釈と同じ小さなフォントで表示される。
minorAlert	The severity of the alert: minor(true) or major(false).	アラートの重要度（TRUE：低／FALSE：高）
arrOptions	ARRAY [1..3] OF STRING; arrOpt[1] - Saved setting category to save checkbox value arrOpt[2] - Saved setting item to save checkbox value arrOpt[3] - Specify a string to use in overriding the default 'Dont show this dialog again' checkbox string	ARRAY [1..3] OF STRING; arrOpt[1] - チェックボックスの値を保存するための保存設定のカテゴリー arrOpt[2] - チェックボックスの値を保存するための保存設定の要素 arrOpt[3] - 「二度とこのダイアログを表示しない」チェックボックスの文字列

Example:

PROCEDURE Example;

VAR
	arrayText : ARRAY[1..3] OF STRING;

BEGIN
	arrayText[1] := 'DontShowDialogAgainCategory';
	arrayText[2] := 'DontShowDialogAgainItem'; {Should be unique for every AlertInformDontShowAgain}
	arrayText[3] := '';

	AlertInformHLinkN('This is an invalid item.', 'Please visit', 'our website', 'https://www.vectorworks.net', 'for more information on what is a valid item.', false, arrayText);
END;

RUN(Example);

See Also:

AlertInform   AlertQuestion   AlertCritical   AlertInformDontShowAgain   AlertQuestionDontShowAgain   AlertCriticalHLink   AlertInformHLink  

VectorScript Declaration:

FUNCTION   AlertQuestion

(   question :DYNARRAY[] of CHAR;     advice :DYNARRAY[] of CHAR;     defaultButton :INTEGER;     OKOverrideText :DYNARRAY[] of CHAR;     CancelOverrideText :DYNARRAY[] of CHAR;     customButtonAText :DYNARRAY[] of CHAR;     customButtonBText :DYNARRAY[] of CHAR ) :INTEGER ;

Python:

def  vs.AlertQuestion(question, advice, defaultButton, OKOverrideText, CancelOverrideText, customButtonAText, customButtonBText):

   return INTEGER

Description:

Displays an alert dialog which alerts the user to a condition or situation that requires the user's decision and input before preceding; such as an impending action with potentially destructive or irreversible consequences. The message should be in the form of a question.

説明

ユーザの決定を入力することができる警告ダイアログを表示します。
例えば、元に戻すことのできない操作を実行する前などに表示します。
ダイアログに表示する文章を質問形式にすることができます。

Parameters:

question	The question to display	本文として表示する文字列
advice	The text to be added in a smaller font under the main information/message	本文の下に小さなフォントで注釈文として表示する文字列
defaultButton	Specifies which button is to be made the default 0: the negative button is the default 1: the positive button is the default 2: custom button A is the default 3: custom button B is the default	デフォルトで選択されるボタンの番号 0：キャンセルボタン 1：OKボタン 2：Aボタン 3：Bボタン
OKOverrideText	Specifies a string to use in overriding the 'OK' string	OKボタンに表示する文字列
CancelOverrideText	Specifies a string to use in overriding the 'Cancel' string	キャンセルボタンに表示する文字列
customButtonAText	Specifies a string to use for an optional custom button A	Aボタンに表示する文字列
customButtonBText	Specifies a string to use for a second optional custom button B	Bボタンに表示する文字列

Result:

Return Values
0: the negative button was hit
1: the positive button was hit
2: custom button A was hit
3: custom button B was hit

返り値

返り値
0：キャンセルボタンがクリックされました。
1：OKボタンがクリックされました。
2：ボタンAがクリックされました。
3：ボタンBがクリックされました。

Example:

PROCEDURE Example;
BEGIN
  AlrtDialog('AlrtDialog');
  AlertInform('AlertInform', 'advice', FALSE);
  AlertCritical('AlertCritical', 'advice');
  Message(YNDialog('YNDialog'));
  Message(AlertQuestion('question', 'advice', 1, 'ok', 'cancel', 'a', 'b'));
END;
RUN(Example);

See Also:

AlertInform   AlertCritical   AlertInformDontShowAgain   AlertQuestionDontShowAgain   AlertCriticalHLink   AlertInformHLink   AlertInformHLinkN  

VectorScript Declaration:

FUNCTION   AlertQuestionDontShowAgain

(   question :DYNARRAY[] of CHAR;     advice :DYNARRAY[] of CHAR;     defaultButton :INTEGER;     OKOverrideText :DYNARRAY[] of CHAR;     CancelOverrideText :DYNARRAY[] of CHAR;     customButtonAText :DYNARRAY[] of CHAR;     customButtonBText :DYNARRAY[] of CHAR;     arrOptions :ARRAY ) :INTEGER ;

Python:

def  vs.AlertQuestionDontShowAgain(question, advice, defaultButton, OKOverrideText, CancelOverrideText, customButtonAText, customButtonBText, arrOptions):

   return INTEGER

Description:

Displays an alert dialog which alerts the user to a condition or situation that requires the user's decision and input before preceding; such as an impending action with potentially destructive or irreversible consequences with the option to always do the selected action and not show the dialog again. The message should be in the form of a question.

The parameter 'arrOptions' is of type ARRAY [1..3] OF STRING;
arrOpt[1] - Saved setting category to save checkbox value
arrOpt[2] - Saved setting item to save checkbox value
arrOpt[3] - Specify a string to use in overriding the default 'Always do the selection action' checkbox string

説明

二度と表示しないオプション付きのユーザの決定を入力することができる警告ダイアログ表示します。

'arrOptions' の型は ARRAY [1..3] OF STRING;
arrOpt[1] - チェックボックスの値を保存するための保存設定のカテゴリー
arrOpt[2] - チェックボックスの値を保存するための保存設定の要素
arrOpt[3] - 「つねに選択した動作を行う」チェックボックスの文字列

Parameters:

question	The question to display	本文として表示する文字列
advice	The text to be added in a smaller font under the main information/message	本文の下に小さなフォントで注釈文として表示する文字列
defaultButton	Specifies which button is to be made the default 0: the negative button is the default 1: the positive button is the default 2: custom button A is the default 3: custom button B is the default	デフォルトで選択されるボタンの番号 0：キャンセルボタン 1：OKボタン 2：Aボタン 3：Bボタン
OKOverrideText	Specifies a string to use in overriding the 'OK' string	OKボタンに表示する文字列
CancelOverrideText	Specifies a string to use in overriding the 'Cancel' string	キャンセルボタンに表示する文字列
customButtonAText	Specifies a string to use for an optional custom button A	Aボタンに表示する文字列
customButtonBText	Specifies a string to use for a second optional custom button B	Bボタンに表示する文字列
arrOptions	ARRAY [1..3] OF STRING; arrOpt[1] - Saved setting category to save checkbox value arrOpt[2] - Saved setting item to save checkbox value arrOpt[3] - Specify a string to use in overriding the default 'Always do the selection action' checkbox string	アラートオブション[1][2][3]

Result:

Return Values
0: the negative button was hit
1: the positive button was hit
2: custom button A was hit
3: custom button B was hit

返り値

選択されたボタンの番号（0,1,2,3）

Example:

PROCEDURE Example;

VAR
	result :INTEGER;
	arrayText : ARRAY[1..3] OF STRING;

BEGIN
	arrayText[1] := 'DontShowDialogAgainCategory';
	arrayText[2] := 'DontShowDialogAgainItem'; {Should be unique for every AlertQuestionDontShowAgain}
	arrayText[3] := '';

	result := AlertQuestionDontShowAgain('Do you want to continue?', '', 0, 'Yes', 'No', '', '', arrayText);
END;

RUN(Example);

See Also:

AlertInform   AlertQuestion   AlertCritical   AlertInformDontShowAgain   AlertCriticalHLink   AlertInformHLink   AlertInformHLinkN  

VectorScript Declaration:

PROCEDURE   AlertSetAlwaysDoVal

(   category :DYNARRAY[] of CHAR;     item :DYNARRAY[] of CHAR;     value :INTEGER ) ;

Python:

def  vs.AlertSetAlwaysDoVal(category, item, value):

   return None

Description:

Set the 'always do' value for the AlertQuestionDontShowAgain and AlertInformDontShowAgain standard dialogs.

説明

AlertQuestionDontShowAgain と AlertInformDontShowAgain の標準ダイアログに、「常に選択した動作を行う」値を設定します。-1の値を設定すると、値はクリアされます。

Parameters:

category	category name of the value.	設定のカテゴリ名
item	item name in the category.	カテゴリーの要素名
value	new value for the default. Pass in -1 for the entry to be cleared out and the dialog to show up again.	設定する値

See Also:

AlertQuestionDontShowAgain   AlertInformDontShowAgain  

VectorScript Declaration:

PROCEDURE   AlrtDialog

( message:DYNARRAY[] of CHAR ) ;

Python:

def  vs.AlrtDialog(message):

   return None

Description:

Procedure AlrtDialog displays an alert dialog to the user.

説明

警告ダイアログを表示します。

Parameters:

message

The alert message to be displayed.

表示する文字列

Example:

AlrtDialog('No objects are selected for this operation.');

VectorScript Declaration:

FUNCTION   AngDialog

(   request :DYNARRAY[] of CHAR;     default :DYNARRAY[] of CHAR ) :REAL ;

Python:

def  vs.AngDialog(request, default):

   return REAL

Description:

Function AngDialog displays a dialog box which requests the user to enter an angle value. The dialog automatically screens for valid numeric input, and will accept supported angle formats.

説明

角度を入力するためのダイアログを表示し、入力された値を返します。

Parameters:

request	Dialog user prompt string.	表示する文字列
default	Default value for input field.	初期値

Example:

AngleValue := AngDialog('Enter an angle value:', '0d');

VectorScript Declaration:

PROCEDURE   AngDialog3D

(   displayStr :DYNARRAY[] of CHAR;     xStr :DYNARRAY[] of CHAR;     yStr :DYNARRAY[] of CHAR;     zStr :DYNARRAY[] of CHAR;   VAR  xAngleResult :REAL;   VAR  yAngleResult :REAL;   VAR  zAngleResult :REAL ) ;

Python:

def  vs.AngDialog3D(displayStr, xStr, yStr, zStr):

   return (xAngleResult, yAngleResult, zAngleResult)

Description:

Function AngDialog3D displays a dialog box which requests the user to enter three angle values. AngDialog3D will accept angle values in any supported angle format.

説明

3次元の角度を入力するためのダイアログを表示し、入力された値を返します。

Parameters:

displayStr	Dialog user prompt string.	表示する文字列
xStr	Default value for input field.	X入力欄の初期値
yStr	Default value for input field.	Y入力欄の初期値
zStr	Default value for input field.	Z入力欄の初期値
xAngleResult	Returns user input X value.	入力されたXの値
yAngleResult	Returns user input Y value.	入力されたYの値
zAngleResult	Returns user input Z value.	入力されたZの値

Example:

AngDialog3D('Enter the angle values:','0','0','0',x,y,z);

VectorScript Declaration:

FUNCTION   DetailGraphicOptDlg

( VAR  Marker :STRING;   VAR  ShoulderLength :REAL;   VAR  TagPosIndex :INTEGER;   VAR  LeaderType :LONGINT;   VAR  LeaderThick :INTEGER ) :BOOLEAN ;

Python:

def  vs.DetailGraphicOptDlg(Marker, ShoulderLength, TagPosIndex, LeaderType, LeaderThick):

   return (BOOLEAN, Marker, ShoulderLength, TagPosIndex, LeaderType, LeaderThick)

Description:

This brings up the Graphic Options dialog for Detail-Callout Marker and Detail Callout objects.

説明

詳細引出線マーカーおよび詳細引出線オブジェクトのグラフィックオプションダイアログを表示します。

Parameters:

Marker	The name of the selected Marker symbol.	選択されたマーカーシンボルの名前
ShoulderLength	The shoulder length for the detail callout object.	詳細引出線オブジェクトの引出し長さ
TagPosIndex	The index of the selected Tag Position.	選択されたタグの番号
LeaderType	The linetype for the leader lines.	引出線のタイプ
LeaderThick	The line thickness for the leader line.	引出線の太さ

Result:

Whether the user clicked on the OK button.

返り値

ダイアログでOKボタンがクリックされたかどうかを返します。

VectorScript Declaration:

FUNCTION   DidCancel

:BOOLEAN ;

Python:

def  vs.DidCancel():

   return BOOLEAN

Description:

Function DidCancel detects whether the Cancel button in a predefined dialog was pressed. DidCancel is intended for use with conditional statements to signal that a cancel event has occurred.

説明

直前に表示されたダイアログで、「キャンセル」ボタンが押された場合はTRUEを返します。

Example:

PROCEDURE Example;
VAR
	i : INTEGER;
BEGIN
	i := IntDialog('Enter an integer:', '0');
	IF NOT DidCancel THEN BEGIN
		i := i*3;
		Message(i);
	END;
END;
RUN(Example);

VectorScript Declaration:

FUNCTION   DistDialog

(   request :DYNARRAY[] of CHAR;     default :DYNARRAY[] of CHAR ) :REAL ;

Python:

def  vs.DistDialog(request, default):

   return REAL

Description:

Function DistDialog displays a dialog box which requests the user to enter a distance value.

DistDialog automatically screens for valid numeric input.

説明

距離を入力するためのダイアログを表示し、入力された値を返します。

Parameters:

request	Dialog user prompt string.	表示する文字列
default	Default value for input field.	初期値

Example:

DistValue := DistDialog('Enter a distance value:','0');

VectorScript Declaration:

FUNCTION   EditSymMarkersDlg

(   dialogTitle :STRING;     contextHelpID :STRING;   VAR  inOutStartMarkerSymName :STRING;   VAR  inOutEndMarkerSymName :STRING ) :BOOLEAN ;

Python:

def  vs.EditSymMarkersDlg(dialogTitle, contextHelpID, inOutStartMarkerSymName, inOutEndMarkerSymName):

   return (BOOLEAN, inOutStartMarkerSymName, inOutEndMarkerSymName)

Description:

Function EditSymMarkersDlg displays a dialog box which requests the user to choose starting and ending symbol markers. Returns TRUE if OK is clicked. Parameters inOutStartMarkerSymName and inOutEndMarkerSymName set the symbols to initialize selected symbols and return the newly selected symbol names.

説明

始点と終点のマーカーシンボルをユーザが選択できるダイアログボックスを表示します。OKボタンをクリックするとTRUEを返します。inOutStartMarkerSymNameとinOutEndMarkerSymNameパラメータは、シンボル選択を初期化して、新しく選択したシンボルの名前を返します。

Parameters:

dialogTitle	Dialog title string.	ダイアログのタイトル
contextHelpID	Contextual help ID string.	ヘルプID
inOutStartMarkerSymName	Name of starting symbol marker.	始点マーカーの名前
inOutEndMarkerSymName	Name of ending symbol marker.	終点マーカーの名前

VectorScript Declaration:

PROCEDURE   FormatTextDialog

( VAR  fontName :STRING;   VAR  style :INTEGER;   VAR  size :REAL;   VAR  spacing :INTEGER;   VAR  leading :REAL;   VAR  hAlignment :INTEGER;   VAR  vAlignment :INTEGER;     disableMask :INTEGER ) ;

Python:

def  vs.FormatTextDialog(fontName, style, size, spacing, leading, hAlignment, vAlignment, disableMask):

   return (fontName, style, size, spacing, leading, hAlignment, vAlignment)

Description:

Displays the text formatting dialog and returns the selected text formatting options.

Table - Text Style

Style	Constant
Plain	0
Bold	1
Italic	2
Underline	4
Outline	8
Shadowed	16
Superscript	32
Subscript	64

disableMask Values

Description	Constant
Font	1
Size	2
Spacing	4
Style	8
hAlign	16
vAlign	32

説明

文字の種類や位置揃え等を設定するためのダイアログを表示し、その内容を返します。

Parameters:

fontName	The name of the selected font.	フォント
style	The selected style options. 0 for plain text. Bit 1 is on for bold, bit 2 for italic, bit 3 for underline, bit 4 for outline and bit 5 for shadow.	スタイル（0：標準／1：ボールド／2：イタリック／3：）
size	The selected size (in points).	サイズ（ポイント）
spacing	The selected spacing option. 0 for custom leading, 2 for single spacing, 3 for 1 1/2 spacing and 4 for double spacing.	行間（0：全角／2：倍角／3：1.5角／4：指定）
leading	The selected leading value (in points) for custom spacing or -1 for a standard spacing.	リーディング
hAlignment	The selected horizontal alignment options. 0 for general justify (used only on worksheets), 1 for left, 2 for center and 3 for right.	水平位置揃え（1：左よせ／2：センタ／3：右よせ）
vAlignment	The selected vertical alignment options. 1 for top, 2 for top baseline, 3 for center, 4 for bottom baseline and 5 for bottom.	垂直位置揃え（1：上揃え／2：ベースライン揃え／3：センタ／4：英字下揃え／5：下揃え）
disableMask	Disables controls on the dialog. Bit 1 disables font name, bit 2 size, bit 3 spacing, bit 4 style, bit 5 h align, bit 6 v align.	常に0を入れる

Example:

PROCEDURE Example;
VAR 
	font    :STRING; 
	style   :INTEGER;
	size    :REAL;
	spacing :INTEGER; 
	leading :REAL;
	hAlign  :INTEGER;
	vAlign  :INTEGER;
	disable :INTEGER;
BEGIN
	{Set some dialog defaults.}
	font := 'Arial';
	style := 1;
	size := 12;
	spacing := 2;

	{Bit values for disableMask: 
         1: font
         2: size
         4: spacing
         8: style
        16: hAlign
        32: vAlign}
	disable := 32;

	{Now get the user's selections.}
	FormatTextDialog(font, style, size, spacing, leading, hAlign, vAlign, disable);
END;
RUN(Example);

VectorScript Declaration:

FUNCTION   IntDialog

(   request :DYNARRAY[] of CHAR;     default :DYNARRAY[] of CHAR ) :INTEGER ;

Python:

def  vs.IntDialog(request, default):

   return INTEGER

Description:

Function IntDialog displays a dialog box which requests the user to enter an integer value.

IntDialog automatically screens for valid numeric input.

説明

整数を入力するためのダイアログを表示し、入力された値を返します。

Parameters:

request	Dialog user prompt string.	表示する文字列
default	Default value for input field.	初期値

返り値

入力された値

Example:

distValue := IntDialog('Enter an integer value:','0');

VectorScript Declaration:

FUNCTION   NonUndoableActionOK

:BOOLEAN ;

Python:

def  vs.NonUndoableActionOK():

   return BOOLEAN

Description:

Function NonUndoableActionOK displays a dialog informing the user that the action that is about to be performed cannot be undone. If the user selects OK, the function returns TRUE. If the "Show Undo Warnings" preference is turned off, this function just returns TRUE and does not display a dialog.

説明

取り消しができないことをダイアログでユーザに知らせます。ユーザーが「OK」ボタンをクリックした場合はTRUEを、「キャンセル」ボタンをクリックした場合はFALSEを返します。

返り値

ユーザがOKボタンをクリックしたらTRUE

VectorScript Declaration:

PROCEDURE   PtDialog

(   request :DYNARRAY[] of CHAR;     defaultX :DYNARRAY[] of CHAR;     defaultY :DYNARRAY[] of CHAR;   VAR  x :REAL;   VAR  y :REAL ) ;

Python:

def  vs.PtDialog(request, defaultX, defaultY):

   return (x, y)

Description:

Procedure PtDialog displays a dialog box which requests the user to enter a coordinate (point) value.

説明

座標を入力するためのダイアログを表示し、入力された値を返します。

Parameters:

request	Dialog user prompt string.	表示する文字列
defaultX	Default value for input field.	X入力欄の初期値
defaultY	Default value for input field.	Y入力欄の初期値
x	Returns user input X value.	入力されたXの値
y	Returns user input Y value.	入力されたYの値

Example:

PtDialog('Enter a coordinate.','0','0',cX,cY);

VectorScript Declaration:

PROCEDURE   PtDialog3D

(   displayStr :DYNARRAY[] of CHAR;     xStr :DYNARRAY[] of CHAR;     yStr :DYNARRAY[] of CHAR;     zStr :DYNARRAY[] of CHAR;   VAR  xPt :REAL;   VAR  yPt :REAL;   VAR  zPt :REAL ) ;

Python:

def  vs.PtDialog3D(displayStr, xStr, yStr, zStr):

   return (xPt, yPt, zPt)

Description:

Procedure PtDialog3D displays a dialog box which requests the user to enter a 3D coordinate (point) value.

説明

3次元の座標を入力するためのダイアログを表示し、入力された値を返します。

Parameters:

displayStr	Dialog user prompt string.	表示する文字列
xStr	Default value for input field.	X入力欄の初期値
yStr	Default value for input field.	Y入力欄の初期値
zStr	Default value for input field.	Z入力欄の初期値
xPt	Returns user input X value.	入力されたXの値
yPt	Returns user input Y value.	入力されたYの値
zPt	Returns user input Z value.	入力されたZの値

Example:

PtDialog3D('Enter the 3D location:','0','0','0',x,y,z);

VectorScript Declaration:

FUNCTION   RealDialog

(   request :DYNARRAY[] of CHAR;     default :DYNARRAY[] of CHAR ) :REAL ;

Python:

def  vs.RealDialog(request, default):

   return REAL

Description:

Function RealDialog displays a dialog box which requests the user to enter a REAL value. RealDialog automatically screens for valid numeric input.

説明

実数を入力するためのダイアログを表示し、入力された値を返します。

Parameters:

request	Dialog user prompt string.	表示する文字列
default	Default value for input field.	初期値

返り値

入力された値

Example:

RealValue:=RealDialog('Enter a real value:','0.00');

VectorScript Declaration:

FUNCTION   StrDialog

(   request :DYNARRAY[] of CHAR;     default :DYNARRAY[] of CHAR ) :STRING ;

Python:

def  vs.StrDialog(request, default):

   return STRING

Description:

Function StrDialog, displays a dialog box which requests the user to enter a string value.

説明

文字列を入力するためのダイアログを表示し、入力された値を返します。

Parameters:

request	Dialog user prompt string.	表示する文字列
default	Default value for input field.	初期値

返り値

入力された値

Example:

PROCEDURE Example;
VAR
   request, default, result :STRING;
BEGIN
   request := 'Enter some text...';
   default := 'the default value';
   result := StrDialog(request, default);
END;
RUN(Example);

VectorScript Declaration:

FUNCTION   YNDialog

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

Python:

def  vs.YNDialog(s):

   return BOOLEAN

Description:

Function YNDialog displays a dialog box which requests the user to select a Yes or No value. If the user selects the Yes button in the dialog box, the value returned by YNDialog is TRUE; if the user selects No, the function returns FALSE.

説明

「はい」か「いいえ」を選択するダイアログを表示し、どちらのボタンが押されたかを返します。ユーザーが「はい」ボタンをクリックした場合はTRUEを、「いいえ」ボタンをクリックした場合はFALSEを返します。

Parameters:

s

Dialog user prompt string.

表示する文字列

Example:

Answer := YNDialog('Do you wish to continue');