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.

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  



  AddListBrowserImage Dialogs - Modern 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   AddListBrowserImage
(   dialogID :LONGINT;
    controlID :LONGINT;
    imageSpecifier :DYNARRAY[] of CHAR
) :INTEGER ;

Python:

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

Description:

Adds an image to a list browser. Replaces AddLBImage.

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



  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

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.

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



  CreateCenteredStaticText Dialogs - Modern 
VectorWorks12.0.1

VectorScript Declaration:

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

Python:

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

Description:

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



  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:




  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.

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



  CreateClassPullDownMenu Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

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

Python:

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

Description:

Creates a Layout Manager class pull down menu 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');
   CreateClassPullDownMenu(dialog1, 4, 24);
   SetFirstLayoutItem(dialog1, 4);
   result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

CreateImageControl  



  CreateColorPopup Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

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

Python:

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

Description:

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

The widthInCharacters 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.

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



  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;
    iWidth :INTEGER;
    iHeight :INTEGER
) ;

Python:

def  vs.CreateCustomControl(dialogID, componentID, iWidth, iHeight):
   return None

Description:

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



  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.

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



  CreateDesignLayerPullDownMenu Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

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

Python:

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

Description:

Creates a Layout Manager design layer pull down menu control.



  CreateEditInteger Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

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

Python:

def  vs.CreateEditInteger(dialogID, itemID, defaultValue, widthInCharacters):
   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.
widthInCharacters Width of the field in characters.

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



  CreateEditReal Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

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

Python:

def  vs.CreateEditReal(dialogID, itemID, editRealType, defaultValue, widthInCharacters):
   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.
widthInCharacters Width of the field in characters.

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



  CreateEditText Dialogs - Modern 
VectorWorks9.0

VectorScript Declaration:

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

Python:

def  vs.CreateEditText(dialogID, itemID, defaultText, widthInCharacters):
   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.
widthInCharacters The width of the displayed text in characters.

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




  CreateEditTextBox Dialogs - Modern 
VectorWorks10.0

VectorScript Declaration:

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

Python:

def  vs.CreateEditTextBox(dialogID, itemID, defaultText, widthInCharacters, 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.
widthInCharacters Width of the control in characters
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);



  CreateEnhancedPullDownMenu Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

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

Python:

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

Description:

Creates a Layout Manager enhanced pull down menu control.



  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.

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.

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;
    nWidthInChars :INTEGER
) ;

Python:

def  vs.CreateIconPushButton(nDialogID, nComponentID, nIconID, nWidthInChars):
   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.

Parameters:

nIconID the index of the ICN# resource in the currently open rsrc file (or qtr on Windows)

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



  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;
    widthInCharacters :INTEGER;
    imageSpecifier :DYNARRAY[] of CHAR
) ;

Python:

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

Description:

Creates an image push button. Replaces CreateIconPushButton

Parameters:

dialogID The dialog identifier given by the command to create the dialog.
controlID The identifier that should be assigned to the control.
widthInCharacters The width of the control.
imageSpecifier The string identifier for the image. It should be of the form "ResourceFileNameWithoutExtension/PathOfImageFile".



  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.
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;
    widthInCharacters :LONGINT;
    heightInCharacters :LONGINT
) ;

Python:

def  vs.CreateListBox(dialogID, itemID, widthInCharacters, heightInCharacters):
   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.
widthInCharacters The width of the control in characters.
heightInCharacters The height of the control in characters.

Example:

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



  CreateListBoxN Dialogs - Modern 
VectorWorks10.5

VectorScript Declaration:

PROCEDURE   CreateListBoxN
(   dialogID :LONGINT;
    itemID :LONGINT;
    widthInCharacters :LONGINT;
    heightInCharacters :LONGINT;
    isMultipleSelect :BOOLEAN
) ;

Python:

def  vs.CreateListBoxN(dialogID, itemID, widthInCharacters, heightInCharacters, isMultipleSelect):
   return None

Description:

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

Parameters:

dialogID The index of the dialog layout containing the control.
itemID The index that will identify the control item.
widthInCharacters The width of the control in characters.
heightInCharacters The height of the control in characters.
isMultipleSelect Does the list support multiple selection

Example:

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



  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;
    widthInCharacters :LONGINT
) ;

Python:

def  vs.CreatePullDownMenu(dialogID, itemID, widthInCharacters):
   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.
widthInCharacters The width of the control in characters.



  CreatePullDownMenuGroupBox Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

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

Python:

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

Description:

Creates a Layout Manager pull down menu group box.



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



  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.

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



  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.

See Also:

SetEdgeBinding   SetProportionalBinding  



  CreateRightStaticText Dialogs - Modern 
VectorWorks12.0.1

VectorScript Declaration:

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

Python:

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

Description:

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



  CreateSeparator Dialogs - Modern 
VectorWorks12.5

VectorScript Declaration:

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

Python:

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

Description:

Creates a Layout Manager image separator.



  CreateSheetLayerPullDownMenu Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

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

Python:

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

Description:

Creates a Layout Manager sheet layer pull down menu control.



  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

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;
    widthInCharacters :LONGINT
) ;

Python:

def  vs.CreateStaticText(dialogID, itemID, text, widthInCharacters):
   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.

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.
widthInCharacters The width of the control in characters.

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  



  CreateStyledStatic Dialogs - Modern 
Vectorworks 2013

VectorScript Declaration:

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

Python:

def  vs.CreateStyledStatic(dialogID, componentID, text, widthInCharacters, 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:

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

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  



  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.

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.

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  



  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.

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.

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.



  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



  CreateTreeControl Dialogs - Modern 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   CreateTreeControl
(   nDialogID :LONGINT;
    nComponentID :LONGINT;
    nWidthInChars :INTEGER;
    nHeightInChars :INTEGER
) ;

Python:

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

Description:

Creates a Layout Manager tree control.

Example:

PROCEDURE Example;
VAR
   dialog1 :INTEGER;
   result  :INTEGER;
   widthInChars, heightInChars :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');
   widthInChars := 28;
   heightInChars := 8;
   CreateTreeControl(dialog1, 4, widthInChars, heightInChars);
   SetFirstLayoutItem(dialog1, 4);
   result := RunLayoutDialog(dialog1, Dialog_Handler);
END;
RUN(Example);

See Also:

GetTreeControlSelectedItem   InsertTreeControlItem   RemoveTreeControlItem  



  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

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

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.



  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.



  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.



  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.



  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.



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



  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.



  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.

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)
spotPosition Position of the segment's color marker relative to left-most point of the slider.
(position >= 0.0 and position <= 1.0)
midpointPosition Position of the segment's midpoint marker relative to color marker immediately to left.
(position >= 0.0 and position <= 1.0)
red Red component of the color spot's color.
(red >= 0 and red <= 255)
green Green component of the color spot's color.
(green >= 0 and green <= 255)
blue Blue component of the color spot's color.
(blue >= 0 and blue <= 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.

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)
markerType Type of marker selected.
(1 = color marker, 2 = midpoint marker)

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.

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.

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.



  GetLineAttributeData Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

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

Python:

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

Description:

Get the current choices for the combined line style and line weight dialog control. The line style value is an index and the line weight value is in mils.



  GetLineStyleChoice Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

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

Python:

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

Description:

Get current choice of line style popup dialog control. Choice is an index into list of linestyles available in current document.



  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.

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.

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

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

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.

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.

Parameters:

dialogID the dialog identifier given by CreateLayout or CreateResizableLayout
componentID The identifier of the component which choice index will be retrieved from by a given choice name.
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.



  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.



  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.
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.
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.
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.
layerLevelType Returns the layer type which defines this bound.

See Also:

GetStoryBoundChoiceStrings   GetChoiceStringFromStoryBoundData  



  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.



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

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)
red Red component of the color spot's color.
(red >= 0 and red <= 255)
green Green component of the color spot's color.
(green >= 0 and green <= 255)
blue Blue component of the color spot's color.
(blue >= 0 and blue <= 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.
red Red component of the color spot's color.
green Green 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.

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.

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.



  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.



  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.

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)

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.



  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.

See Also:

RunLayoutDialog  



  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.



  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.

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



  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.

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.

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.



  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.

See Also:

CreateResizableLayout   SetProportionalBinding  



  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.
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 Green 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:

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)
spotPosition Position of the segment's color marker relative to left-most point of the slider.
(position >= 0.0 and position <= 1.0)
midpointPosition Position of the segment's midpoint marker relative to color marker immediately to left.
(position >= 0.0 and position <= 1.0)
red Red component of the color spot's color.
(red >= 0 and red <= 255)
green Green component of the color spot's color.
(green >= 0 and green <= 255)
blue Blue component of the color spot's color.
(blue >= 0 and blue <= 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.

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)
markerType Type of marker to select.
(1 = color marker, 2 = midpoint marker)

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

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.



  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.



  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.

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

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

VectorScript Declaration:

PROCEDURE   SetLineAttributeData
(   dialogID :LONGINT;
    itemID :LONGINT;
    lineStyle :INTEGER;
    lineWeight :INTEGER
) ;

Python:

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

Description:

Set current choices for the line attribute dialog control. Both the line style index and the line weight in mils can be specified.



  SetLineStyleChoice Dialogs - Modern 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetLineStyleChoice
(   dialogID :LONGINT;
    itemID :LONGINT;
    lineStyle :INTEGER
) ;

Python:

def  vs.SetLineStyleChoice(dialogID, itemID, lineStyle):
   return None

Description:

Set the current choice of the line style popup dialog control to the specified index.



  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.

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

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.

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



  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)



  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.



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

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.

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.

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.

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

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



  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.

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  



  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.

Example:

{verify the dialog layou is properly constructed}
	dialogOK := VerifyLayout(lEditID);

	IF (dialogOK & rsAvailable) THEN
	BEGIN
		lmtestResult := RunLayoutDialog(lEditID,DriveSplashDialog);
	END;