AlertCritical Dialogs - Predefined 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   AlertCritical
(   text :STRING;
    advice :STRING
) ;

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  



  AlertInform Dialogs - Predefined 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   AlertInform
(   text :STRING;
    advice :STRING;
    minorAlert :BOOLEAN
) ;

Python:

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

Description:

Displays an alert dialog which provides the user an 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).

Example:

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

See Also:

AlertQuestion   AlertCritical   AlertInformDontShowAgain   AlertQuestionDontShowAgain  



  AlertInformDontShowAgain Dialogs - Predefined 
Vectorworks 2010

VectorScript Declaration:

PROCEDURE   AlertInformDontShowAgain
(   text :STRING;
    advice :STRING;
    minorAlert :BOOLEAN;
    arrOptions :ARRAY
) ;

Python:

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

Description:

Displays an alert dialog which provides the user an 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

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).
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

Example:

PROCEDURE Example;

VAR
	result :INTEGER;
	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  



  AlertQuestion Dialogs - Predefined 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   AlertQuestion
(   question :STRING;
    advice :STRING;
    defaultButton :INTEGER;
    OKOverrideText :STRING;
    CancelOverrideText :STRING;
    customButtonAText :STRING;
    customButtonBText :STRING
) :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
OKOverrideText Specifies a string to use in overriding the 'OK' string
CancelOverrideText Specifies a string to use in overriding the 'Cancel' string
customButtonAText Specifies a string to use for an optional custom button A
customButtonBText Specifies a string to use for a second optional custom button 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

Example:

PROCEDURE Example;

VAR
	result :INTEGER;

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

RUN(Example);

See Also:

AlertInform   AlertCritical   AlertInformDontShowAgain   AlertQuestionDontShowAgain  



  AlertQuestionDontShowAgain Dialogs - Predefined 
Vectorworks 2010

VectorScript Declaration:

FUNCTION   AlertQuestionDontShowAgain
(   question :STRING;
    advice :STRING;
    defaultButton :INTEGER;
    OKOverrideText :STRING;
    CancelOverrideText :STRING;
    customButtonAText :STRING;
    customButtonBText :STRING;
    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

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
OKOverrideText Specifies a string to use in overriding the 'OK' string
CancelOverrideText Specifies a string to use in overriding the 'Cancel' string
customButtonAText Specifies a string to use for an optional custom button A
customButtonBText Specifies a string to use for a second optional custom button 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

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

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  



  AlertSetAlwaysDoVal Dialogs - Predefined 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   AlertSetAlwaysDoVal
(   category :STRING;
    item :STRING;
    value :INTEGER
) ;

Python:

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

Description:

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

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  



  AlrtDialog Dialogs - Predefined 
MiniCAD

VectorScript Declaration:

PROCEDURE   AlrtDialog
( message:STRING ) ;

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.');



  AngDialog Dialogs - Predefined 
MiniCAD

VectorScript Declaration:

FUNCTION   AngDialog
(   request :STRING;
    default :STRING
) :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');



  AngDialog3D Dialogs - Predefined 
MiniCAD

VectorScript Declaration:

PROCEDURE   AngDialog3D
(   displayStr :STRING;
    xStr :STRING;
    yStr :STRING;
    zStr :STRING;
  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.

Parameters:

displayStr Dialog user prompt string.
xStr Default value for input field.
yStr Default value for input field.
zStr Default value for input field.
xAngleResult Returns user input X value.
yAngleResult Returns user input Y value.
zAngleResult Returns user input Z value.

Example:

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



  DetailGraphicOptDlg Dialogs - Predefined 
Vectorworks 2013

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.



  DidCancel Dialogs - Predefined 
MiniCAD

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.

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);



  DistDialog Dialogs - Predefined 
MiniCAD

VectorScript Declaration:

FUNCTION   DistDialog
(   request :STRING;
    default :STRING
) :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');



  FormatTextDialog Dialogs - Predefined 
VectorWorks9.0

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.
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.
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.
vAlignment The selected vertical alignment options. 1 for top, 2 for top baseline, 3 for center, 4 for bottom baseline and 5 for bottom.
disableMask Disables controls and indicates for worksheet. Bit 1 disables font name, bit 2 size, bit 3 spacing, bit 4 style, bit 5 h align, bit 6 v align and bit 7 worksheet.

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);



  IntDialog Dialogs - Predefined 
MiniCAD

VectorScript Declaration:

FUNCTION   IntDialog
(   request :STRING;
    default :STRING
) :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');



  NonUndoableActionOK Dialogs - Predefined 
VectorWorks8.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.



  PtDialog Dialogs - Predefined 
MiniCAD

VectorScript Declaration:

PROCEDURE   PtDialog
(   request :STRING;
    defaultX :STRING;
    defaultY :STRING;
  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.
defaultY Default value for input field.
x Returns user input X value.
y Returns user input Y value.

Example:

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



  PtDialog3D Dialogs - Predefined 
MiniCAD

VectorScript Declaration:

PROCEDURE   PtDialog3D
(   displayStr :STRING;
    xStr :STRING;
    yStr :STRING;
    zStr :STRING;
  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.

Parameters:

displayStr Dialog user prompt string.
xStr Default value for input field.
yStr Default value for input field.
zStr Default value for input field.
xPt Returns user input X value.
yPt Returns user input Y value.
zPt Returns user input Z value.

Example:

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



  RealDialog Dialogs - Predefined 
MiniCAD

VectorScript Declaration:

FUNCTION   RealDialog
(   request :STRING;
    default :STRING
) :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');



  StrDialog Dialogs - Predefined 
MiniCAD

VectorScript Declaration:

FUNCTION   StrDialog
(   request :STRING;
    default :STRING
) :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);



  YNDialog Dialogs - Predefined 
MiniCAD

VectorScript Declaration:

FUNCTION   YNDialog
( s:STRING ) :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.

Parameters:

s Dialog user prompt string.

Example:

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