Connect a manager control to a Button control to specify that the button performs a common user interface command, such as Open Sequence File. The Button control uses a localized caption and automatically enables or disables depending on the application state.

The control responds to user-generated events only when this property is True.

When you connect this control to a manager control, the manager control sets this property automatically.

The control responds to user-generated events only when this property is True.

When you connect this control to a manager control, the manager control sets this property automatically.

Specifies the appearance of the mouse cursor when the cursor is over the control.

When the parameter is MousePointer_Custom, the mouse cursor is the picture the Button.MouseIcon property specifies.

Specifies the appearance of the mouse cursor when the cursor is over the control.

When the parameter is MousePointer_Custom, the mouse cursor is the picture the Button.MouseIcon property specifies.

Specifies the custom mouse icon for the control.

The control displays the specified picture as the cursor when the value of the Button.MousePointer property is MousePointer_Custom. When you set this property to NULL, the value of the Button.MousePointer property changes to MousePointer_Default. Note: This property requires that the picture value is an icon.

Specifies the custom mouse icon for the control.

Specifies the font for the control when the value of the Button.FontSource property is FontSource_UseFontProperty.

Specifies the text the control displays.

In the caption, include an ampersand (&) immediately before the character, if any, you want to designate as an accelerator character. The character displays as underlined. Press <Alt> and the underlined character to move the focus to the control. To include an ampersand character in a caption without creating an accelerator character, include two consecutive ampersands. A single ampersand displays in the caption and no characters display as underlined. When you connect this control to a manager control, the manager control sets this property automatically.

Specifies the text the control displays.

This property is True when the button is pressed and False when the button is not pressed. Use this property when the value of the ButtonActionStyles enumeration is ButtonActionStyle_ToggleButton to set the pressed state of the button.

Setting this property generates a Button.Click event. Note: You cannot set this property at design time.

Specifies whether the control automatically resizes when the text of the control changes.

Occurs when you press and release the mouse on the control, or when the Button.Value property of the control changes.

Occurs when the user presses a key while the control has the input focus. This event occurs before the Button.KeyPress event.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user presses a key while the control has the input focus. This event occurs after the Button.KeyDown event.

Specifies the ASCII value of the pressed key.

Occurs when the user releases a key while the control has the input focus.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user clicks the mouse on the control. This event occurs before the Button.MouseUp event.

Specifies a MouseButtons constant that specifies the mouse button the user pressed to generate this event. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys. Specifies the x-coordinate of the mouse pointer, relative to the control, at the moment when the event occurs. Specifies the y-coordinate of the mouse pointer, relative to the control, at the moment when the event occurs.

Occurs when the user moves the mouse over the control.

Specifies what mouse buttons are pressed. You can use any combination of the MouseButtons constants. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys. Specifies the x-coordinate of the mouse pointer, relative to the control, at the moment when the event occurs. Specifies the y-coordinate of the mouse pointer, relative to the control, at the moment when the event occurs.

Occurs when the user releases the mouse button on the control. This event occurs before the Button.Click event.

Specifies the mouse button pressed to cause this event. You can use any one of the MouseButtons constants. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys. Specifies the x-coordinate of the mouse pointer, relative to the control, at the moment when the event occurs. Specifies the y-coordinate of the mouse pointer, relative to the control, at the moment when the event occurs.

Localizes the text caption on the button in this control.

First, update a .ini file located in the TestStand Language directory with the required string. Second, use the string tag in the .ini file as the caption for the control. When you call this method, the control replaces the caption with the string from the .ini file. If the caption is not a tag in the .ini file, the caption does not change. Note: When you connect this control to a manager control, the manager control automatically sets a localized caption. Specifies the name of the section in the language files that contains the localized text.

Localizes the text caption on the button in this control.

Call this method to simulate a button click.

Returns a Window handle for the control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns a Window handle for the control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty when you expect the font the Button.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

Specifies how the control scales based on the dots per inch (DPI) setting.

Some environments scale native controls based on the DPI settings of their display, while other environments do not. The TestStand User Interface Controls are designed to work in all environments. The following are the recommended settings for various platforms: * LabVIEW, LabWindows/CVI, C#, and Microsoft Visual Basic .NET—Set this property to False. * Active Template Library (ATL)/Microsoft Foundation Class (MFC)—Set this property to True.

Specifies how the control scales based on the dots per inch (DPI) setting.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

Specifies the appearance of the Button control.

Specifies a custom graphic for the Button control.

Use the Engine.Images property to obtain the TestStand images collection, and use the Images.FindImage method to obtain a particular image reference. Icon files are located in the <TestStand>\Components\Icons and <TestStand Public>\Components\Icons directories.

Specifies a custom graphic for the Button control.

Specifies the horizontal and vertical alignment of text on a Button control.

Specifies the horizontal and vertical alignment of an image on a Button control.

Specifies how to display the image in relation to the text on the Button control.

This property has an effect only when the Button.ImageAlignment and Button.TextAlignment properties are set to the same value. When the values are different, TestStand ignores the Button.TextImageRelation property.

Specifies how to display the image in relation to the text on the Button control.

Specifies whether the button displays an image.

Specifies whether the button displays a text label.

Specifies the background color for the Button control.

When you set the Button.Style property to ButtonStyle_ToolBar, this setting applies to the face and border of the button. When you set the Button.Style property to ButtonStyle_Standard, the button face adheres to the system settings, and this setting affects only the border of the button.

Specifies the background color for the Button control.

Specifies the text color for the Button control.

Use the Button.BackColor property to change the face and border color of the control.

Specifies the text color for the Button control.

Use the Button.BackColor property to change the face and border color of the control.

Specifies how the button behaves when you click it.

Specifies the tooltip for the Button control. When this property is an empty string, the Button control uses the Button.Caption property for the tooltip.

The button interprets the character that follows an ampersand (&) character in the Button.Caption property as an accelerator character when this property is True.

The control uses the color the Button.MaskColor property specifies as a mask color when this property is True. You can use the mask color to create transparent regions.

This property is used only when the button displays an image.

The control uses the color the Button.MaskColor property specifies as a mask color when this property is True. You can use the mask color to create transparent regions.

This property is used only when the button displays an image.

Specifies a color in the picture of the control to use as a mask color when the Button.UseMaskColor property is True. You can use the mask color to create transparent regions.

This property is used only when the button displays an image.

Specifies a color in the picture of the control to use as a mask color when the Button.UseMaskColor property is True. You can use the mask color to create transparent regions.

This property is used only when the button displays an image.

Use an ExpressionEdit control so users can edit a TestStand expression with syntax coloring, popup help, and statement completion. Although you typically do not need to edit expressions in a user interface application, you can connect a manager control to a read-only ExpressionEdit control to display text information about the application state, such as the pathname of the sequence file selection or the name of the current user. You can also use ExpressionEdit controls in dialog boxes for step types and in tools in which you prompt users to enter a TestStand expression.

Specifies the format string that the ExpressionEdit control uses to calculate the formatted value of the text when the ExpressionEdit.DisplayFormattedValue property is True. Assign any string to this property that you would pass as the formatString parameter in the PropertyObject.GetFormattedValue method.

Returns a copy of the additional constants you passed to the ExpressionEdit.SetAdditionalEvaluationConstants method.

Use this method to specify additional constants that the expression can contain that are not part of the Context. The ExpressionEdit control does not consider an identifier that has the same name as one of these constants as an error.

This method is useful when the expression can contain a constant from an enumeration, such as a parameter value of a module call when the type of that parameter is an enumeration. Specifies variables that are valid in the expression but are not part of the context. For example, include a numeric or string PropertyObject where the name and value of the object are the name and value of the enumeration or constant. The control ignores subproperties of the object.

Occurs just before the ExpressionEdit control displays its context menu. Use this event to add or remove items from the context menu of the ExpressionEdit control.

The ExpressionEdit control creates a new context menu every time it displays its context menu to the user. Specifies the Microsoft Windows menu handle (HMENU) of the context menu. Use menu functions in the Windows Software Development Kit to modify this menu. Use the ExpressionEdit.ContextMenuItemClick event to respond to the user clicking menu items you add. When the context menu closes, the control disposes of the menu items. Thus, you do not need to dispose of menu items you insert. Specifies where the left edge of the context menu is visible, relative to the control. Specifies where the top edge of the context menu is visible, relative to the control.

Occurs when the user selects a menu item from the ExpressionEdit control context menu.

Specifies the menu item ID of the menu item the user selects.

Occurs when the ExpressionEdit.Context property changes.

Specifies how the ExpressionEdit.Context property changed.

Occurs when the control checks the expression for errors.

The initial values of the event parameters indicate whether the control detected an error in the expression. Use the event to evaluate, modify, or ignore the error or to perform and report additional expression checking on the expression. Specifies the error code for an error that exists in the expression. Specifies the error description for an error that exists in the expression. Specifies the starting index of the error when an error exists in the expression. Specifies one character past the ending index of the error when an error exists in the expression.

Specifies a reference to the Engine object. The ExpressionEdit control uses the Engine object for the following purposes: * Displaying the Expression Browser dialog box. * Displaying the Expression Editing Options dialog box, which you can access through the Options item in the context menu of the ExpressionEdit control. * Reading options configured in the Expression Editing Options dialog box.

You do not need to set this property because the ExpressionEdit control automatically obtains a reference to an Engine object when a reference is needed. However, because the ExpressionEdit control creates an Engine object when it cannot obtain one from the ExpressionEdit.Context property, it is useful to set this property when the ExpressionEdit.Context property has not been set to a PropertyObject that is also a SequenceContext and when an Engine object has already been created in a different process than the ExpressionEdit control. The TestStand Engine is considered needed when the ExpressionEdit.Context property is set or when this property is read, even when the property is read internally to launch an engine dialog box.

Specifies the set of available variables and properties for autocompletion, error checking, evaluation, and the Expression Browser dialog box. Set this property to a PropertyObject in which the expression you are editing can be evaluated.

The ExpressionEdit control might create an Engine object when you set the Context to a PropertyObject that is not a SequenceContext. Refer to the ExpressionEdit.Engine property for more information about creating a reference to an Engine object.

Specifies the background color of the ExpressionEdit control.

The control responds to user input only when this property is True.

When this property is True, text selection is hidden when the ExpressionEdit control loses focus. When this property is False, text selection is never hidden.

Returns the Window handle of the ExpressionEdit control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns the Window handle of the ExpressionEdit control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Specifies the maximum number of characters the ExpressionEdit control can contain. When the value of this property is 0, the maximum number of characters is 64,000. You can specify a number greater than 64,000.

Displays the specified picture as the cursor for the ExpressionEdit control.

The value of the ExpressionEdit.MousePointer property must be MousePointer_Custom for you to use the ExpressionEdit.MouseIcon property. When you set this property to NULL, the value of the ExpressionEdit.MousePointer property changes to MousePointer_Default.

Displays the specified picture as the cursor for the ExpressionEdit control.

Specifies the appearance of the mouse cursor when the cursor is over the control.

When the parameter is MousePointer_Custom, the mouse cursor is the picture the ExpressionEdit.MouseIcon property specifies.

Specifies the appearance of the mouse cursor when the cursor is over the control.

When the parameter is MousePointer_Custom, the mouse cursor is the picture the ExpressionEdit.MouseIcon property specifies.

Specifies whether the ExpressionEdit control is a multi-line or single-line control.

Specifies which scrollbars are visible in the ExpressionEdit control.

Specifies the number of characters in the current selection.

Specifies the zero-based index of the starting character for the current selection.

Use this property to obtain or replace the currently selected text.

This property is a portion of the displayed text which is a localized expression.

Use this property to obtain or replace the currently selected text.

This property is a portion of the displayed text which is a localized expression.

Specifies a delocalized expression for the text in the ExpressionEdit control. The value of the ExpressionEdit.DisplayText property updates when you set this property.

When the ExpressionEdit.TextType property is TextType_PlainText, this property specifies the actual text in the ExpressionEdit control rather than a delocalized version of the text. Refer to the Engine.LocalizeExpression and Engine.DelocalizeExpression methods for more information about localized and delocalized expressions.

Specifies a delocalized expression for the text in the ExpressionEdit control. The value of the ExpressionEdit.DisplayText property updates when you set this property.

Returns the number of characters in the ExpressionEdit control text.

Specifies whether the ExpressionEdit control processes the <Enter> key. When the ExpressionEdit control is not processing the <Enter> key, the <Enter> key goes to the default button. * When the value of this property is BooleanOrPreference_False, the <Enter> key goes to the default button. * When the value of this property is BooleanOrPreference_True, the control applies the <Enter> key to the expression. * When the value of this property is BooleanOrPreference_UsePreference, the Want Return option in the Expression Editing Options dialog box determines the setting.

If the ExpressionEdit.Multiline property is False, this property is ignored and the <Enter> key is never processed.

Specifies that lines too long to display on one line wrap to the next line. * When the value of this property is BooleanOrPreference_False, word wrap is off. * When the value of this property is BooleanOrPreference_True, word wrap is on. * When the value of this property is BooleanOrPreference_UsePreference, the Word Wrap option in the Expression Editing Options dialog box determines whether word wrap is on.

When the ExpressionEdit.Multiline property is False, this property is ignored.

Specifies the current font for the ExpressionEdit control when the value of the ExpressionEdit.FontSource property is FontSource_UseFontProperty.

Only the font name and size are used. All other properties of this parameter are ignored because those properties are set on a per-text element basis in the Expression Editing Options dialog box, which you can access through the Options item from the context menu of the ExpressionEdit control.

Specifies the current font for the ExpressionEdit control when the value of the ExpressionEdit.FontSource property is FontSource_UseFontProperty.

Returns the Window handle of the function tip.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns the Window handle of the function tip.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns the Window handle of the autocompletion listbox.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns the Window handle of the autocompletion listbox.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

TestStand returns an error for an empty expression only when this property is False.

The ExpressionEdit control displays the text "<The expression cannot be empty>" when this property is False, the control contains an empty expression, the control is not active, and error checking is enabled.

TestStand returns an error for an empty expression only when this property is False.

Specifies whether the control performs error checking on the expression. When the value of this property is a value other than ErrorCheck_None, the expression is checked for errors when the ExpressionEdit control loses focus, when you select Check for Errors from the context menu, or when the ExpressionEdit.DisplayError method is called.

When an error is found, the error is displayed in a different font color or style. The error message is displayed in a tooltip.

Note: This property is obsolete. Use the ExpressionEdit.GetValidEvaluationTypes and ExpressionEdit.SetValidEvaluationTypes methods instead.

Specifies any combination of the ValidExpressionTypes constants. Use the bitwise-OR operator to specify more than one valid type. Specifies the allowed evaluation result types when the value of the ExpressionEdit.ErrorCheck property is ErrorCheck_SyntaxAndEvaluation. If the value of this property is ValidExpressionType_NamedType or ValidExpressionType_NamedTypeArray, the named types or named type arrays must be specified using the RequiredNamedTypes property and the RequiredNamedTypeArrays property, respectively.

Note: This property is obsolete. Use the ExpressionEdit.GetValidEvaluationTypes and ExpressionEdit.SetValidEvaluationTypes methods instead.

Returns a collection of strings that specify the named types that are allowed when the value of the ExpressionEdit.RequiredTypes property is ValidExpressionType_NamedType. The ExpressionEdit control highlights the expression as an evaluation error when the expression fails to evaluate to a named type listed in the collection.

Note: This property is obsolete. Use the ExpressionEdit.GetValidEvaluationTypes and ExpressionEdit.SetValidEvaluationTypes methods instead.

Returns a collection of strings that specify the named type arrays allowed when the value of the ExpressionEdit.RequiredTypes property is ValidExpressionType_NamedTypeArray. The ExpressionEdit control highlights the expression as an evaluation error when the expression fails to evaluate to a named type array listed in the collection.

Note: This property is obsolete. Use the ExpressionEdit.GetValidEvaluationTypes and ExpressionEdit.SetValidEvaluationTypes methods instead.

Returns the result of the error checking the ExpressionEdit.ErrorCheck, ExpressionEdit.SetValidEvaluationTypes, and ExpressionEdit.GetValidEvaluationTypes methods specify.

When you call this method, the ExpressionEdit control might modify the text to automatically prefix variables that do not have a full path specified. Calling this method does not display an error. To display an error, call the ExpressionEdit.DisplayError method. An error code. When an error exists, this parameter returns an error message that describes the error. When an error exists, this parameter returns the starting character index of the error in the expression. When an error exists, this parameter returns the index of one character past the ending character index of the error in the expression.

Returns the result of the error checking the ExpressionEdit.ErrorCheck, ExpressionEdit.SetValidEvaluationTypes, and ExpressionEdit.GetValidEvaluationTypes methods specify.

Performs error checking the ExpressionEdit.ErrorCheck and ExpressionEdit.AllowEmpty properties and the ExpressionEdit.SetValidEvaluationTypes and ExpressionEdit.GetValidEvaluationTypes methods specify. The ExpressionEdit control displays any errors in a different font and displays the error message in a tooltip.

Use this method to force the ExpressionEdit control to check for errors as it does when you select Check for Errors from the ExpressionEdit control context menu. When you call this method, the ExpressionEdit control might modify the text to automatically prefix variables that do not have a full path specified. Specifies a bitwise-OR combination of the DisplayErrorOptions constants.

Evaluates the current expression using the context the ExpressionEdit.Context property specifies.

The result of the evaluation. Pass Eval_NoOptions to specify the default behavior, or pass one or more EvaluationOptions constants. The EvalOption_AllowEmptyExpression constant is ignored. Use the ExpressionEdit.AllowEmpty property to determine whether to treat an empty expression as an error. Use the bitwise-OR operator to specify multiple options.

Evaluates the current expression using the context the ExpressionEdit.Context property specifies.

Selects all the text in the ExpressionEdit control.

Note: This property is obsolete. Use ExpressionEdit.DisplayText instead.

When this property is True, the ExpressionEdit.Text property is a delocalized expression. When this property is False, the ExpressionEdit.Text property is a localized expression. The default value of the property is True.

Note: This property is obsolete. Use ExpressionEdit.DisplayText instead.

Occurs when you press and release the mouse on the control.

Occurs when you double-click the control.

Occurs when the user presses any key while the control has the input focus. This event occurs before the ExpressionEdit.KeyPress event.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user presses a key while a control is active. This event occurs after the ExpressionEdit.KeyDown event.

Specifies the ASCII value of the pressed key.

Occurs when the user releases any key while the control has the input focus.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user clicks the mouse on the control. This event occurs before the ExpressionEdit.MouseUp event.

Occurs when the user moves the mouse over the control.

Occurs when the user releases the mouse on the control. This event occurs before the ExpressionEdit.Click event.

Occurs when the text in the control changes.

Occurs when the current selection changes.

Specifies whether the ExpressionEdit control displays different text elements, such as numbers, strings, and comments, in different colors and styles.

Do not use this property to display text that is not an expression in an ExpressionEdit control. Instead, set the ExpressionEdit.TextType property to TextType_PlainText.

Specifies whether the ExpressionEdit control displays different text elements, such as numbers, strings, and comments, in different colors and styles.

Do not use this property to display text that is not an expression in an ExpressionEdit control. Instead, set the ExpressionEdit.TextType property to TextType_PlainText.

Specifies the title for the Expression Browser dialog box when you call the ExpressionEdit.DisplayBrowseExprDialog method or when you select Browse in the context menu of the ExpressionEdit control. Set this property to an empty string to use the default title for the dialog box.

Specifies the options in the Expression Browser dialog box when you call the ExpressionEdit.DisplayBrowseExprDialog method or when you select Browse from the context menu of the ExpressionEdit control. Use any combination of the BrowseExprDialogOptions constants with this property.

The constant BrowseExpr_UsesCRLF is ignored.

Launches the Expression Browser dialog box. Use the ExpressionEdit.BrowseExprDialogTitle property to customize the title for the dialog box, and use the BrowseExprDialogOptions constants to specify additional options.

Returns True when you click OK in the Expression Browser dialog box. Returns False when you click Cancel.

Specifies that the control can be edited.

Specifies the current font for the ExpressionEdit control. The default value for this property is FontSource_UseGUIFont. When the value of this property is FontSource_UseFontProperty, the ExpressionEdit.Font property specifies the current font.

Only the font name and size are used. All other properties of this parameter are ignored because the other properties are set on a per-text element basis in the Expression Editing Options dialog box, which you can access through the Options item from the context menu of the ExpressionEdit control. When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty when you expect the font the ExpressionEdit.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Use this property to make an ExpressionEdit control behave like an ordinary edit or text box control. This is useful when you want to use an edit control for editing expressions and plain text.

Occurs when you close an Expression Browser dialog box displayed using the Browse menu item in the ExpressionEdit control context menu or the ExpressionEdit.DisplayBrowseExprDialog method.

This parameter is True when you click OK in the Expression Browser dialog box and False when you click Cancel. This parameter is True when a variable or property in the context is created, deleted, or renamed through the context menu in the Expression Browser dialog box while the Expression Browser dialog box is displayed. This parameter is False when the user modifies only the value of a variable or property.

Specifies how the control scales based on the dots per inch (DPI) setting.

Returns the frame and draggable borders that surround the control.

Occurs when the user drags a draggable border of a control with the mouse. The event provides the location and size to which you must set the control for the draggable borders to track the mouse cursor. However, you can choose to modify the location or size to which you set the control. For example, you can limit the width of the control so the left edge cannot be dragged off the visible portion of the window. In addition to changing the size and position of the control, you might also update the sizes and positions of the other controls on the window to account for the change.

If you are using LabVIEW, you must add the Horizontal and Vertical components of the origin of the LabVIEW front panel to the newX and newY event parameter values before you can use the newX and newY event parameters to set the ActiveX Container (AxCont) Left and Top properties for the control. To obtain the origin of a LabVIEW front panel, place an ActiveX property node on the block diagram of the VI, right-click the node, and select Link to»Pane from the context menu. Right-click the node again and select Select Property»Origin. Specifies which borders the user dragged. Refer to the WhichBorders constants for more information about draggable borders. Specifies the new x-coordinate for the control. Specifies the new y-coordinate for the control. Specifies the new width for the control. Specifies the new height for the control. Specifies whether the event is the final event for the drag operation the user performs.

Localizes the ToolTipText and ContextMenuItemCaption properties for each ExpressionEditButton and the DisplayName property of each ExpressionEditComboBoxItem.

First, update a .ini file located in the TestStand Language directory with the required string. Second, use the string tag in the .ini file as the ToolTipText and ContextMenuItemCaption properties of each button and the DisplayName property of each combo box item. When you call this method, the control replaces the ToolTipText and ContextMenuItemCaption properties of each button and the DisplayName property of each combo box item with the string from the .ini file. If the ToolTipText, ContextMenuItemCaption, or DisplayName property is not a tag in the .ini file, the property does not change. Note: This method does not localize the ToolTipText of non-custom buttons. Non-custom buttons localize ToolTipText automatically. Specifies the name of the section in the language files that contains the localized text.

Localizes the ToolTipText and ContextMenuItemCaption properties for each ExpressionEditButton and the DisplayName property of each ExpressionEditComboBoxItem.

Returns a collection of the buttons for the ExpressionEdit control.

Specifies the appearance of the control.

Returns a collection of the items in the drop-down list when the ExpressionEdit control is a combo box.

When this property is True and the text in the ExpressionEdit control corresponds to the value of an item in the drop-down list and the item has a DisplayName, the ExpressionEdit control shows the DisplayName of the item instead of the text when the ExpressionEdit control is inactive.

The ExpressionEdit control uses this property only when the style is ExpressionEditStyle_DropDownCombo.

Returns the Window handle of the drop-down list visible when the ExpressionEdit control is a combo box.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns the Window handle of the drop-down list visible when the ExpressionEdit control is a combo box.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Responds to clicking on a custom button.

This event does not occur when you click on a non-custom button. Specifies the button the user clicked.

Occurs when the list portion of the control is about to drop down.

This event is useful if you want to wait until the list is visible to populate the list with items.

Occurs when the user selects an item in the drop-down list. This event is useful when you do not want the selected item to replace the existing text.

You cannot use this event to change what text to insert into the ExpressionEdit control. Specifies the item to insert into the ExpressionEdit control. Specifies the zero-based index of the character where the selected item is inserted. This parameter is initialized to zero. You can change the value of this parameter to change where the selected item is inserted. Specifies the zero-based index of the last character the selected item replaces. This parameter is initialized to the index of the last character in the ExpressionEdit control. You can change the value of this parameter to change what text the selected item replaces.

Specifies a localized expression for the text in the ExpressionEdit control. The value of the ExpressionEdit.Text property updates when you set this property.

This property specifies the actual text in the ExpressionEdit control. Use this property when you use the ExpressionEdit control with expression strings that are already localized for display. Refer to the Engine.LocalizeExpression and Engine.DelocalizeExpression methods for more information about localized and delocalized expressions.

Specifies a localized expression for the text in the ExpressionEdit control. The value of the ExpressionEdit.Text property updates when you set this property.

Specifies whether the ExpressionEdit control automatically replaces variable names the user types with the full pathname of the variable.

Occurs just before the ExpressionEdit control displays the Expression Browser dialog box. Use this event to override the default parameter values the ExpressionEdit control passes to the Expression Browser dialog box or to cancel displaying the Expression Browser dialog box to the user.

Specifies the title of the Expression Browser dialog box. Assign a value to this parameter to override the default title. Specifies the BrowseExprDialogOptions the ExpressionEdit control passes to the Expression Browser dialog box. Assign a value to this parameter to override the default options. Specifies the zero-based character index where selection begins. Assign a value to this parameter to override the default start of selection. Specifies the zero-based character index where selection ends. Assign a value to this parameter to override the default end of selection. Specifies the name of the initial variable or property to show as selected in the tree view portion of the Expression Browser dialog box. Assign a value to this parameter to override the default initially selected variable. Assign an empty string to this parameter to select the first item. Assign True to this parameter to prevent the ExpressionEdit control from displaying the Expression Browser dialog box to the user.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

When this property is True, the ExpressionEdit control displays the formatted value of a numeric constant you type in a tooltip and replaces the text you type with the formatted value when the ExpressionEdit control loses focus.

Sets the valid evaluation types.

Specifies the expected types for evaluating an expression.

Sets the valid evaluation types.

Specifies the expected types for evaluating an expression.

Obtains the valid evaluation types.

Connect a SequenceFileView Manager or ExecutionView Manager control to a ListBarPage object so users can iterate through the items in the page and set the cursor, caption, and name of the page. Use the ListBarPages.Insert method to create a new ListBarPage object. Use the ListBarPage.Cursor property to determine the selected item in the page. Use the ListBarPage control to connect to and display the ExecutionViewMgrConnections.ExecutionList, ExecutionViewMgrConnections.CallStack, and ExecutionViewMgrConnections.ThreadList properties in the ExecutionView Manager control and the SequenceFileViewMgrConnections.SequenceList, SequenceFileViewMgrConnections.SequenceFileList, and SequenceFileViewMgrConnections.StepGroupList properties in the SequenceFileView Manager control.

Returns a collection of items on the page.

Use this property to obtain a ListBarPageItems collection, which you can use to iterate through all the items on the page.

Specifies the zero-based index of the item the cursor selects.

Use this property to obtain the position of the cursor or move the cursor on the page.

Specifies the name of the ListBarPage.

Every ListBarPage must have a unique name, which can be used to identify the ListBarPage within the ListBarPages collection. ListBarPage names are not case-sensitive.

Returns the numeric zero-based index of the page within the ListBarPages collection.

Specifies the caption text of the page.

Specifies to enable or disable the ListBarPage.

Users cannot move the cursor when the page is disabled.

A collection of ListBarPage objects. Use the ListBar.Pages property to retrieve the ListBarPages object for a ListBar. Use the ListBar.CurrentPage property as an index to this collection to access the currently selected page.

Returns a reference to an item with the specified name or at the specified index in the collection.

You can pass a number to obtain a page by its zero-based index. You can also pass a string to obtain the ListBarPage using its name.

Returns the number of items in the collection.

Adds a new item to the collection and returns a reference to the new ListBarPage.

Specifies the name for the new ListBarPage. ListBarPage names must be unique. ListBarPage names are not case-sensitive. Specifies the index of the existing ListBarPage before which the new ListBarPage is inserted. To insert the new ListBarPage at the end, pass -1 to this parameter.

Removes the specified item from this collection, if it exists.

Pass the zero-based index for the page to remove.

Removes all items from the collection.

Use a ListBar control to display multiple pages, where each page contains a list of items users can view or select. Connect a SequenceFileView Manager or ExecutionView Manager control to a ListBar page so users can view and select from a list, such as the active sequence file or execution. Connect an Application Manager control to a ListBar page so users can view or select the default adapter of the TestStand Engine. You can view the contents of a page by clicking on the page node, and you can also select a single item with the current page. Use the ListBar.CurrentPage property to determine the selected page, and use Pages.Item(CurrentPage).Cursor to determine the selected item on the current page.

Returns a Window handle for the ListBar control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns a Window handle for the ListBar control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Specifies the style of buttons on the ListBar control.

Specifies the font of the button text on ListBar buttons.

Specifies the style of the pages in the ListBar control. This property can be any combination of the ListBarPageStyles constants.

Specifies the font for items on a ListBar page.

Returns a collection of the ListBar pages.

Refer to the ListBarPages object for information about adding, removing, and accessing pages.

Returns a collection of the ListBar pages.

Refer to the ListBarPages object for information about adding, removing, and accessing pages.

Specifies the zero-based index of the current page in the ListBar control.

The current page is the page in the ListBar control that displays the items of the page. Only one page is current in the ListBar control at a time. Use the ListBarPages collection to access a ListBarPage using the page index of the ListBarPage.

Specifies the zero-based index of the current page in the ListBar control.

Returns which item, if any, is at the specified location.

Use this method to determine which item the given coordinates belong to. For example, when a user clicks a control, you might want to determine which item on the current page the user clicked. Returns the index of an item on the current page. When no item exists at the specified location, this method returns -1. Specifies the x-coordinate of the location to test, in pixels, relative to the control. Specifies the y-coordinate of the location to test, in pixels, relative to the control.

Returns which item, if any, is at the specified location.

Specifies the color for the page captions displayed on the buttons in the ListBar control.

Specifies the text color for page items.

Specifies the background color of the ListBar control.

Specifies whether to enable item tooltips. When you set this property to True, tooltips are visible.

Item tooltips are the text you see when you hover over a partially visible item with the mouse. Tooltips allow you to see the full caption of a partially visible item.

Specifies whether to enable item tooltips. When you set this property to True, tooltips are visible.

Item tooltips are the text you see when you hover over a partially visible item with the mouse. Tooltips allow you to see the full caption of a partially visible item.

Occurs when the user selects a new item in the current page.

Specifies the index of the element that became the cursor.

Occurs when you select a new current page.

Specifies the index of the selected page in ListBarPages.

Occurs when the user presses a key while the ListBar control has focus.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user moves the mouse over the control.

Occurs when the user clicks the mouse on the control.

When this property is True, the ListBar buttons display the number of items in each page, in addition to the page captions.

Localizes the captions of all pages.

First, update a .ini file located in the TestStand Language directory with the required string. Second, use the string tag in the .ini file as the caption for the control. When you call this method, the control replaces the caption with the string from the .ini file. If the caption is not a tag in the .ini file, the caption does not change. Note: When you connect a page to a manager control, the manager control automatically sets a localized page caption. Specifies the name of the section in the language files that contains the localized text.

Localizes the captions of all pages.

First, update a .ini file located in the TestStand Language directory with the required string. Second, use the string tag in the .ini file as the caption for the control. When you call this method, the control replaces the caption with the string from the .ini file. If the caption is not a tag in the .ini file, the caption does not change. Note: When you connect a page to a manager control, the manager control automatically sets a localized page caption. Specifies the name of the section in the language files that contains the localized text.

Specifies the size of icons in the ListBar control.

Icons are always square. For example, when you specify an icon size of 32, the dimensions of the icon are 32 × 32 pixels.

Specifies the size of icons in the ListBar control.

Icons are always square. For example, when you specify an icon size of 32, the dimensions of the icon are 32 × 32 pixels.

Occurs when the user double-clicks the left mouse button.

Specifies whether to display a vertical scrollbar on the ListBarPage portion of the ListBar control when not enough room exists vertically to display all items in a ListBarPage.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty if you expect the font the ListBar.ButtonFont property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty if you expect the font the ListBar.ButtonFont property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the ListBar control uses to display text on the page. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty when you expect the font the ListBar.PageFont property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the ListBar control uses to display text on the page. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty when you expect the font the ListBar.PageFont property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies how the control scales based on the dots per inch (DPI) setting.

Occurs when the user right-clicks the control so the application can build a context menu from which the user can select commands. Although you can implement context menus in most environments without using this event, some environments do not provide any other way to create a context menu. Also, creating a context menu using this event can be simpler in most environments, especially when the context menu contains only TestStand commands.

Specifies the Microsoft Windows menu handle (HMENU). When you add menu items to the menu handle, the control displays them in a context menu. Use the Commands.InsertIntoWin32Menu method to insert TestStand commands to the menu. You can also use the menu functions in the Windows Software Development Kit (SDK) to add other menu items. Menu items you add this way do not have an associated TestStand command. When the user selects an item that does not have a TestStand command, the control creates and executes a Command object of kind CommandKind_Custom. The control stores the menu item identifier (resource ID/command ID) as a long in the Command.UserData property and as a decimal string in the command display name. You can handle either the ApplicationMgr.PreCommandExecute or ApplicationMgr.PostCommandExecute event to receive a notification when the user selects a menu item you insert with the Windows SDK. When the context menu closes, the control disposes of the menu items. Thus, you do not need to dispose of menu items you insert. Specifies the horizontal position of the right-mouse click, relative to the control. Specifies the vertical position of the right-mouse click, relative to the control.

Returns the frame and draggable borders that surround the control.

Occurs when the user drags a draggable border of a control with the mouse. The event provides the location and size to which you must set the control for the draggable borders to track the mouse cursor. However, you can choose to modify the location or size to which you set the control. For example, you can limit the width of the control so the left edge cannot be dragged off of the visible portion of the window. In addition to changing the size and position of the control, you might also update the sizes and positions of the other controls on the window to account for the change.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change. Specifies the index of the ListBarPage to which the connection made a change.

Represents a status bar pane.

Specifies the width for the pane in pixels.

When you set the StatusBarPane.UseAvailableSpace property to True, the specified width of the pane is ignored when the StatusBar pane is the leftmost visible StatusBar pane with a True value for the StatusBarPane.UseAvailableSpace property.

Specifies the tooltip for a status bar pane. When this property is an empty string, the pane uses the StatusBarPane.Caption property for the tooltip.

Specifies the name for the pane.

Every pane must have a unique name, which can be used to identify the pane within the StatusBarPanes collection. Pane names are not case-sensitive.

Specifies the appearance of the pane.

A StatusBar pane can have only one style.

Specifies a number between 0 and 100 to determine the progress for the StatusBar pane. The StatusBar pane uses this number to draw a progress bar.

You can combine a caption, image, and progress bar on the same StatusBar pane. Set ProcessPercent to 0 when you do not want the StatusBar pane to contain a progress bar. Note: When a StatusBar pane is connected to a numeric source of a manager control, you cannot change the process percent.

Specifies the caption for the StatusBar pane.

You can display a caption and progress bar on the same StatusBar pane. Note: When you connect a StatusBar pane to the caption source of a manager control, you cannot change the caption. When you connect a StatusBar pane to the image source of a manager control, the caption does not display when you display an image. Additionally, the caption does not display when you use the StatusBarPane.IconName property to specify a valid icon.

Returns the zero-based index of the pane in the StatusBarPanes collection.

Specifies the alignment of the caption text.

This method also applies to images when the StatusBar control is used to display images.

Specifies whether the StatusBar pane is visible.

Specifies an icon for the StatusBar pane.

TestStand User Interface Controls use icons from the <TestStand>\Components\Icons and <TestStand Public>\Components\Icons directories. To specify an icon for a StatusBar pane, pass the name of the .ico file to this property. Note: When a StatusBar pane is connected to an image source of a manager control, you cannot change the icon.

Set this property to True when you want a StatusBar pane to occupy all available space in the status bar not used by other panes. This property enables a pane to adjust to make full use of the available space when the status bar changes size.

Although you can have more than one StatusBar pane with a value of True for this property, only the leftmost visible StatusBar pane honors this setting.

A collection of StatusBarPane objects.

Returns a reference to an item with the specified name or at the specified index in the collection.

Specifies a number to obtain a StatusBar pane by the zero-based index. Pass a string to obtain the StatusBar pane using the name.

Returns the number of items in the collection.

Adds a new item to the collection and returns the new StatusBarPane object.

Specifies the new StatusBar pane. Specifies the name of the new StatusBar pane. This name must be unique and is not case-sensitive. Specifies the index of the existing StatusBar pane before which the new StatusBar pane is inserted. To insert at the end, pass -1 to this parameter.

Removes all items from the collection.

Removes the specified item from this collection, if it exists.

Specifies a number to remove a StatusBar pane by the zero-based index. Pass a string to remove a StatusBar pane using the name.

Connect a manager control to panes of a StatusBar control to display text, image, or progress information about the application state. You can programmatically control individual StatusBar panes to display custom information. You can connect the panes to CaptionSources, NumericSources, and ImageSources on the Application Manager, ExecutionView Manager, and SequenceFileView Manager controls.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

Returns the StatusBarPanes collection.

Specifies the font for the control when the value of the StatusBar.FontSource property is FontSource_UseFontProperty.

Specifies whether the control places the status bar on the bottom of the parent window, auto-sizes the height of the status bar, and adjusts to match the width of the parent window at run time.

Note: This property has no effect when you edit a form at design time in any development environment.

Specifies whether the control places the status bar on the bottom of the parent window, auto-sizes the height of the status bar, and adjusts to match the width of the parent window at run time.

Note: This property has no effect when you edit a form at design time in any development environment.

Specifies whether the StatusBar control displays a horizontal line as the top border.

When the application supports themes using Microsoft Windows XP, this property has no visual effect.

Specifies whether the StatusBar control displays a horizontal line as the top border.

When the application supports themes using Microsoft Windows XP, this property has no visual effect.

Returns the Window handle of the StatusBar control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns the Window handle of the StatusBar control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Localizes all the text captions in the StatusBar control.

First, update a .ini file located in the <TestStand Public>\Components\Language directory with the required strings. Second, use the string tags in the .ini file as the pane captions for the control. When you call this method, the control replaces the pane captions with the strings from the .ini file. If a caption is not a tag in the .ini file, the caption does not change. Note: When you connect a pane to a manager control, the manager control automatically sets a localized caption. Specifies the name of the section in the language files that contains the localized text.

Localizes all the text captions in the StatusBar control.

Returns the index of the pane at the given coordinates.

Use this method to determine the item to which the given coordinates belong. For example, when a user clicks on the control, you might want to determine the item the user clicked. Returns a zero-based item index. You can use this value to retrieve a StatusBarPane object from the StatusBarPanes collection. This method returns -1 when the location is not on a pane. Specifies the x-coordinate of the location to test, in pixels, relative to the control. Specifies the y-coordinate of the location to test, in pixels, relative to the control.

Returns the index of the pane at the given coordinates.

Occurs when the user clicks the mouse on the control.

Specifies the mouse button pressed to cause this event. You can use any one of the MouseButtons constants. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys. Specifies the x-coordinate of the mouse pointer, relative to the control, at the moment when the event occurs.. Specifies the y-coordinate of the mouse pointer, relative to the control, at the moment when the event occurs.

Occurs when the user moves the mouse over the control.

Occurs when the user clicks the mouse on the control.

Occurs when the user double-clicks the mouse over the control.

Use the StatusBar.HitTest event to determine whether the user double-clicked the mouse on a pane.

Shows the list of panes and hides any panes not in the list.

Use this method to switch between sets of visible panes. Specifies a comma-separated list of pane names. For example, "pane1, pane2, pane3".

Shows the list of panes and hides any panes not in the list.

Use this method to switch between sets of visible panes. Specifies a comma-separated list of pane names. For example, "pane1, pane2, pane3".

Specifies to enable the resizing grip on the bottom right corner of the control.

Note: Enable this property only when the window on which you place the StatusBar control is resizable and when the StatusBar.AutoSize property is True.

Specifies to enable the resizing grip on the bottom right corner of the control.

Note: Enable this property only when the window on which you place the StatusBar control is resizable and when the StatusBar.AutoSize property is True.

Specifies the size of the icons in the control.

Icons are always square. For example, when you specify an icon size of 32, the dimensions of the icons in the status bar are 32 × 32 pixels.

Specifies the size of the icons in the control.

Icons are always square. For example, when you specify an icon size of 32, the dimensions of the icons in the status bar are 32 × 32 pixels.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Set this property to a value other than FontSource_UseFontProperty if you expect the font the StatusBar.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Set this property to a value other than FontSource_UseFontProperty if you expect the font the StatusBar.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Occurs when a status bar is resized. This occurs only when you set the StatusBar.AutoSize property to True and resize the parent window.

Specifies the new width of the status bar, in pixels. Specifies the new height of the status bar, in pixels.

Specifies how the control scales based on the dots per inch (DPI) setting.

Connect a SequenceFileView Manager or ExecutionView Manager control to a ComboBox control so users can view or select from a list of sequence files, sequences, step groups, steps, executions, threads, or stack frames. Connect an Application Manager control to a ComboBox control so users can view or select the default adapter of the TestStand Engine. Use the ComboBox control to connect to and display the ExecutionViewMgrConnections.ExecutionList, ExecutionViewMgrConnections.CallStack, and ExecutionViewMgrConnections.ThreadList properties in the ExecutionView Manager control and the SequenceFileViewMgrConnections.SequenceList, SequenceFileViewMgrConnections.SequenceFileList, and SequenceFileViewMgrConnections.StepGroupList properties in the SequenceFileView Manager control. Selecting an item in the ComboBox control updates the application based on the type of data the connection specifies. Note: The ComboBox control does not allow you to populate the items in the drop-down list without connecting to a list connection. The items in the drop-down list are obtained from the connection to a manager control.

Specifies the size, in pixels, of the icon displayed in the control.

The value of this property cannot be less than 1 or greater than 96. Icons are always square. For example, when you specify an icon size of 32, the dimensions of the icon are 32 × 32 pixels.

Specifies the size, in pixels, of the icon displayed in the control.

The value of this property cannot be less than 1 or greater than 96. Icons are always square. For example, when you specify an icon size of 32, the dimensions of the icon are 32 × 32 pixels.

The control responds to user input only when this property is True.

Specifies the appearance of the mouse cursor when the cursor is over the control.

When the parameter is MousePointer_Custom, the mouse cursor is the picture the ComboBox.MouseIcon property specifies.

Specifies the appearance of the mouse cursor when the cursor is over the control.

When the parameter is MousePointer_Custom, the mouse cursor is the picture the ComboBox.MouseIcon property specifies.

Specifies a custom mouse icon for the control.

The control displays the specified picture as the cursor when the value of the ComboBox.MousePointer property is MousePointer_Custom. When you set this property to NULL, the value of the ComboBox.MousePointer property changes to MousePointer_Default. Note: This property requires that the picture value is an icon.

Specifies a custom mouse icon for the control.

Specifies the font for the control when the value of the ComboBox.FontSource property is FontSource_UseFontProperty.

Specifies the zero-based index of the currently selected item in the control.

A value of -1 indicates no item is currently selected, or the user entered a new value not in the list.

Specifies the zero-based index of the currently selected item in the control.

A value of -1 indicates no item is currently selected, or the user entered a new value not in the list.

Specifies the maximum height of the edit box and drop-down list.

When the total height of all the items in the drop-down list exceeds the value of this property, the drop-down list uses a vertical scrollbar. This value cannot be less than 100 pixels.

Specifies the maximum height of the edit box and drop-down list.

When the total height of all the items in the drop-down list exceeds the value of this property, the drop-down list uses a vertical scrollbar. This value cannot be less than 100 pixels.

Specifies the appearance of the control.

Occurs when you press and release the mouse on the control.

Occurs when the user presses a key while the control has input focus. This event occurs before the ComboBox.KeyPress event.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user presses a key while a control is active. This event occurs after the ComboBox.KeyDown event.

Specifies the ASCII value of the pressed key.

Occurs when the user releases a key while the control has input focus.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the contents of a control change.

Specifies whether the control can be edited.

Occurs when the list portion of the control is about to drop down. Note: The ComboBox control does not allow you to populate the items in the drop-down list.

Returns a Window handle for the control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns a Window handle for the control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty when you expect the font the ComboBox.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty when you expect the font the ComboBox.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Returns the number of items in the ComboBox.

Specifies how the control scales based on the dots per inch (DPI) setting.

Some environments scale native controls based on the DPI settings of their display, while other environments do not. The TestStand User Interface controls are designed to work in all environments. The following are the recommended settings for various platforms: * LabVIEW, LabWindows/CVI, C#, and Microsoft Visual Basic .NET—Set this property to False. * Active Template Library (ATL)/Microsoft Foundation Class (MFC)—Set this property to True.

Specifies how the control scales based on the dots per inch (DPI) setting.

Returns the text of the item at a specified index.

Specifies the zero-based index of the item to retrieve. Pass -1 to obtain the text of the currently selected item.

Returns the text of the item at a specified index.

Specifies the zero-based index of the item to retrieve. Pass -1 to obtain the text of the currently selected item.

Specifies whether the control shows images.

The edit box does not show images when the style is ComboBoxStyle_DropDownCombo.

Specifies whether the control shows images.

The edit box does not show images when the style is ComboBoxStyle_DropDownCombo.

Specifies whether the control shows tooltips.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

Use these constants with the ExpressionEdit.ErrorCheck property.

(Value: 0) No error checking.

(Value: 1) Checks only for syntax errors.

(Value: 2) Checks for syntax and evaluation errors.

Use these constants with the ExpressionEdit.GetValidEvaluationTypes, and ExpressionEdit.SetValidEvaluationTypes methods. Use the bitwise-OR operator to specify more than one option.

(Value: -1) All expression types are valid.

(Value: 0x1) Only Boolean expression types are valid.

(Value: 0x2) Only number expression types are valid.

(Value: 0x4) Only string expression types are valid.

(Value: 0x8) Only reference expression types are valid.

(Value: 0x10) Only container expression types are valid.

(Value: 0x20) Only named type expression types are valid.

(Value: 0x40) Only Boolean array expression types are valid.

(Value: 0x80) Only number array expression types are valid.

(Value: 0x100) Only string array expression types are valid.

(Value: 0x200) Only reference array expression types are valid.

(Value: 0x400) Only container array expression types are valid.

(Value: 0x800) Only named type array expression types are valid.

(0x20000) Only enum expression types are valid.

(Value: 0x4000) Any expression type that is not an element of an array of a basic type is valid.

(Value: 0x8000) Only the reference expression type when it is not a named type is valid.

(Value: 0x10000) Only the container expression type when it is not a named type is valid.

Use these constants with the ExpressionEdit.ScrollBars property.

(Value: 0) Does not show the horizontal or vertical scrollbars.

(Value: 1) Shows the horizontal and vertical scrollbars.

(Value: 2) Shows only the horizontal scrollbar.

(Value: 3) Shows only the vertical scrollbar.

Use these constants with the ListBar.ButtonStyle property to specify the style of the button.

(Value: 1) The button style is three-dimensional.

(Value: 2) The button style is flat.

Use these constants with the ListBar.PageStyle property. Use the bitwise-OR operator to specify more than one option.

(Value: 0x2) Items on the ListBar page that the mouse hovers over are highlighted.

(Value: 0x4) Items on the ListBar page draw icons above the text.

(Value: 0x1) When set, a frame surrounds the selected item. When not set, the control highlights the text of the selected item.

Use these constants with the SeqViewColumn.Type property to define what type of information is displayed for each step in the column.

(Value: 1) Name of the step.

(Value: 2) Index of the step.

(Value: 3) Description of the step.

(Value: 4) Execution flow of the step.

(Value: 5) Status of the step.

(Value: 6) Custom Expression. Use the SeqViewColumn.Expression property to specify an expression for the column.

(Value: 7) Comment for the step.

(Value: 8) Requirements of the step.

(Value: 4) A summary of the settings for the step.

Use these constants with the ReportView.ToolBarTextStyle property.

(Value: 0) Text for toolbar buttons displays below button icons.

(Value: 1) Text for the toolbar buttons displays to the right of button icons.

(Value: 2) Toolbar buttons do not have text.

Use these constants with the ReportView.ButtonsVisible property.

(Value: 0x1) Use this button to navigate to previously viewed reports.

(Value: 0x2) Use this button to navigate to previously viewed reports.

(Value: 0x4) Use this button to stop the ReportView control from displaying the current report.

(Value: 0x8) Use this button to refresh the currently displayed report.

(Value: 0x10) Use this button to navigate to the first report opened in the ReportView control.

(Value: 0x20) Use this button to open an external viewer for this kind of report.

(Value: 0x40) Use this button to print the currently displayed report. You can configure the Print button to launch the Print dialog box before printing on the General property page of the ReportView control.

(Value: 0x80) Use this button to change the size of the HTML text displayed. Note: This size is a global setting for the computer and affects the size of text in the web browser when you are using Microsoft Internet Explorer.

(Value: 256) Use this button to change the active report in the Reports collection of an execution. The ReportView control displays the current active report. This button is disabled if the Reports collection is empty.

Use these constants with the StatusBarPane.Style property.

(Value: 1) The pane has an etched border, with a sunken outer edge and a raised inner edge.

(Value: 2) The pane is flat and has no border.

(Value: 3) The pane has a raised border.

Use these constants with the ComboBox.Style property.

(Value: 0) Includes a drop-down list and an edit box. You can select from the list or type in the edit box.

(Value: 2) Allows selection only from the drop-down list.

Use these constants to specify the text alignment of the Label and StatusBarPane controls.

(Value: 0) Text is left-aligned.

(Value: 1) Text is right-aligned.

(Value: 2) Text is centered.

Use these constants with Label.BorderStyle to specify the border style of the control.

(Value: 1) Specifies that the control draws a three-dimensional border.

(Value: 0) Specifies that the control does not draw a border.

(Value: 2) Specifies that the control draws a single-line border.

Use these constants with the Button.MousePointer, ComboBox.MousePointer, ExpressionEdit.MousePointer, Label.MousePointer, and ListBox.MousePointer properties.

(Value: 0)

(Value: 1)

(Value: 2)

(Value: 3)

(Value: 4)

(Value: 5)

(Value: 6)

(Value: 7)

(Value: 8)

(Value: 9)

(Value: 10)

(Value: 11)

(Value: 12)

(Value: 13)

(Value: 99)

Use these constants with the Command.ShortcutModifier, ExpressionEditButton.ShortcutModifier, and ApplicationMgr.EditModeShortcutModifier properties.

(Value: 0x0) No modifier keys are available.

(Value: 0x2) The <Ctrl> key.

(Value: 0x1) The <Shift> key.

(Value: 0x4) The <Alt> key.

Use these constants with the Command.ShortcutKey, ExpressionEditButton.ShortcutKey, and ApplicationMgr.EditModeShortcutKey properties.

(Value: 0x52) The R key.

(Value: 0x53) The S key.

(Value: 0x54) The T key.

(Value: 0x55) The U key.

(Value: 0x56) The V key.

(Value: 0x57) The W key.

(Value: 0x58) The X key.

(Value: 0x59) The Y key.

(Value: 0x5A) The Z key.

(Value: 0x60) The numeric keypad 0 key.

(Value: 0x61) The numeric keypad 1 key.

(Value: 0x62) The numeric keypad 2 key.

(Value: 0x63) The numeric keypad 3 key.

(Value: 0x64) The numeric keypad 4 key.

(Value: 0x65) The numeric keypad 5 key.

(Value: 0x66) The numeric keypad 6 key.

(Value: 0x67) The numeric keypad 7 key.

(Value: 0x68) The numeric keypad 8 key.

(Value: 0x69) The numeric keypad 9 key.

(Value: 0x6A) The Multiply key.

(Value: 0x6B) The Add key.

(Value: 0x6C) The Separator key.

(Value: 0x6D) The Subtract key.

(Value: 0x6E) The Decimal key.

(Value: 0x6F) The Divide key.

(Value: 0x70) The F1 key.

(Value: 0x71) The F2 key.

(Value: 0x72) The F3 key.

(Value: 0x73) The F4 key.

(Value: 0x74) The F5 key.

(Value: 10x75) The F6 key.

(Value: 0x76)The F7 key.

(Value: 0x77) The F8 key.

(Value: 0x78) The F9 key.

(Value: 0x79) The F10 key.

(Value: 0x7A) The F11 key.

(Value: 0x7B) The F12 key.

(Value: 0x7C) The F13 key.

(Value: 0x7D) The F14 key.

(Value: 0x7E) The F15 key.

(Value: 0x7F) The F16 key.

(Value: 0x80) The F17 key.

(Value: 0x81) The F18 key.

(Value: 0x82) The F19 key.

(Value: 0x83) The F20 key.

(Value: 0x84) The F21 key.

(Value: 0x85) The F22 key.

(Value: 0x86) The F23 key.

(Value: 0x87) The F24 key.

(Value: 0x00)

(Value: 0x08) The Backspace key.

(Value: 0x09) The <Tab> key.

(Value: 0x0D) The Enter key.

(Value: 0x1B) The Escape key.

(Value: 0x20) The Space key.

(Value: 0x23) The End key.

(Value: 0x24) The Home key.

(Value: 0x25) The Left Arrow key.

(Value: 0x26) The Up Arrow key.

(Value: 0x27) The Right Arrow key.

(Value: 0x28) The Down Arrow key.

(Value: 0x2D) The Insert key.

(Value: 0x2E) The Delete key.

(Value: 0x30) The 0 key.

(Value: 0x31) The 1 key.

(Value: 0x32) The 2 key.

(Value: 0x33) The 3 key.

(Value: 0x34) The 4 key.

(Value: 0x35) The 5 key.

(Value: 0x36) The 6 key.

(Value: 0x37) The 7 key.

(Value: 0x38) The 8 key.

(Value: 0x39) The 9 key.

(Value: 0x41) The A key.

(Value: 0x42) The B key.

(Value: 0x43) The C key.

(Value: 0x44) The D key.

(Value: 0x45) The E key.

(Value: 0x46) The F key.

(Value: 0x47) The G key.

(Value: 0x48) The H key.

(Value: 0x49) The I key.

(Value: 0x4A) The J key.

(Value: 0x4B) The K key.

(Value: 0x4C) The L key.

(Value: 0x4D) The M key.

(Value: 0x4E) The N key.

(Value: 0x4F) The O key.

(Value: 0x50) The P key.

(Value: 0x51) The Q key.

Use these constants with the Button.AutoSizing property.

(Value: 0) Always resize the Button control to fit the text.

(Value: 1) Resize the Button control only when the text does not fit in the control.

(Value: 2) Resize the Button control only when the text is smaller than the button.

(Value: 3) Never resize the Button control.

Use these constants with the ApplicationMgr.ReloadSequenceFilesOnStart property.

(Value: 0) Does not reload any files.

(Value: 1) Reloads any file selected in a SequenceFileView Manager control.

(Value: 2) Reloads all files.

Connect a SequenceFileView Manager or ExecutionView Manager control to a ListBox control so users can view or select from a list of sequence files, sequences, step groups, steps, executions, threads, or stack frames. Connect an Application Manager control to a ListBox control so users can view or select the default adapter of the TestStand Engine. Use a ListBox control to display multiple pages, where each page contains a list of items that users can view or select. Use the ListBox control to connect to and display the ExecutionViewMgrConnections.ExecutionList, ExecutionViewMgrConnections.CallStack, and ExecutionViewMgrConnections.ThreadList properties in the ExecutionView Manager control and the SequenceFileViewMgrConnections.SequenceList, SequenceFileViewMgrConnections.SequenceFileList, and SequenceFileViewMgrConnections.StepGroupList properties in the SequenceFileView Manager control. Selecting an item in the ListBox control updates the application according to the type of connection.

Returns the number of items in the listbox.

Returns the index of the item at the given coordinates. Returns -1 when no item exists at the specified coordinates.

Use this method to determine the item at the given coordinates. For example, when a user clicks on the control, you can determine the item the user clicked. Returns a numeric item index. Specifies the x-coordinate of the location to test, in pixels, relative to the control. Specifies the y-coordinate of the location to test, in pixels, relative to the control.

Returns the index of the item at the given coordinates. Returns -1 when no item exists at the specified coordinates.

Specifies the types of editing the listbox allows. Use any combination of the EditingFlags constants with this property.

By default, TestStand allows all editing types. These flags have no effect if the listbox is not connected to display editable items.

Specifies the types of editing the listbox allows. Use any combination of the EditingFlags constants with this property.

By default, TestStand allows all editing types. These flags have no effect if the listbox is not connected to display editable items.

The control responds to user input only when this property is True.

Specifies the appearance of the mouse cursor when the cursor is over the control.

When the parameter is MousePointer_Custom, the mouse cursor is the picture the ListBox.MouseIcon property specifies.

Specifies the appearance of the mouse cursor when the cursor is over the control.

When the parameter is MousePointer_Custom, the mouse cursor is the picture the ListBox.MouseIcon property specifies.

Specifies a custom mouse pointer icon for the control.

The control displays the specified picture as the cursor when the value of the ListBox.MousePointer property is MousePointer_Custom. When you set this property to NULL, the value of the ListBox.MousePointer property changes to MousePointer_Default. Note: This property requires that the picture value is an icon.

Specifies a custom mouse pointer icon for the control.

Specifies the font for the control when the value of the ListBox.FontSource property is FontSource_UseFontProperty.

Specifies the background color for the control.

Specifies the index of the currently selected item in the control. Note: You cannot change this property at design time.

When no item is selected, the value of this property is -1.

Specifies the index of the currently selected item in the control. Note: You cannot change this property at design time.

When no item is selected, the value of this property is -1.

TestStand 4.0 or later does not support setting this property to create multiple columns. Setting this property has no effect.

Use the ListBox.ColumnSet property to access information about list box columns.

TestStand 4.0 or later does not support setting this property to create multiple columns. Setting this property has no effect.

Use the ListBox.ColumnSet property to access information about list box columns.

Specifies the foreground color for the ListBox control.

Occurs when you press and release the mouse on the control or when the selected item of the control changes.

Occurs when the user presses a key while the control has the input focus. This event occurs before the ListBox.KeyPress event.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user presses a key while a control is active. This event occurs after the ListBox.KeyDown event.

Specifies the ASCII value of the pressed key.

Occurs when the user releases a key while the control has the input focus.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user clicks the mouse on the control.

Occurs when the user moves the mouse over the control.

Occurs when the user releases the mouse on the control.

Returns a Window handle for the ListBox control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns a Window handle for the ListBox control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty if you expect the font the ListBox.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty if you expect the font the ListBox.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies how the control scales based on the dots per inch (DPI) setting.

Returns the text of the item at a specified index.

Specifies the zero-based index of the item to return. Pass the ListBox.ItemIndex property or pass -1 to obtain the text of the currently selected item.

Returns the text of the item at a specified index.

Specifies the zero-based index of the item to return. Pass the ListBox.ItemIndex property or pass -1 to obtain the text of the currently selected item.

Specifies whether the control shows tooltips.

Returns the frame and draggable borders that surround the control.

Occurs when the user drags a draggable border of a control with the mouse. The event provides the location and size to which you must set the control for the draggable borders to track the mouse cursor. However, you can choose to modify the location or size to which you set the control. For example, you can limit the width of the control so the left edge cannot be dragged off of the visible portion of the window. In addition to changing the size and position of the control, you might also update the sizes and positions of the other controls on the window to account for the change.

Returns a value that indicates whether the listbox can enter label-editing mode, in which you can edit the item text in the first column of the listbox.

Enters label-editing mode for the active item in the list. In label-editing mode, you can edit the item text in the first column of the listbox.

The listbox automatically attempts to enter label-edit mode when you click the active item in the first column or when you press <F2> when the listbox has the keyboard focus.

Enters label-editing mode for the active item in the list. In label-editing mode, you can edit the item text in the first column of the listbox.

The listbox automatically attempts to enter label-edit mode when you click the active item in the first column or when you press <F2> when the listbox has the keyboard focus.

Specifies whether the control displays headers for the visible columns.

Occurs when you right-click the control so the application can build a context menu from which you can select commands. Even though you can implement context menus in most environments without using this event, some environments do not provide any other way to create a context menu. Also, creating a context menu using this event is less complicated in most environments, especially when the context menu contains only TestStand commands.

Specifies the Microsoft Windows menu handle (HMENU). When you add menu items to the menu handle, the control displays them in a context menu. Use the Commands.InsertIntoWin32Menu method to insert TestStand commands into the menu. You can also use the menu functions in the Windows Software Development Kit (SDK) to add other menu items; however, these menu items do not have an associated TestStand command. When you select an item without a TestStand command, the control creates and executes a Command object of kind CommandKind_Custom. The control stores the menu item identifier, such as resource ID or command ID, as a long in the Command.UserData property, and as a decimal string in the command display name. You can handle either the ApplicationMgr.PreCommandExecute or ApplicationMgr.PostCommandExecute event to receive a notification when the user selects a menu item you insert with the Windows SDK. When you close the context menu, the control disposes of the menu items. You do not need to dispose of the menu items you insert. Specifies the horizontal position of right-clicking, relative to the control. Specifies the vertical position of right-clicking, relative to the control.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

Occurs when you double-click using the left mouse button.

Returns the list of columns for the control.

Specifies whether to make all columns fit within the width of the control. When the control resizes, the width of each column for which the ListBoxColumn.Autosizing property is a value other than AutoSizingOption_None adjusts so the columns fit the new size of the control. You must ensure that at least one column enables autosizing when you set this property to True.

When this property is True, the sum of all column widths always equals the width of the control, and the horizontal scrollbar is not visible. When this property is False, you can resize the columns to any width, and the horizontal scrollbar appears as needed. When the value of the autosize property for each column is AutoSizingOption_None, the last column is autosized to fit the width of the control.

Occurs when one or more columns resize in the control.

Connect a manager control to a Label control to display text information about the application state in the label, such as the name of the current user or the status of the current unit under test.

When this property is False, the caption text dims.

Specifies the appearance of the mouse cursor when the cursor is over the control.

When the parameter is MousePointer_Custom, the mouse cursor is the picture the Label.MouseIcon property specifies.

Specifies the appearance of the mouse cursor when the cursor is over the control.

When the parameter is MousePointer_Custom, the mouse cursor is the picture the Label.MouseIcon property specifies.

Specifies a custom mouse icon for the control.

The control displays the specified picture as the cursor when the value of the Label.MousePointer property is MousePointer_Custom. When you set this property to NULL, the value of the Label.MousePointer property changes to MousePointer_Default. Note: Icons are the only types of pictures supported.

Specifies a custom mouse icon for the control.

Specifies the font for the control when the value of the Label.FontSource property is FontSource_UseFontProperty.

Specifies the background color for the control.

Specifies the foreground color for the control.

The control automatically resizes to display all the content when this property is True. The direction in which the control resizes varies depending on the alignment of the text and the value of the Label.WordWrap property.

When this property is True, the Label can display multiple lines of text, and the Label breaks lines before a word that would extend past the right edge of the control. When this property is False, the Label always displays one line of text.

When this property is True, the Label.AutoSize property causes the Label to expand vertically. When this property is False, the Label.AutoSize property causes the Label to expand horizontally.

The label interprets the character that follows an ampersand (&) character in the Label.Caption property as an accelerator character when this property is True.

Specifies the text the control displays.

Use this property to assign an accelerator character to a control when the Label.UseMnemonic property is True. In the caption, include an ampersand (&) immediately before the character you want to designate as the accelerator character. The character is now underlined. Press <Alt> plus the underlined character to move the focus to the control. To include an ampersand in a caption without creating an accelerator character, include two ampersands (&&). A single ampersand is visible in the caption and no characters are underlined.

Specifies the text the control displays.

Specifies the border style for the control.

Specifies the alignment of the text in the control.

Localizes the text caption.

Occurs when you press and release the mouse on the control.

Occurs when the user clicks the mouse on the control.

Occurs when the user moves the mouse over the control.

Occurs when the user releases the mouse on the control. This event occurs before the Label.Click event.

Occurs when you change the contents of the control.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty when you expect the font the Label.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty when you expect the font the Label.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies how the control scales based on the dots per inch (DPI) setting.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

Connect an ExecutionView Manager control to a ReportView control to display the report for the selected execution.

Returns the Window handle to the RichText control this control uses to display text reports.

You can use a returned Window handle with the Microsoft Windows API functions.

Returns the Window handle to the RichText control this control uses to display text reports.

You can use a returned Window handle with the Microsoft Windows API functions.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

Prints the current report.

Pass True to launch the Print dialog box, in which you can select a printer for printing the report.

Prints the current report.

Pass True to launch the Print dialog box, in which you can select a printer for printing the report.

Updates the content of the control from an Execution object.

This method changes the report style of the control to the style the report uses. When you connect this control to an ExecutionView Manager control, you do not need to call this method because the connection updates this control when the report for the selected execution changes. Specifies the execution from which the ReportView control obtains the report.

Updates the content of the control from an Execution object.

Returns the handle to the WebBrowser control this control uses to display HTML and XML reports.

Use this handle to access methods and properties of the WebBrowser control. Refer to Microsoft MSDN documentation for more information about WebBrowser control methods and properties.

Returns the handle to the WebBrowser control this control uses to display HTML and XML reports.

Use this handle to access methods and properties of the WebBrowser control. Refer to Microsoft MSDN documentation for more information about WebBrowser control methods and properties.

Specifies whether the control displays a toolbar.

When this property is True, the control displays large icons in the toolbar. When this property is False, the control displays small icons in the toolbar.

Specifies how the control displays the text for the toolbar buttons.

Specifies which buttons are visible in the toolbar of the control. Use any combination of the ReportViewButtons constants. Use the bitwise-OR operator to specify more than one value.

Specifies which toolbar buttons are visible.

Specifies which buttons are visible in the toolbar of the control. Use any combination of the ReportViewButtons constants. Use the bitwise-OR operator to specify more than one value.

Specifies which toolbar buttons are visible.

Specifies the current font of the text used when displaying text reports. This font is used when the value of the ReportView.TextReportFontSource property is FontSource_UseFontProperty.

Specifies the font the control uses to display text reports. Note: This property does not apply to HTML and XML reports. The default value for this property is FontSource_UseSystemFixedWidthFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty when you expect the font the ReportView.TextReportFont property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses to display text reports. Note: This property does not apply to HTML and XML reports. The default value for this property is FontSource_UseSystemFixedWidthFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty when you expect the font the ReportView.TextReportFont property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the color of the text used when displaying reports.

Specifies the background color of the report when displaying text reports.

Specifies how the control scales based on the dots per inch (DPI) setting.

Returns the frame and draggable borders that surround the control.

Occurs when the user drags a draggable border of a control with the mouse. The event provides the location and size to which you must set the control for the draggable borders to track the mouse cursor. However, you can choose to modify the location or size to which you set the control. For example, you can limit the width of the control so the left edge cannot be dragged off of the visible portion of the window. In addition to changing the size and position of the control, you might also update the sizes and positions of the other controls on the window to account for the change.

Updates the content of the control from a file.

The extension of the fileName parameter determines the report style of the control. For example, if fileName is C:\Reports\MyReport.html, the style is HTML. Note: This method returns an error if the ReportView control is currently attached to an execution. Specifies the full path of the report file.

Updates the content of the control from a file.

The SeqViewColumn object represents a column in the SequenceView control. Use the SequenceView.Columns property to obtain a list of columns for the control.

Specifies the name for the column.

Every column must have a unique name, which can be used to identify the column within the SeqViewColumns collection. Column names are not case-sensitive.

Specifies the expression for the column.

The column evaluates the expression and displays the evaluation result for each step. The Expression property is one of two ways you can define what a column displays. You can also use the SeqViewColumn.Type property to define standard columns, such as step index or step description. Note: This property is active only when the column type is SeqViewColumnType_Expression. The expression must return a string.

Specifies whether the column is visible.

Specifies the type of the column.

You can use this property to define what kind of information displays for each step in the column. When the type of column you need is not defined in SeqViewColumnTypes, you can set the type to SeqViewColumnType_Expression and create your own type using the SeqViewColumn.Expression property. The result of the expression you specify displays for each step.

Specifies an expression that determines the text color for individual cells in the column at run time.

This expression overrides the item color the SequenceView.TextColor and SequenceView.ItemTextColorExpression properties define. The expression must return a numeric color value. When you do not want to change the text color, return -1, as the following example shows: Step.Result.Status == "Failed" ? tsRed: -1 When you assign this expression string to the TextColorExpression property of a column and run the application, the control colors the column text red for steps that fail. When empty, the control ignores this property.

Specifies an expression used to determine the background color for individual cells in the selected column at run time.

This expression overrides the item color the SequenceView.BackColor and SequenceView.ItemBackColorExpression properties define. Specify an expression that returns a numeric color value. When you do not want to change the text color, return -1, as the following example shows: Step.Result.Status == "Failed" ? tsRed: -1 When you assign this expression string to the BackColorExpression property of a column and run the application, the control colors the column background red for steps that fail. When empty, the control ignores this property.

Returns the zero-based numeric index of the column within the SeqViewColumns collection.

Specifies the caption in the header for the column.

Specifies the width of the column in pixels. When you set the width, the control generates the SequenceView.ColumnResized event.

Specifies whether the column automatically grows or shrinks to adjust to changes in the size of the control. This property does not take effect unless the SequenceView.AutoSizeColumns property is True.

A collection of SeqViewColumn objects.

Returns a reference to an item with the specified name or at the specified index in the collection.

You can pass a number to obtain a column by its index value. You can also pass a string to obtain the column using its name.

Returns the number of items in the collection.

Adds a new item to the collection and returns the new SeqViewColumn object.

Specifies the name of the new column. The name must be unique but is not case-sensitive. Specifies the type of column. Refer to the SeqViewColumn.Type property for more information about column types. Specifies the width of the new column, in pixels. Specifies the index of the existing page before which to insert the new page. When you want the new page to be last, pass -1 to this parameter.

Removes the specified item from this collection, if it exists.

Specifies the zero-based index of the column to remove from the collection.

Moves a specific column one position to the left towards the beginning of the collection. For example, call Control.Columns.MoveLeft(1) to switch the first and second columns.

Specifies the zero-based index of the column to move in the collection.

Moves a specific column one position to the right towards the end of the collection. For example, call Control.Columns.MoveRight(0) to switch the first and second columns.

Specifies the zero-based index of the column to move in the collection.

Removes all items from the collection.

Connect a SequenceFileView Manager control or an ExecutionView Manager control to a SequenceView control to display the steps of a sequence from a selected file or execution. The SequenceView control displays the steps in a list with columns you specify when you configure the control. The SequenceView control maintains a cursor that indicates the last active item you clicked using the mouse or highlighted using the arrow keys. The control denotes the cursor using a dotted box that outlines the step. Use the SequenceView control to select one or more steps at a time. Use the SequenceFileView Manager control connected to the SequenceView control to control which sequence, step groups, and steps are selected in the file and to track the expansion of the step groups.

Specifies to make all columns fit within the width of the control. When the control resizes, the width of each column for which the SeqViewColumn.Autosizing property is a value other than AutoSizingOption_None adjusts so the columns fit the new size of the control. You must ensure that at least one column enables autosizing when you set this property to True.

When this property is True, the sum of all column widths always equals the width of the control and the horizontal scrollbar is not visible. When this property is False, you can resize the columns to any width and the horizontal scrollbar appears as needed.

Converts from an item index to a step group and step index.

Returns True when the item at itemIndex is a step. Returns False when the item is a step group start or end marker. Specifies a zero-based index that specifies an item in the control. Item indexes increase from top to bottom. Returns the step group of the specified step. Returns the index within the step group for the specified step. Returns -1 when the item is a start marker. Returns the number of steps in the step group when the item is an end marker.

Converts from an item index to a step group and step index.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

Returns a Window handle for the control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns a Window handle for the control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Specifies the default text color for the item text.

Note: You can override this default color on a per-row, per-column basis using the SequenceView.ItemTextColorExpression and SeqViewColumn.TextColorExpression properties.

Specifies the default text color for the item text.

Note: You can override this default color on a per-row, per-column basis using the SequenceView.ItemTextColorExpression and SeqViewColumn.TextColorExpression properties.

Specifies whether the control displays step comments.

The control displays step comments above the step. Although step comments can be of any length, you can use the SequenceView.MaxCommentsHeight property to limit the number of comment lines that display for each step.

Specifies whether the control displays step comments.

Specifies the color of the comments for step items.

Specifies the color of gridlines.

When this property is True and the SequenceView.ShowComments property is True, vertical lines display to the left of the step comments.

Specifies the default background color.

Note: You can override this default color on a per-row, per-column basis using the SequenceView.ItemBackColorExpression and SeqViewColumn.BackColorExpression properties. Note: When using the SequenceView control as an ExecutionViewConnection, use the SequenceView.BackColor property only when the value of the ExecutionViewConnection.Options property is ExecutionViewConnection_IgnoreColors.

Specifies the default background color.

Specifies the font for the item text when the value of the SequenceView.TextFontSource property is FontSource_UseFontProperty.

Specifies the font for comments when the value of the SequenceView.CommentsFontSource property is FontSource_UseFontProperty.

Specifies the font for the header, which labels each column when the value of the SequenceView.HeaderFontSource property is FontSource_UseFontProperty.

Specifies whether the control displays tooltips.

Item tooltips are the tooltips that appear when you hover over a partially visible item with the mouse. Tooltips allow you to see the full caption of a partially visible item.

Specifies whether the control displays tooltips.

Item tooltips are the tooltips that appear when you hover over a partially visible item with the mouse. Tooltips allow you to see the full caption of a partially visible item.

Returns the collection of columns.

Specifies the maximum number of comment lines visible per step.

Use this property to specify the maximum number of comment lines a step can display. By default, the value of this property is 3.

Specifies the maximum number of comment lines visible per step.

Use this property to specify the maximum number of comment lines a step can display. By default, the value of this property is 3.

Specifies the cursor index. The cursor indicates the active item in the view using a dotted box that outlines the item. Setting this property clears the current selection and selects the specified item.

Specifies whether the horizontal grid lines are visible.

Specifies whether the vertical grid lines are visible.

Specifies the number of pixels to indent the comment text and comment bar to the right.

Returns the zero-based index of the step at the location you specify. When the location is on the End step, the index is equal to the number of steps in the step group the control displays. A value of -1 indicates the location is not on a step.

Use this method to determine the item to which the given coordinates belong. For example, when a user clicks on the control, you might want to determine the item the user clicked. Returns a numeric item index. Specifies the x-coordinate of the location to test, in pixels, relative to the control. Specifies the y-coordinate of the location to test, in pixels, relative to the control.

Specifies an expression which the SequenceView control uses at run time to determine the background color for individual items. This expression overrides the item color the SequenceView.BackColor property defines.

The expression you specify must return a numeric color value. When you do not want to change the background color, return -1, as the following example shows: Step.Result.Status == "Failed" ? tsRed : -1 When you use this expression string, the SequenceView control makes the background for all failed steps red. If empty, the control ignores this property.

Specifies an expression which the SequenceView control uses at run time to determine the text color for individual items. This expression overrides the text color the SequenceView.TextColor property defines.

The expression you specify must return a numeric color value. When you do not want to change the background color, return -1, as the following example shows: Step.Result.Status == "Failed" ? tsRed : -1 When you use this expression string, the SequenceView control makes the text color of all failed steps red. If empty, the control ignores this property.

Localizes the captions of the columns in the SequenceView control.

First, update a .ini file located in the TestStand Language directory with the required strings. Second, use the string tags in the .ini file as the column captions for the control. When you call this method, the control replaces the column captions with the strings from the .ini file. If a caption is not a tag in the .ini file, the caption does not change. Specifies the name of the section in the language files that contains the localized text.

Localizes the captions of the columns in the SequenceView control.

Specifies the size of icons in the SequenceView control.

Icons are always square. For example, when you specify an icon size of 32, the dimensions of the icons are 32 × 32 pixels.

Specifies the size of icons in the SequenceView control.

Icons are always square. For example, when you specify an icon size of 32, the dimensions of the icons are 32 × 32 pixels.

Occurs when the user moves the item cursor.

Specifies the index of the element that became the cursor.

Occurs when the user resizes a column in the SequenceView control.

Specifies the index of the resized column. Specifies the new size of the column.

Occurs when the user presses a key while the SequenceView control has input focus.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user moves the mouse over the control.

Occurs when the user clicks the mouse on the control.

Occurs when the user double-clicks the mouse.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Set this property to a value other than FontSource_UseFontProperty if you expect the font the SequenceView.HeaderFont property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Set this property to a value other than FontSource_UseFontProperty if you expect the font the SequenceView.HeaderFont property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty if you expect the font the SequenceView.CommentsFont property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty if you expect the font the SequenceView.CommentsFont property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Set the FontSource property to a value other than FontSource_UseFontProperty when you expect the font the Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Set the FontSource property to a value other than FontSource_UseFontProperty when you expect the font the Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Occurs when the user right-clicks on the control so the application can build a context menu from which the user can select commands. Although you can implement context menus in most environments without using this event, some environments do not provide any other way to create a context menu. Also, creating a context menu using this event requires less code in most environments, especially when the context menu contains only TestStand commands.

Specifies how the control scales based on the dots per inch (DPI) setting.

Specifies whether this control uses a darker color for the background of every other column.

Specifies whether this control uses rounded corners to draw the background for the individual cells.

By default, all cells have the same background color as the control, which prevents this property from having any discernable effect. However, you can alter the background color of an individual cell using the SeqViewColumn.BackColorExpression property.

Specifies whether this control uses rounded corners to draw the background for the individual cells.

Returns the frame and draggable borders that surround the control.

Specifies whether the SequenceView control displays the step icons.

Occurs when the user drags a draggable border of a control with the mouse. The event provides the location and size to which you must set the control for the draggable borders to track the mouse cursor. However, you can choose to modify the location or size to which you set the control. For example, you can limit the width of the control so the left edge cannot be dragged off of the visible portion of the window. In addition to changing the size and position of the control, you might also update the sizes and positions of the other controls on the window to account for the change.

Specifies how the SequenceView control displays the block structure of a sequence.

Allows the SequenceView control to resume updating, following a call to BeginUpdate.

After making edits to the sequence, call this method to allow the display to update.

Allows the SequenceView control to resume updating, following a call to BeginUpdate.

After making edits to the sequence, call this method to allow the display to update.

Specifies the types of editing the SequenceView control allows. Use any combination of the EditingFlags constants with this property.

All editing types are allowed by default. These flags have no effect if the SequenceView control is not connected to display editable steps.

Specifies the types of editing the SequenceView control allows. Use any combination of the EditingFlags constants with this property.

All editing types are allowed by default. These flags have no effect if the SequenceView control is not connected to display editable steps.

Converts from a step group and step index to an index into the list of items the control displays.

Returns a zero-based index. The index identifies the item that displays the specified step. When the step is within a collapsed group, the index identifies the step group start marker. Specifies a step group. Specifies an index into the specified step group.

Converts from a step group and step index to an index into the list of items the control displays.

Returns a value that indicates whether the SequenceView control can enter label-editing mode.

Enters label-editing mode for the active item in the step list. Label-editing mode enables you to edit the item text in the first column of the SequenceView listbox control.

The SequenceView control automatically attempts to enter label-editing mode when you click the active item in the first column or when you press <F2> when the SequenceView control has the keyboard focus.

Enters label-editing mode for the active item in the step list. Label-editing mode enables you to edit the item text in the first column of the SequenceView listbox control.

Prevents the SequenceView control from drawing until the SequenceView.EndUpdate method is called.

Call this method to make multiple changes to the selection or the list of steps without updating the display.

Prevents the SequenceView control from drawing until the SequenceView.EndUpdate method is called.

Call this method to make multiple changes to the selection or the list of steps without updating the display.

Specifies the index of the item with the input focus. A dotted rectangle around the item represents the input focus. This property is identical to the SequenceView.Cursor property except that setting this property does not change the selection.

Read-only collection of sequence files. Use the ApplicationMgr.SequenceFiles property to obtain the collection of SequenceFile objects the Application Manager control opens.

Returns a reference to an item at the specified index in the collection.

Specifies the zero-based index of the item to retrieve. Use a non-negative number less than the value of the SequenceFiles.Count property. Alternatively, you can pass a string with the fully qualified path of the sequence file to retrieve from the collection.

Returns the number of items in the collection.

A collection of Execution objects. The ApplicationMgr.Executions property returns an Executions object, which contains all the executions the application created.

Returns a reference to an item at the specified index in the collection.

Specifies the zero-based index. Use a non-negative number less than the value of the Executions.Count property.

Returns the number of items in the collection.

Returns the number of incomplete executions in the collection, which is the sum of paused and running executions.

Returns the number of paused executions in the collection.

Returns the number of running executions. Paused executions are not considered to be running.

Resumes all paused executions in the collection.

A Collection of EntryPoint objects. Use the ConfigurationEntryPoints and ExecutionEntryPoints methods of the SequenceFileView Manager and ExecutionView Manager controls to retrieve an EntryPoints object.

Returns a reference to an item at the specified index in the collection.

Specifies the zero-based index. Use a non-negative number less than the value of the EntryPoints.Count property.

Returns the number of items in the collection.

A SequenceFileView Manager control performs the following tasks to manage how other visible TestStand User Interface (UI) Controls view and interact with a selected sequence file: * Designates a sequence file as the selected sequence file. * Tracks which sequence, step groups, and steps are selected in the selected file and tracks the expansion of the step groups. * Displays aspects of the selected file in the visible TestStand UI Controls to which it connects. * Enables visible TestStand UI Controls to which it connects to change the selected file, sequence, step group, and steps. * Provides methods for executing the selected sequence file. An application must have one SequenceFileView Manager control for each location, such as a window, form, or panel, in which you display a sequence file or let the user select a current sequence file.

Starts an execution that loops on the currently selected steps.

A new execution. Specifies a custom InteractiveArgs object using this parameter. When you do not pass a custom InteractiveArgs object, the SequenceFileView Manager control builds an InteractiveArgs object according to the current selections. Specifies a custom EditArgs object using this parameter. When you do not pass a custom EditArgs object, the SequenceFileView Manager control builds an EditArgs object according to the current selections.

Starts an execution that loops on the currently selected steps.

Refreshes all connected controls.

Typically, you do not call this method unless you have changed the state of the execution directly using the TestStand API. Call this method so these types of changes are reflected in the connected controls.

Refreshes all connected controls.

Refreshes a step in the current step group in a connected SequenceView control.

Typically, you do not call this method unless you have changed the state of the step directly using the TestStand API. Call this method so these types of changes are reflected in the connected SequenceView control. When you set the SequenceFileViewMgr.StepGroupMode property to StepGroupMode_AllGroups, call the SequenceFileViewMgr.RefreshStepEx method instead of this method to specify the step group in which the step resides. Specifies the index of the step to refresh. Passing -1 refreshes all steps in the connected SequenceView control.

Refreshes a step in the current step group in a connected SequenceView control.

Creates a Command object. When applicable, the command operates on the items the SequenceFileView Manager control selects.

Specifies the type of Command object to create. Use this parameter on commands that are sets to specify which command in the set to return.

Creates a Command object. When applicable, the command operates on the items the SequenceFileView Manager control selects.

Specifies the type of Command object to create. Use this parameter on commands that are sets to specify which command in the set to return.

Returns the current caption text for a caption source in a SequenceFileView Manager control.

The current text for the caption source you specify. Specifies the type of caption source from which to obtain text. For certain caption sources, this parameter specifies whether to return a long or short version of the caption text. Refer to the CaptionSources enumeration for more information about determining when this option affects the text and for more information about the difference between the long and short versions of the text. Specifies a format expression to evaluate when generating the caption text. For the CaptionSource_MacroExpression caption source, specify a format expression that evaluates to a string value that contains macros that specify other caption sources. For all other caption sources, specify an expression that evaluates to a string value that contains the characters %1. The method replaces the %1 characters with the text from the caption source. Pass an empty string to use the default format string for the caption source.

Returns the current caption text for a caption source in a SequenceFileView Manager control.

Connects a command source in a SequenceFileView Manager control to a TestStand button or checkbox control. The connection automatically updates the enabled, visible, and caption properties of the button or checkbox according to the state of the current execution. Clicking the button or enabling the checkbox control executes the command.

To disconnect an existing connection, you must first obtain the SequenceFileViewMgrConnections object from the SequenceFileViewMgr.Connections property. Then, access the SequenceFileViewMgrConnections.Command property to obtain the CommandConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Specifies the button or checkbox control to which the command connects. Specifies the type of command to connect. For CommandKinds that are sets, this parameter indexes the set to obtain a particular command. Specifies the options for the CommandConnection. Refer to the CommandConnectionOptions constants for more information about options for the CommandConnection object.

Connects a caption source in a SequenceFileView Manager control to a visible control or an element of a visible control. The connection automatically updates the visible control with text that describes an aspect of the current application state.

To disconnect an existing connection, you must first obtain the SequenceFileViewMgrConnections object from the SequenceFileViewMgr.Connections property. Then, call the SequenceFileViewMgrConnections.Caption property to obtain the CaptionConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Specifies the visible control or element of a visible control to which the caption source connects. Pass a Label, ExpressionEdit, or StatusBarPane. Specifies the type of caption source to connect. For certain caption sources, this parameter specifies whether the connection displays a long or short version of the caption text. Refer to the CaptionSources enumeration for more information about determining when this option affects a caption source and for more information about the difference between the long and short versions of the text.

Connects a user interface control that displays the list of opened sequence files. The control can also select a sequence file to place into the SequenceFileView Manager control.

You can connect a ComboBox, ListBarPage, and ListBox to SequenceFileLists. To disconnect an existing connection, you must first obtain the SequenceFileViewMgrConnections object from the SequenceFileViewMgr.Connections property. Then, access the SequenceFileViewMgrConnections.SequenceFileList property to obtain the SequenceFileListConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Use a ComboBox, ListBarPage, or ListBox to display the list of sequence files. When this parameter is True, TestStand displays the sequence files with full pathnames.

Connects a user interface control that displays the list of opened sequence files. The control can also select a sequence file to place into the SequenceFileView Manager control.

Connects a user interface control that displays the list of sequences in the current sequence file. The control can also select a sequence to place into the SequenceFileView Manager control.

You can connect the ComboBox, ListBarPage, and ListBox to SequenceFileLists. To disconnect an existing connection, you must first obtain the SequenceFileViewMgrConnections object from SequenceFileViewMgr.Connections property. Then, access the SequenceFileViewMgrConnections.SequenceList property to obtain the SequenceListConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Use ComboBox, ListBarPage, or ListBox to display the list of sequence files.

Connects a user interface control that displays the list of sequences in the current sequence file. The control can also select a sequence to place into the SequenceFileView Manager control.

Connects a user interface control that selects the step group of the current sequence file to place into the SequenceFileView Manager control.

You can connect a ComboBox, ListBarPage, and ListBox as StepGroupLists. To disconnect an existing connection, you must first obtain the SequenceFileViewMgrConnections object from SequenceFileViewMgr.Connections property. Then, access the SequenceFileViewMgrConnections.StepGroupList property to obtain the StepGroupListConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Use a ComboBox, ListBarPage, or ListBox to display the list of step groups.

Connects a user interface control that selects the step group of the current sequence file to place into the SequenceFileView Manager control.

Connects a SequenceView control to display the current sequence of the SequenceFileView Manager control.

Connects an image source in a SequenceFileView Manager control to a visible control or an element of a visible control. The connection automatically updates the visible control with an icon that describes an aspect of the current application state.

To disconnect an existing connection, you must first obtain the SequenceFileViewMgrConnections object from the SequenceFileViewMgr.Connections property. Then, access the SequenceFileViewMgrConnections.Image property to obtain the ImageConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Specifies the visible control or element of a visible control to which the caption source connects. Pass a StatusBarPane or Button. Specifies the type of image source to connect.

Connects a VariablesView control to display the current sequence context of the SequenceFileView Manager control.

Returns the connections of this control.

Returns the set of Execution entry points the model sequence file for the selected sequence file defines. The collection includes only entry points that set the Sequence.ShowEntryPointForFileWindow property.

This collection can change when the selected sequence file changes.

Specifies the selected sequence file the controls connected to the SequenceFileView Manager control display.

Use the SequenceFileViewMgr.ConnectSequenceFileList method to connect a control that displays open sequence files and specifies the selected sequence file.

Specifies the selected sequence file the controls connected to the SequenceFileView Manager control display.

Use the SequenceFileViewMgr.ConnectSequenceFileList method to connect a control that displays open sequence files and specifies the selected sequence file.

Specifies the current sequence.

Use the SequenceFileViewMgr.ConnectSequenceList method to connect a control that displays sequences and specifies the current sequence. The current sequence is the sequence the SequenceFileView Manager control displays in a connected SequenceView control. Use the SequenceFileViewMgr.SelectedSequences property to determine the list of sequence a connected control selects. Use the SequenceFileViewMgr.SetSequenceAndGroup method to set the current sequence when you must also set the SequenceFileViewMgr.StepGroup property.

Specifies the current sequence.

Specifies the selected step group.

A SequenceView control displays the selected step group or all groups depending on the value of the SequenceFileViewMgr.StepGroupMode property. Use the SequenceFileViewMgr.SetSequenceAndGroup method to set the step group when you must also set the SequenceFileViewMgr.Sequence property.

Specifies the selected step group.

Returns the collection of Configuration entry points for the selected sequence file.

This collection can change when the selected sequence file changes.

Returns the collection of Configuration entry points for the selected sequence file.

This collection can change when the selected sequence file changes.

Returns a collection of selected steps.

Use this collection to obtain the selected steps or to change the selected steps for the selected file. TestStand User Interface Controls connected to a SequenceFileView Manager control, such as the SequenceView control, automatically set this property when you select steps.

Returns a collection of selected steps.

Specifies whether the SequenceFileView Manager control selects another sequence file when the currently selected sequence file closes.

Returns a reference to the Application Manager control of the application. The value is NULL when no Application Manager control exists within the process.

Stores data associated with this control.

Stored data is cleared during the shutdown process.

Stores data associated with this control.

Stored data is cleared during the shutdown process.

Creates an EditArgs object according to the current selection settings of the SequenceFileView Manager control.

Use this method to create an EditArgs object, which you can modify before you pass it as the optional parameter to a method that starts an execution.

Creates an EditArgs object according to the current selection settings of the SequenceFileView Manager control.

Use this method to create an EditArgs object, which you can modify before you pass it as the optional parameter to a method that starts an execution.

Sets the current sequence and step group at the same time.

This is more efficient than setting the SequenceFileViewMgr.Sequence property before setting the SequenceFileViewMgr.StepGroup property. Specifies the sequence to set in the SequenceFileView Manager control. Specifies the step group value to set in the SequenceFileView Manager control.

Sets the current sequence and step group at the same time.

Runs the current sequence without using a process model entry point.

A new execution. Specifies a custom EditArgs object using this parameter. When you do not pass a custom EditArgs object, the SequenceFileView Manager control builds an EditArgs object according to the current selections.

Runs the current sequence without using a process model entry point.

Starts an execution to run the currently selected steps.

Creates an InteractiveArgs object according to the current selection settings of the SequenceFileView Manager control.

Use this method to create an InteractiveArgs object, which you can modify before you pass it as the optional parameter to a method that starts an interactive execution. A new InteractiveArgs object. When this parameter is True, this property launches the Loop on Selected Steps dialog box to create the InteractiveArgs object for the SequenceFileViewMgr.LoopOnSelectedSteps method. If the Loop on Selected Steps dialog box is cancelled, the value of the parameter passed in is True.

Creates an InteractiveArgs object according to the current selection settings of the SequenceFileView Manager control.

Occurs when the selected sequence file changes.

Specifies the new sequence file.

Occurs when the selected steps are changed.

Occurs when the current sequence changes.

Specifies the new sequence.

Occurs when the selected step group changes.

Specifies the new value of the step group property.

Occurs when TestStand sends a UIMsg_RefreshWindows message that requires a refresh of the selected sequence file.

Returns the current image name for an image source in a SequenceFileView Manager control. Use the Images.FindImage method to acquire a reference to the image.

The current image name for the image source you specify. Specifies the type of image source from which to obtain an image name.

Returns the current image name for an image source in a SequenceFileView Manager control. Use the Images.FindImage method to acquire a reference to the image.

The current image name for the image source you specify. Specifies the type of image source from which to obtain an image name.

For connected controls that display steps, this property specifies whether to display all steps in the Cleanup, Main, and Setup groups or to display only the steps in the current step group.

When you set this property to StepGroupMode_AllGroups, ensure that the application does not use the value of the SequenceFileViewMgr.StepGroup property.

For connected controls that display steps, this property specifies whether to display all steps in the Cleanup, Main, and Setup groups or to display only the steps in the current step group.

When you set this property to StepGroupMode_AllGroups, ensure that the application does not use the value of the SequenceFileViewMgr.StepGroup property.

Returns the UndoStack for the currently selected SequenceFile.

TestStand creates the UndoStack object and automatically adds items to this UndoStack for edits to the currently selected sequence file the TestStand User Interface Controls make.

Returns the UndoStack for the currently selected SequenceFile.

TestStand creates the UndoStack object and automatically adds items to this UndoStack for edits to the currently selected sequence file the TestStand User Interface Controls make.

Returns a collection of selected sequences.

Use this collection to obtain the selected sequences or to change the selected sequences for the selected file. Use the SequenceFileViewMgr.ConnectSequenceList method to connect a control that displays sequences and specifies the selected sequence. Use the SequenceFileViewMgr.Sequence property to determine the sequence a connected SequenceView control displays. TestStand User Interface Controls connected to a SequenceFileView Manager control, such as the ListBox control, automatically set this property when you select sequences.

Returns a collection of selected sequences.

Refreshes a step in all connected SequenceView controls.

Typically, you do not call this method unless you change the state of the step directly using the TestStand API. Specifies a particular step group. Specifies the zero-based index in the step group of the step to refresh. Pass -1 to refresh all the steps in all groups in the connected SequenceView control.

Refreshes a step in all connected SequenceView controls.

Returns a SequenceContext that has a Step property that has only properties common to all currently selected steps. Use the SequenceContext.GetMultipleValues method to determine whether the values of the Step subproperties are common across all the currently selected steps.

Occurs when the selected sequences change.

Connects an InsertionPalette control to display the step type list and templates list and enables inserting sequences, steps, and variables into controls connected to the SequenceFileView Manager control, such as the ListBox, SequenceView, or VariablesView controls.

To disconnect an existing connection, you must first obtain the SequenceFileViewMgrConnections object from the SequenceFileViewMgr.Connections property. Then, access the SequenceFileViewMgrConnections.InsertionPalettes property to obtain the InsertionPaletteConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Specifies the reference to an InsertionPalette control that displays the step type list and templates list.

Returns a collection of selected property objects.

Use this collection to obtain the selected property objects or change the selected property objects for the selected file. TestStand User Interface Controls connected to a SequenceFileView Manager control, such as the VariablesView control, automatically set this property when you select variables and properties.

Returns a collection of selected property objects.

Occurs when the selected property objects change. For example, this event is generated when you change the selection in a VariablesView control that connects to the SequenceFileView Manager control or when you programmatically change the contents of the SelectedPropertyObjects collection.

An ExecutionView Manager control performs the following tasks to manage how other visible TestStand User Interface (UI) Controls view and interact with a selected TestStand execution: * Designates an execution as the selected execution. * Tracks which thread, stack frame, sequence, step group, and steps are selected in the selected execution. * Displays aspects of the selected execution in the visible TestStand UI Controls to which the control connects. * Enables visible TestStand UI Controls to which the control connects to change the selected thread, stack frame, sequence, step group, and steps. * Generates events to notify the application of the progress and state of the selected execution. * Provides debugging commands. * Updates the ReportView control to show the current report for the selected execution. An application must have one ExecutionView Manager control for each location, such as a window, form, or panel, in which you display an execution or let the user select a current execution.

Specifies the execution selected in the ExecutionView Manager control.

An execution cannot be selected in more than one ExecutionView Manager control at a time. The ExecutionView Manager control generates an ExecutionViewMgr.ExecutionChanged event when this property changes.

Specifies the execution selected in the ExecutionView Manager control.

Accesses the connections of the ExecutionView Manager control.

Returns the run state of the execution.

The ExecutionView Manager control generates the ExecutionViewMgr.RunStateChanged event when this property changes. The value this property obtains does not necessarily correspond to the value the Execution.GetStates method obtains. The Execution.GetStates method returns the instantaneous state of the execution, while the ExecutionViewMgr.RunState property returns the current state the ExecutionView Manager control displays. Note: When you write a user interface that uses an ExecutionView Manager control, National Instruments recommends using the ExecutionViewMgr.RunState and ExecutionViewMgr.TerminationState properties instead of directly calling the Execution.GetStates method on the execution. A slight delay exists between when the instantaneous state of the execution changes and when TestStand updates the state this property returns to reflect the change. This occurs because the ExecutionViewMgr.RunState and ExecutionViewMgr.TerminationState properties do not change until TestStand processes the UIMessages involved. Thus, use the ExecutionViewMgr.RunState and ExecutionViewMgr.TerminationState properties instead because these properties reflect what the user interface actually displays.

Returns the run state of the execution.

Returns the termination state of the execution.

The ExecutionView Manager control generates the ExecutionViewMgr.TerminationStateChanged event when this property changes. The value obtained from this property does not necessarily correspond to the value obtained from the Execution.GetStates method. The Execution.GetStates method returns the instantaneous state of the execution, while the ExecutionViewMgr.RunState property returns the current state the ExecutionView Manager control displays. Note: When you write a user interface that uses an ExecutionView Manager control, National Instruments recommends using the ExecutionViewMgr.RunState and ExecutionViewMgr.TerminationState properties instead of directly calling the Execution.GetStates method on the execution. A slight delay exists between when the instantaneous state of the execution changes and when TestStand updates the state this property returns to reflect the change. This occurs because the state this property returns does not change until TestStand processes the UIMessages involved, thus allowing for synchronization of the updates necessary for displaying an execution.

Returns the termination state of the execution.

Returns the set of Execution entry points that the model sequence file for the selected execution defines. The collection includes only entry points that set the Sequence.ShowEntryPointForExeWindow property.

This collection can change when the selected execution changes.

Returns a collection of Configuration entry points for the selected execution.

This collection can change when the selected execution changes.

Returns a collection of Configuration entry points for the selected execution.

This collection can change when the selected execution changes.

Returns the collection of selected steps.

Use this collection to obtain the selected steps or to change the selected steps. TestStand User Interface Controls connected to an ExecutionView Manager control, such as the SequenceView control, automatically set this property when you select steps. The ExecutionView Manager control also generates the ExecutionViewMgr.SelectionChanged event when this property changes. Note: You can select steps only when an execution is paused.

Returns the collection of selected steps.

Specifies the current SequenceContext of the ExecutionView Manager control.

The ExecutionView Manager control automatically sets this property when pausing an execution. Note: You can read and write to this property only when the selected execution is paused. When you write to this property, the sequence context must belong to the selected execution.

Specifies the current SequenceContext of the ExecutionView Manager control.

Specifies the foreground thread of the selected execution.

Note: You can read or write to this property only when the selected execution is paused. When you write to this property, the thread must belong to the selected execution. Note: Although you can set the foreground thread of an Execution object, National Instruments recommends using this property so connected TestStand User Interface Controls are updated to reflect any changes made.

Specifies the foreground thread of the selected execution.

When this property is True, closing the selected execution replaces the closed execution with another execution not displayed in any other ExecutionView Manager control. Otherwise, the selected execution becomes NULL.

Returns a reference to the Application Manager control of the application. The value is NULL when no Application Manager control exists within the process.

Stores data associated with this control.

Stored data is cleared during the shutdown process.

Stores data associated with this control.

Stored data is cleared during the shutdown process.

Attempts to pause the current execution if it is running.

The ExecutionView Manager control generates an ExecutionViewMgr.Break event when the execution suspends.

Attempts to pause the current execution if it is running.

The ExecutionView Manager control generates an ExecutionViewMgr.Break event when the execution suspends.

Creates an EditArgs object that reflects the selection state of the ExecutionView Manager control.

Use this method to create an EditArgs object, which you can modify before you pass it as the optional parameter to a method that starts an execution. A new EditArgs object.

Creates an EditArgs object that reflects the selection state of the ExecutionView Manager control.

Use this method to create an EditArgs object, which you can modify before you pass it as the optional parameter to a method that starts an execution. A new EditArgs object.

Creates an InteractiveArgs object that reflects the selection state of the ExecutionView Manager control.

Use this method to create an InteractiveArgs object, which you can modify before you pass it as an optional parameter to a method that starts an interactive execution. The new InteractiveArgs object. When this parameter is True, this property launches the Loop on Selected Steps dialog box to create the InteractiveArgs for the ExecutionViewMgr.LoopOnSelectedSteps method. If the Loop on Selected Steps dialog box is cancelled, the value of the parameter passed in is True.

Creates an InteractiveArgs object that reflects the selection state of the ExecutionView Manager control.

Refreshes all connected controls.

Typically, you do not call this method unless you have changed the state of the execution directly using the API. Call this method so these types of changes are reflected in the connected controls. Specifies the SequenceContext used to refresh the controls. When you do pass a SequenceContext, the ExecutionView Manager control uses the current SequenceContext to refresh the controls.

Refreshes all connected controls.

Refreshes a step in a SequenceView control connected to the ExecutionView Manager control. Note: When the value of the ExecutionViewMgr.StepGroupMode property is not StepGroupMode_OneGroup, call ExecutionViewMgr.RefreshStepEx instead so you can specify the step group that contains the step.

Typically, you do not call this method unless you have changed the state of the step directly using the TestStand API. Call this method so these types of changes are reflected in connected SequenceView controls. Specifies the index of the step to refresh. Passing -1 refreshes all the steps in the connected SequenceView control.

Creates a Command object. When applicable, the command operates on the items the ExecutionView Manager control selects.

Specifies the type of Command object to create. Pass this parameter on commands that are sets to specify which command in the set to return.

Creates a Command object. When applicable, the command operates on the items the ExecutionView Manager control selects.

Specifies the type of Command object to create. Pass this parameter on commands that are sets to specify which command in the set to return.

Returns the current caption text for a caption source in an ExecutionView Manager control.

The current text for the caption source you specify. Specifies the type of caption source from which to obtain text. For certain caption sources, this parameter specifies to return a long or short version of the caption text. Refer to the CaptionSources enumeration for more information about determining when this option affects the text and for more information about the difference between the long and short versions of the text. Specifies a format expression to evaluate when generating the caption text. For the CaptionSource_MacroExpression caption source, specify a format expression that evaluates to a string value that contains macros that specify other caption sources. For all other caption sources, specify an expression that evaluates to a string value that contains the characters %1. The method replaces the %1 characters with the text from the caption source. Pass an empty string to use the default format string for the caption source.

Returns the current caption text for a caption source in an ExecutionView Manager control.

Interactively executes the selected steps within the current execution.

Note: You can call this method only when the execution is paused and the execution is not in interactive mode. Specifies an InteractiveArgs object. When you do not pass InteractiveArgs objects, the ExecutionView Manager control creates the appropriate InteractiveArgs objects.

Interactively executes the selected steps within the current execution.

Starts an interactive execution that loops on the currently selected steps.

Note: You can call this method only when the execution is paused and the execution is not in interactive mode. Specifies an InteractiveArgs object. When you do not pass an InteractiveArgs object, the ExecutionView Manager control creates the appropriate InteractiveArgs object.

Starts an interactive execution that loops on the currently selected steps.

Connects a command source in an ExecutionView Manager control to a TestStand button or checkbox control. The connection automatically updates the enabled, visible, and caption properties of the button or checkbox based on the state of the current execution. Clicking the button or enabling the checkbox executes the command.

To disconnect an existing connection, you must first obtain the ExecutionViewMgrConnections object from the ExecutionViewMgr.Connections property. Then, access the ExecutionViewMgrConnections.Command property to obtain the CommandConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Specifies the button or checkbox control to which the command connects. Specifies the type of command to connect. For CommandKinds that are sets, this parameter indexes the set to obtain a particular command. Specifies the options for the CommandConnection. Refer to the CommandConnectionOptions constants for more information about the options for the CommandConnection object.

Connects a caption source in an ExecutionView Manager control to a visible control or an element of a visible control. The connection automatically updates the visible control with text that describes an aspect of the current application state.

To disconnect an existing connection, you must first obtain the ExecutionViewMgrConnections object from the ExecutionViewMgr.Connections property. Then, access the ExecutionViewMgrConnections.Caption property to obtain the CaptionConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Specifies the visible control or element of a visible control to which the caption source connects. Pass a Label, ExpressionEdit, or StatusBarPane control. Specifies the type of caption source to connect. For certain caption sources, this parameter specifies whether the connection displays a long or short version of the caption text. Refer to the CaptionSources enumeration for more information about determining when this option affects a caption source and for more information about the difference between the long and short versions of the text.

Connects a SequenceView control to display the steps of the running sequence in the execution.

To disconnect an existing connection, you must first obtain the ExecutionViewMgrConnections object from the ExecutionViewMgr.Connections property. Then, access the ExecutionViewMgrConnections.ExecutionView property to obtain the ExecutionViewConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Specifies the SequenceView control to connect to the ExecutionViewConnection. Specifies the options for the ExecutionViewConnection. Refer to the ExecutionViewOptions constants for more information about the options for the ExecutionViewConnection.

Connects a SequenceView control to display the steps of the running sequence in the execution.

To disconnect an existing connection, you must first obtain the ExecutionViewMgrConnections object from the ExecutionViewMgr.Connections property. Then, access the ExecutionViewMgrConnections.ExecutionView property to obtain the ExecutionViewConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Specifies the SequenceView control to connect to the ExecutionViewConnection. Specifies the options for the ExecutionViewConnection. Refer to the ExecutionViewOptions constants for more information about the options for the ExecutionViewConnection.

Connects a ReportView control to display the report of the selected execution in the ExecutionView Manager control.

Connects a ComboBox, ListBarPage, or ListBox control to the list of running executions. The connected item displays the executions and allows the user to select an execution in the ExecutionView Manager control.

Connects a ComboBox, ListBarPage, or ListBox control to display the call stack of the paused execution.

Connects the list of threads in the current execution to a control. The connected control displays the threads when the execution is paused and allows the user to specify a thread as the foreground thread.

You can connect a ComboBox, ListBarPage, or ListBox to this connection. To disconnect an existing connection, you must first obtain the ExecutionViewMgrConnections object from the ExecutionViewMgr.Connections property. Then, access the ExecutionViewMgrConnections.ThreadList property to obtain the ThreadListConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Specifies a control or control element to connect to the ThreadListConnection.

Connects an image source in an ExecutionView Manager control to a visible control or an element of a visible control. The connection automatically updates the visible control with an icon that describes an aspect of the current application state.

Connects a numeric source in an ExecutionView Manager control to an element of a visible control. The connection automatically updates the visible control with the numeric information that describes an aspect of the current application state.

Use this method to display an execution progress bar in a StatusBar pane. To disconnect an existing connection, you must first obtain the ExecutionViewMgrConnections object from the ExecutionViewMgr.Connections property. Then, access the ExecutionViewMgrConnections.Numeric property to obtain the NumericConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned. Specifies the element of a visible control to which the caption source connects. Pass a StatusBarPane. Specifies the type of numeric source from which to obtain a numeric value.

Occurs when the ExecutionViewMgr.Execution property changes.

Specifies a new execution.

Occurs when the run state of the execution changes or when the execution changes and the new execution has a different run state.

Specifies the new run state of the execution.

Occurs when the selected execution ends.

Specifies the execution that has ended.

Occurs when the termination state for the execution changes or when the execution changes and the new execution has a different termination state.

Specifies the new termination state of the execution.

Occurs when the set of selected steps changes.

Occurs when the execution sends a user message.

User messages are messages with codes that are greater than or equal to UIMsg_UserMessageBase. The ExecutionView Manager control automatically acknowledges the user message when this event completes. Therefore, you do not have to directly call the UIMessage.Acknowledge method from within this event. Specifies the user-defined UIMessage object.

Occurs when TestStand sends a UIMsg_RefreshWindows message that requires a refresh of the selected execution.

Specifies the context of the steps to be refreshed. When the context is not passed in, the steps in the current context refresh.

Occurs when the selected execution in the ExecutionView Manager control breaks as a result of a breakpoint or upon user request, such as when you call the ExecutionViewMgr.BreakExecution method.

To obtain the message that signaled this event, use the ApplicationMgr.CurrentUIMessage property. Specifies the paused execution. Specifies the thread that generated the break notification. Specifies the current context of the execution.

Occurs when the execution sends a UIMsg_Trace message.

Specifies the current execution. Specifies the current thread. Specifies the current context.

Occurs when an execution has ended and has a report to display. This event is also called in response to UIMsg_DisplayReport.

Use this event to show the report for the execution. Specifies the execution that has the report to display.

Returns the current image name for an image source in an ExecutionView Manager control. Use the Images.FindImage method to acquire a reference to the image.

The current image name for the image source you specify. Specifies the type of image source from which to obtain an image name.

Returns the current image name for an image source in an ExecutionView Manager control. Use the Images.FindImage method to acquire a reference to the image.

The current image name for the image source you specify. Specifies the type of image source from which to obtain an image name.

Returns the current numeric value for a numeric source in an ExecutionView Manager control.

The current value for the numeric source you specify. Specifies the type of numeric source from which to obtain a numeric value.

Returns the current numeric value for a numeric source in an ExecutionView Manager control.

The current value for the numeric source you specify. Specifies the type of numeric source from which to obtain a numeric value.

Terminates the current execution if it is running.

The ExecutionView Manager control generates the ExecutionViewMgr.TerminationStateChanged event after calling this method and the ExecutionViewMgr.EndExecution event when the execution has ended.

Terminates the current execution if it is running.

The ExecutionView Manager control generates the ExecutionViewMgr.TerminationStateChanged event after calling this method and the ExecutionViewMgr.EndExecution event when the execution has ended.

Resumes the paused execution.

Restarts the stopped execution.

Attempts to abort the current execution if it is running.

The ExecutionView Manager control generates the ExecutionViewMgr.TerminationStateChanged event after calling this method and then generates the ExecutionViewMgr.EndExecution event when the execution has ended.

Attempts to abort the current execution if it is running.

Occurs when the ExecutionViewMgr.SequenceContext property changes programmatically or when a control connected to a CallStackConnection changes the property.

Specifies the current sequence context of the ExecutionView Manager control.

Occurs when the ExecutionViewMgr.Thread property changes programmatically or when a control connected to a ThreadListConnection changes the property.

Specifies the current foreground thread of the execution in the ExecutionView Manager control.

Specifies whether the SequenceView controls that connect to the ExecutionView Manager control display steps in all the step groups or only steps in the current step group.

Refreshes a step in all connected SequenceView controls.

Returns a SequenceContext object that has a Step property that has only properties common to all the currently selected steps. Use the SequenceContext.GetMultipleValues method to determine whether the values of the Step subproperties are common across all the currently selected steps.

Connects a VariablesView control to display the current sequence context of the ExecutionView Manager control.

Returns a collection of selected property objects.

Use this collection to obtain the selected property objects or change the selected property objects for the selected execution. TestStand User Interface Controls connected to an ExecutionView Manager control, such as the VariablesView control, automatically set this property when you select variables and properties. The ExecutionView Manager control also generates a ExecutionViewMgr.PropertyObjectSelectionChanged event when this property changes.

Returns a collection of selected property objects.

Occurs when the selected property objects change. For example, this event is generated when you change the selection in a VariablesView control that connects to the ExecutionView Manager control or when you programmatically change the contents of the SelectedPropertyObjects collection.

The Application Manager control performs the following basic operations, which facilitate using the TestStand Engine in an application: * Processes command-line arguments. * Maintains an application configuration file. * Initializes and shuts down the TestStand Engine. * Logs users in and out. * Loads and unloads files. * Launches executions. * Tracks existing sequence files and executions. * Manages licensing. An application that uses the TestStand User Interface Controls must have a single Application Manager control that exists for the duration of the application.

Stores user-specific data.

User data is cleared when the application shuts down.

Stores user-specific data.

User data is cleared when the application shuts down.

This method returns the process model sequence file the Application Manager control loads for a specified sequence file.

Specifies the sequence file with the associated process model sequence file you want. When you pass NULL, this method returns the station model file. Pass True to force the Application Manager control to load the model file if the Application Manager control has not already done so. When you pass False and the Application Manager control has not already loaded the model file, this method returns NULL.

This method returns the process model sequence file the Application Manager control loads for a specified sequence file.

Connects the list of adapters to a ComboBox, ListBarPage, or ListBox control. The connected control shows the adapters and allows the user to select an adapter as the default adapter of the TestStand Engine.

To disconnect an existing connection, you must first obtain the ApplicationMgrConnections object from the ApplicationMgr.Connections property. Then, access the ApplicationMgrConnections.AdapterList property to obtain the AdapterListConnections collection. Specifies the visible control or element of a visible control to display the list of adapters. Pass a ComboBox, ListBarPage, or ListBox.

Refreshes the specified connected controls.

Specifies any combination of RefreshOptions.

Refreshes the specified connected controls.

Specifies any combination of RefreshOptions.

Performs a refresh operation on every SequenceFileView Manager control that currently displays the specified file.

Specifies the PropertyObjectFile reference for a TestStand sequence file. Do not pass a value or pass RefreshOption_All (0xFFFFFFFF) to this reserved parameter.

Performs a refresh operation on every SequenceFileView Manager control that currently displays the specified file.

Specifies the PropertyObjectFile reference for a TestStand sequence file. Do not pass a value or pass RefreshOption_All (0xFFFFFFFF) to this reserved parameter.

Reloads the application configuration file from disk.

Unlike sequences files, the application configuration file does not automatically reload when an external application, such as a source control system, modifies the file. You can call this method to force the configuration file to reload.

Reloads the application configuration file from disk.

Returns True when the Application Manager control is running the LoginLogout Front-End callback sequence to log in a user.

Returns True when the Application Manager control is running LoginLogout Front-End callback sequence to log out a user.

Assign an UndoStack to this property to provide an UndoStack for CommandKind_Edit_Undo and CommandKind_Edit_Redo commands you connect to the Application Manager control.

This property is useful for creating undo and redo commands for TestStand files that are not sequence files such the station globals file and the users file.

Assign an UndoStack to this property to provide an UndoStack for CommandKind_Edit_Undo and CommandKind_Edit_Redo commands you connect to the Application Manager control.

This property is useful for creating undo and redo commands for TestStand files that are not sequence files such the station globals file and the users file.

Specifies whether the TestStand User Interface (UI) Controls allow the user to create and edit sequence files. Set this property to False for a non-editing user interface application. Set this property to True for an application that edits and saves sequence files.

When you set this property to True and you do not have an activated license that allows editing, TestStand generates a prompt to activate a license. When you do not have an appropriate license, TestStand generates an error. You can set or clear this property with the /editor or /operatorinterface command-line flags. To avoid overriding a value you specify on the command line, set this property to a default value for the application before the application evaluates the command-line arguments. The application evaluates command-line arguments when you call the ApplicationMgr.Start method. Use the ApplicationMgr.CommandLineCanChangeEditMode property to control whether the application evaluates the /editor or /operatorinterface command-line flags. When you set this property in the designer or set it before you call the ApplicationMgr.Start method, TestStand verifies the value when you call the ApplicationMgr.Start method, which returns an error when this property is True and cannot obtain a license that permits editing. When you set this property after calling the ApplicationMgr.Start method, the Application Manager control might prompt to activate a license.

Specifies whether the TestStand User Interface (UI) Controls allow editing of read-only files.

The value of this property persists in the application configuration file.

Specifies whether the TestStand User Interface (UI) Controls allow editing of read-only files.

The value of this property persists in the application configuration file.

When this property is True, the TestStand User Interface Controls ensure that steps you insert into a sequence have names that are unique within the sequence.

The value of this property persists in the application configuration file.

When this property is True, the TestStand User Interface Controls ensure that steps you insert into a sequence have names that are unique within the sequence.

The value of this property persists in the application configuration file.

Specifies whether the Application Manager control makes a backup of a file when you save a sequence file over an existing file that has an older or newer format. When this property is PerformActionOption_Yes, the Application Manager control backs up the existing file before saving it. When this property is PerformActionOption_No, the Application Manager control saves over the existing file without backing it up. When this property is PerformActionOption_Prompt, the Application Manager control prompts you to choose whether to back up the existing file.

The value of this property persists in the application configuration file.

Specifies whether the Application Manager control saves a modified file when you close the modified file. When this property is PerformActionOption_Yes, the Application Manager control saves the file. When this property is PerformActionOption_No, the Application Manager control discards the file without saving the file. When this property is PerformActionOption_Prompt, the Application Manager control prompts you to choose whether to save the file.

The value of this property persists in the application configuration file.

Specifies when the Application Manager control reloads sequence files that you modified on disk.

The Application Manager control generates the ApplicationMgr.QueryReloadSequenceFile event when the Application Manager control wants to reload the sequence file.

Specifies when the Application Manager control reloads sequence files that you modified on disk.

The Application Manager control generates the ApplicationMgr.QueryReloadSequenceFile event when the Application Manager control wants to reload the sequence file.

Initializes the user interface, acquires the necessary license, and runs the LoginLogout Front-End callback sequence, if the ApplicationMgr.LoginOnStart property is True.

Call this method after you create the user interface window. If the application edits sequence files, set the ApplicationMgr.IsEditor property before calling this method. This method calls the Engine.AcquireLicense method to request the proper license for the application to start. Note: You cannot use the user interface until you call this method.

Initializes the user interface, acquires the necessary license, and runs the LoginLogout Front-End callback sequence, if the ApplicationMgr.LoginOnStart property is True.

Closes opened sequence files and executions. This method also releases the TestStand Engine.

Call this method before the parent window of the Application Manager control is destroyed. When this method returns True, it is safe to destroy the parent window. When this method returns False, do not destroy the window until the Application Manager control generates an ApplicationMgrExitApplication event. When you cancel the TestStand Engine shutdown procedure, the Application Manager control generates the ApplicationMgrShutDownCancelled event.

Closes opened sequence files and executions. This method also releases the TestStand Engine.

Logs in the user by running the LoginLogout Front-End callback sequence. This method does not wait for the callback to execute. Use the ApplicationMgr.UserChanged event to determine whether the login was successful.

Logs out the current user by running the LoginLogout Front-End callback sequence. This method does not wait for the callback to execute. Use the ApplicationMgr.UserChanged event to determine whether the logout was successful.

Closes all open sequence files.

The Application Manager control attempts to close all sequence files by generating a QueryCloseSequenceFile event for each sequence file in the SequenceFiles collection. The ApplicationMgr.QueryCloseSequenceFile event confirms whether to release the file and remove the file from the SequenceFiles collection. When a sequence file is running in an execution or when other references to the sequence file exist, TestStand does not immediately unload the sequence file from memory.

Closes all open sequence files.

Opens a sequence file.

This method adds the sequence file to the SequenceFiles collection and generates the ApplicationMgr.SequenceFileOpened and ApplicationMgr.DisplaySequenceFile events. Returns the opened sequence file, when successful. When a type conflict occurs when loading the file and the conflict prevents TestStand from opening the file, this method returns NULL. When an error occurs while opening the file, this method throws an exception. Specifies the path of the sequence file to load. When you do not pass an absolute path, this method searches for the file using the TestStand search directory paths.

Opens a sequence file.

Closes a sequence file.

The Application Manager control attempts to close the sequence file by generating a QueryCloseSequenceFile event. The ApplicationMgr.QueryCloseSequenceFile event confirms whether to release the file and remove the file from the SequenceFiles collection. When the sequence file is running in an execution or when other references to the sequence file exist, TestStand does not immediately unload the file from memory. Returns True if the sequence file was closed. Specifies the sequence file to close.

Closes a sequence file.

Launches the Open File dialog box.

Creates an empty Commands collection. Refer to the Command object for more information about Command objects.

A reference to a Commands object. Release this reference when you are finished with it.

Creates an empty Commands collection. Refer to the Command object for more information about Command objects.

A reference to a Commands object. Release this reference when you are finished with it.

Generates an ApplicationMgr.ReportError event.

Typically, an application handles the ReportError event to display or log errors that occur during the operation of the TestStand User Interface Controls. An application can reuse this event handler to report other errors by calling this method. Specifies the integer error code. Specifies the descriptive error string.

Generates an ApplicationMgr.ReportError event.

Releases all references to the execution.

The Application Manager control attempts to close the execution by generating a QueryCloseExecution event. The ApplicationMgr.QueryCloseExecution event determines whether to cancel the closing of an execution or take additional actions when the execution is running. This method does not wait for running or terminating executions to complete. Returns True if the execution was closed. Specifies the execution to close.

Releases all references to the execution.

Sets an execution to automatically close when complete.

Specifies the execution you want to close automatically. Pass True for the execution to close when complete. When this parameter is False, the execution does not close automatically.

Sets an execution to automatically close when complete.

Specifies the execution you want to close automatically. Pass True for the execution to close when complete. When this parameter is False, the execution does not close automatically.

Returns a Boolean value that indicates whether an execution closes automatically when complete.

When this method returns True, the execution closes automatically when complete. When this method returns False, the execution does not close automatically. Specifies the execution to obtain the setting from.

Returns a Boolean value that indicates whether an execution closes automatically when complete.

Specify False to hide the execution in the user interface. Hidden executions are not included in an execution list connection you establish to an ExecutionView Manager control unless you set the ExecutionListConnection.ShowHiddenExecutions property to True.

Invisible executions are created when an execution is created with ExecTypeMask_InitiallyHidden. Specifies the execution to make visible or hidden. Pass True to make the execution visible. Pass False to make the execution hidden.

Returns True when the execution is not hidden in the user interface. Hidden executions are not included in an execution list connection you establish to an ExecutionView Manager control unless you set the ExecutionListConnection.ShowHiddenExecutions property to True.

Hidden executions are created using the ExecTypeMask_InitiallyHidden flag. Specifies the execution to determine whether it is visible.

Returns a reference to the TestStand Engine.

Creates a Command object.

Command object that represents the command. Specifies the type of Command object to create. Specifies which command in the set to return. Use this on sets of commands.

Creates a Command object.

Command object that represents the command. Specifies the type of Command object to create. Specifies which command in the set to return. Use this on sets of commands.

Returns the current caption text for a caption source in the Application Manager control.

The current text for the caption source you specify. Specifies the type of caption source to obtain the text from. Specifies whether to return a long or short version of the caption text for certain caption sources. Refer to the CaptionSources enumeration for more information about determining when this option affects the text and for more information about the difference between the long and short versions of the text. Specifies a format expression to evaluate when generating the caption text. For the CaptionSource_MacroExpression caption source, specify a format expression that evaluates to a string value that contains macros that specify other caption sources. For all other caption sources, specify an expression that evaluates to a string value that contains the characters %1. The method replaces the %1 characters with the text from the caption source. Pass an empty string to use the default format string for the caption source.

Returns the current caption text for a caption source in the Application Manager control.

Note: This method is obsolete. Use the ReloadModifiedSequenceFilesEx method instead.

Determines whether loaded sequence files have been modified on disk and generates an ApplicationMgr.QueryReloadSequenceFile event to determine whether to prompt you to reload any modified files. This method also refreshes the read-only state of open sequence files and updates the ApplicationMgr.ConfigurationEntryPoints and ApplicationMgr.ExecutionEntryPoints properties. Use the ApplicationMgr.ReloadFile method to reload a specific file.

Note: This method is obsolete. Use the ReloadModifiedSequenceFilesEx method instead.

Closes and releases all references to all executions.

The Application Manager control attempts to close all executions by generating a QueryCloseExecution event for each execution in the Executions collection. The ApplicationMgr.QueryCloseExecution event determines whether to cancel the closing of an execution or take additional actions when the execution is running. This method does not wait for running or terminating executions to complete.

Closes and releases all references to all executions.

Connects a control to the Application Manager control to make the connected control function as a command.

You can connect TestStand User Interface buttons and checkboxes using this method. To disconnect an existing connection, you must first obtain the ApplicationMgrConnections object from the ApplicationMgr.Connections property. Then, access the ApplicationMgrConnections.Command property to obtain the CommandConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected with this type of connection, the existing connection is returned. Specifies the button or checkbox control to which the command connects. Specifies the type of command to connect. Note: Not all commands found in the CommandKinds enumeration work with the Application Manager control. Refer to the CommandKinds enumeration for a list of compatible commands. Specifies an index into command sets. For example, when you connect to CommandKind_EntryPointSet, this parameter specifies the index of the entry point to use. Specifies a bitwise-OR combination of the CommandConnectionOptions constants.

Connects a control to the Application Manager control to make the connected control function as a command.

Connects a caption source in the Application Manager control to a visible control or an element of a visible control. The connection automatically updates the visible control with the text that describes an aspect of the application state.

You can use this method to display a caption in a Label, ExpressionEdit or StatusBarPane control. To disconnect an existing connection, you must first obtain the ApplicationMgrConnections object from the ApplicationMgr.Connections property. Then, access the ApplicationMgrConnections.Caption property to obtain the CaptionConnections collection. A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected with this type of connection, the existing connection is returned. Specifies the visible control, or element of a visible control to which the caption source connects. Pass a Label, ExpressionEdit, or StatusBarPane. Specifies the type of caption source to connect. For certain caption sources, this parameter specifies whether the connection displays the long or short version of the caption text. Refer to the CaptionSources enumeration for more information about the difference between the long and short versions of the text and to determine when this option affects a caption source.

Finds a SequenceFileView Manager control that has a particular sequence file selected.

IDispatch pointer to a SequenceFileView Manager control. When a sequence file is not selected in a SequenceFileView Manager control, the return value is NULL. Specifies the Sequence file with the SequenceFileView Manager control you want returned.

Finds a SequenceFileView Manager control that has a particular sequence file selected.

Finds the ExecutionView Manager control displaying a particular execution.

The ExecutionView Manager control that is displaying the execution that is passed in. This method returns NULL when it cannot find an ExecutionView Manager control that displays the specified execution. Specifies the execution with the ExecutionView Manager control you want returned.

Finds the ExecutionView Manager control displaying a particular execution.

Calls the Localize method on all loaded TestStand User Interface Controls using a given section name. For each user visible control text string, this method searches for a tag with the same string value in the specified section. When this method finds a control text string that is a tag in the language file, the method replaces the control text string with the value of the tag for the current language.

Call this control to localize all the controls once they are loaded. Specifies the name of the section in the language files to use.

When this property is True and the StationOptions.LoginOnStart property is True, the LoginLogout Front-End callback sequence runs when you call the ApplicationMgr.Start method.

When this property is True, TestStand suspends an execution for any step that fails. When this property is False, TestStand suspends execution based on whether the ExecTypeMask_BreakOnStepFailure option is enabled in the Execution.TypeMask property for that execution.

The value of this property is the same as the StationOptions.BreakOnStepFailure property.

Returns the ApplicationMgrConnections object, which contains the collection of the connections made to the Application Manager control.

Typically, you do not need to use this object. To make connections to the Application Manager control, use the ApplicationMgr.ConnectCaption and the ApplicationMgr.ConnectCommand methods.

Returns the ApplicationMgrConnections object, which contains the collection of the connections made to the Application Manager control.

Typically, you do not need to use this object. To make connections to the Application Manager control, use the ApplicationMgr.ConnectCaption and the ApplicationMgr.ConnectCommand methods.

When this property is True, all new executions break on the first step.

The value of this property persists in the configuration file the ApplicationMgr.ConfigFilePath property specifies.

When this property is True, all new executions break on the first step.

The value of this property persists in the configuration file the ApplicationMgr.ConfigFilePath property specifies.

When this property is True, TestStand suspends an execution on sequence failure. When this property is False, TestStand suspends execution based on whether the ExecTypeMask_BreakOnSequenceFailure option is enabled in the Execution.TypeMask property for the execution.

The value of this property is the same as the StationOptions.BreakOnSequenceFailure property.

Returns the collection of command-line arguments to the application. The following are switches on the command line: * /run <sequence> <sequencefile>—Runs the sequence in the sequence file. * /runEntryPoint <entryPointName> <SequenceFile>—Runs the entry point on the sequence file. * /quit—Exits the application once all executions complete. * /setCurrentDir—Sets the current directory to the first directory in the directory history list in the File dialog box. The current directory is the directory the File dialog box initially displays when you open a file. Use this option to set the directory the File dialog box displays to the directory the File dialog box displayed the last time you ran the application. The application sets the current directory after processing the other command-line options. * /?—Launches a help dialog box, which contains a list of valid command-line arguments, and then immediately closes. * /useExisting—Prevents a second instance of the application from running and forwards all command-line arguments to the application that is already running. * /goto <location>—Instructs the application to display the item the <location> property object path specifies, such as TestExec.exe C:\example.seq /goto "Seq[\"MainSequence\"].Main[\"Power On\"]"
TestExec.exe C:\example.seq /goto "Seq[\"MainSequence\"].Main[\"ID#:JifH4ODTf0y1z7bJne0G7D\"]"
TestExec.exe C:\example.seq /goto "Seq[1].Main[4].TS.LoadOpt" * /editor—Enables the application to create and edit sequence files. You must have activated a license that supports creating and editing sequence files. * /operatorInterface—Prevents the application from creating and editing sequence files.Note: You can use / or - to specify a switch. Quotation marks are required for arguments that contain a space, such as "Test UUTs" and "C:\My Documents\Test Sequence.seq".

The collection is created by splitting up the command line used to start the application, using white space as a delimiter. Note: When you launch another instance of the application with the /useExisting command-line switch, this property does not change to reflect the arguments forwarded to the application. Use the ApplicationMgr.ProcessUserCommandLineArguments event instead to process command-line arguments from another instance of the application.

When this property is True, the Application Manager control processes the following switches on the command line: * /editor—Enables the application to create and edit sequence files. You must have activated a license that supports creating and editing sequence files. * /goto <location>—Instructs the application to display the item the <location> property object path specifies, such as TestExec.exe C:\example.seq /goto "Seq[\"MainSequence\"].Main[\"Power On\"]"
TestExec.exe C:\example.seq /goto "Seq[\"MainSequence\"].Main[\"ID#:JifH4ODTf0y1z7bJne0G7D\"]"
TestExec.exe C:\example.seq /goto "Seq[1].Main[4].TS.LoadOpt" * /operatorinterface—Prevents the application from creating and editing sequence files.Note: You can use / or - to specify a switch. Quotation marks are required for arguments that contain a space, such as "Test UUTs" and "C:\My Documents\Test Sequence.seq". * /outputToStdIO—Writes the status of completed executions to standard output. When you run a user interface from the command line, the console window displays the text written to standard output. * /quit—Exits the application once all executions complete. * /run <sequence> <sequencefile>—Runs the sequence in the sequence file. * /runEntryPoint <entryPointName> <SequenceFile>—Runs the entry point on the sequence file. * /setCurrentDir—Sets the current directory to the first directory in the directory history list in the File dialog box. The current directory is the directory the File dialog box initially displays when you open a file. Use this option to set the directory the File dialog box displays to the directory the File dialog box displayed the last time you ran the application. The application sets the current directory after processing the other command-line options. * /useExisting—Prevents a second instance of the application from running and forwards all command-line arguments to the application that is already running. * /?—Launches a help dialog box, which contains a list of valid command-line arguments, and then immediately closes. In addition to the switches, you can provide on the command line sequence filenames to load into the application.

The ApplicationMgr.ReportError event reports errors that might occur while processing the command-line arguments. Use the ApplicationMgr.ProcessUserCommandLineArguments event to process command-line arguments the Application Manager control does not recognize as custom command-line arguments.

Returns the collection of sequence files the application opens.

This property eliminates the need to keep an array of open sequence files. Use the ApplicationMgr.OpenSequenceFile method to add files to the collection and the ApplicationMgr.CloseSequenceFile method to remove files from the collection.

Returns the collection of sequence files the application opens.

Returns the collection of executions the application creates.

This property eliminates the need to keep an array of open executions. The Application Manager control automatically adds new executions to the collection and removes closed executions.

Returns the collection of executions the application creates.

This property eliminates the need to keep an array of open executions. The Application Manager control automatically adds new executions to the collection and removes closed executions.

Returns True when the Application Manager control is running a LoginLogout Front-End callback sequence for a user to log in or log out.

Returns True when an execution is running.

Returns the PropertyObjectFile object that represents the configuration information that persists between sessions of the application.

The ApplicationMgr.ConfigFilePath property specifies the property object filename.

Returns the PropertyObjectFile object that represents the configuration information that persists between sessions of the application.

The ApplicationMgr.ConfigFilePath property specifies the property object filename.

Specifies the path of the configuration file.

Once the file has been loaded and you have called the ApplicationMgr.Start method, the path cannot be changed. The default pathname is %TestStandLocalAppData%\UserInterface.xml. Note: This property honors environment variables, the %TSVer% macro, the %TestStandConfig% macro, and the %TestStandLocalAppData% macro. The %TSVer% macro expands to the current TestStand version number. The %TestStandConfig% macro expands to the directory the Engine.GetTestStandPath (TestStandPath_Config) method call returns. The %TestStandLocalAppData% macro expands to the directory the Engine.GetTestStandPath (TestStandPath_LocalAppData) method call returns.

Specifies the path of the configuration file.

Returns a collection of the most recently used (MRU) sequence filenames in the application.

Specifies which files to reload when the application starts.

A value of ReloadFile_None results in nothing being reloaded on start. A value of ReloadFile_Selected makes the ApplicationMgr.Start method reload all files selected in any SequenceFileView Manager controls the last time the ApplicationMgr.Shutdown method was called. A value of ReloadFile_All makes the ApplicationMgr.Start method reload all files that were open when the ApplicationMgr.Shutdown method was last called. The files load after the first time a user logs in.

Specifies which files to reload when the application starts.

Accesses the current message being processed.

This property returns the current TestStand user interface message object when you need more information while handling an event.

Accesses the current message being processed.

This property returns the current TestStand user interface message object when you need more information while handling an event.

When this property is True, the ApplicationMgr.Logout method closes all sequence files and executions before running the LoginLogout Front-End callback. When this property is False, the ApplicationMgr.Logout method does not close any open sequence files or executions.

Specifies the interval, in seconds, at which the Application Manager control calls the ApplicationMgr.ReloadModifiedSequenceFilesEx method. When the value is 0, the Application Manager control does not reload any modified sequence files.

The default value is 3 seconds.

Occurs when the application has completed the shutdown process.

The application responds to this event by exiting. Refer to the ApplicationMgr.Shutdown method for more information about exiting.

Forwards TestStand Engine events before the manager controls process them.

Use this event to handle messages before the manager controls handle them. The Application Manager control automatically calls the UIMessage.Acknowledge method when this event completes. Therefore, you do not have to directly call the UIMessage.Acknowledge method from within this event. Specifies a TestStand User Interface message. Set this parameter to True when you do not want the manager controls to handle this event. Setting this parameter to True can improve performance in some cases by preventing TestStand from storing user interface message data in the internal cache. Note: National Instruments recommends using this parameter only when performance is a concern. Preventing the manager controls from receiving messages needed to track the state of the TestStand Engine can produce unpredictable behavior in the application.

Occurs when a sequence file is opened.

Specifies the sequence file that opened. If this parameter is True, the sequence file was already opened.

Note: This event is obsolete. Use the ApplicationMgr.SequenceFileClosing event instead.

Occurs when the application has closed a sequence file. You can use this event, but unsaved sequence files always pass in an empty string for the pathName parameter so no method exists for distinguishing the files. Specifies the path of the closed sequence file.

Occurs when the current user logged in changes.

Use this event to update the parts of the user interface that depend on user permissions when the current user logged in changes. Specifies the current user. When this parameter is NULL, no user is logged in.

Occurs when the application is performing lengthy tasks.

Use this event to display or remove a wait cursor or other indicator to show when the application is busy. When this parameter is True, the application has started a long operation. When this parameter is False, the application has finished the long operation.

Occurs when an error is reported. This event notifies the application of errors that occur while the user operates connected controls. This event is also called when the ApplicationMgr.RaiseError method is called.

Use this event to display an error message to the user of the user interface. Specifies the error code for the error that caused the event. Specifies the descriptive error string.

Occurs when the Application Manager control is attempting to close an execution.

Calls to the ApplicationMgr.Shutdown, ApplicationMgr.CloseExecution, and ApplicationMgr.CloseAllExecutions methods result in closing executions and calling this event. You can use this event to inform the user that an execution is closing and to allow the user to confirm that this is the desired action. Specifies the execution about to be closed. Specifies the run state of the execution. Specifies to cancel the closing of the execution; automatically close, abort, or terminate the running execution; or prompt the user for action. Refer to the QueryCloseExecutionOptions enumeration for more information about options for closing executions.

Occurs when the Application Manager control closes an execution.

Specifies the execution that has been closed.

Occurs before a sequence file is closed.

Use this event to prompt the user for confirmation on closing the sequence file or to stop the sequence file from closing. Specifies the sequence file that is closing. Set this parameter to True when you want to stop the sequence file from closing.

Occurs before the Application Manager control initiates a shutdown.

Refer to the QueryShutdownOptions enumeration for more information about constants with this parameter.

Occurs when a sequence file is opened directly or in response to a UIMsg_OpenWindows event TestStand sends.

Use this event to display the sequence file in a Sequence File window by setting the SequenceFileViewMgr.SequenceFile property on the SequenceFileView Manager control for the window. Specifies the sequence file to display. Specifies the reason why the event was generated. Refer to the SequenceFileDisplayReasons enumeration for more information about reasons for sequence file actions.

Occurs when a visible execution starts, when an execution breaks, or in response to a UIMsg_OpenWindow or a UIMsg_GotoLocation user interface message. Use the reason parameter to find out why this event was called.

Use this event to display the execution in a window by setting the ExecutionViewMgr.Execution property on the ExecutionView Manager control for the window. Specifies the execution to display. Specifies the reason why the event was generated. Refer to the ExecutionDisplayReasons enumeration for more information about reasons for execution actions.

Occurs when the UIMsg_DisplayReport user interface message is received.

Use this event to show the window that displays the report. Specifies the execution that contains the report to display.

Occurs when the TestStand Engine sends the UIMsg_ShutDownComplete message. Use the ApplicationMgr.Shutdown method to initiate the shutdown process.

Occurs when the Engine.ShutDown method is cancelled.

Occurs when an execution starts.

Specifies the newly started execution. Specifies the thread of the execution. Specifies whether the execution is initially hidden.

Occurs when an execution ends and the TestStand Engine sends a UIMsg_EndExecution message.

Specifies the execution that has ended.

Occurs when TestStand sends the UIMsg_BreakOnRunTimeErrorMessage message.

Use this event to launch a custom run-time error dialog box or to specify whether the Application Manager control launches a Run-Time Error dialog box or suspends the execution. You can change the Execution.RTEOptionForThisExecution property for the execution in this event before the Application Manager control handles it. Specifies the execution to which the event applies. Specifies the thread that sent the run-time error notification. The Application Manager control launches a Run-Time Error dialog box when the Execution.RTEOptionForThisExecution property is set to RTEOption_ShowDialog. Set this parameter to False when you do not want the Application Manager control to launch the Run-Time Error dialog box. Do not set this parameter to False to replace the default run-time error dialog box. Instead, handle the ApplicationMgr.DisplayCustomRunTimeErrorDialog event. By default, this parameter is True. Set this parameter to True to pause the current execution. By default, this parameter is False.

Occurs when an application component posts a user-defined UIMessage. A user-defined user interface message has an event code value that is equal to or greater than UIMsg_UserMessageBase (value: 10000).

The Application Manager control automatically acknowledges the user message when this event completes. Therefore, you do not have to directly call the UIMessage.Acknowledge method from within this event. Messages the Engine.RegisterUIMessage method defines do not generate an ApplicationMgr.UserMessage event, but TestStand does send the message to ApplicationMgr.UIMessageEvent. Specifies the user-defined UIMessage object.

Occurs when any execution breaks.

An ApplicationMgr.DisplayExecution event follows this event. Specifies a paused execution.

Returns the current image name for an image source in the Application Manager control. Use the Images.FindImage method to acquire a reference to the image.

The current image name for the image source you specify. Specifies the type of image source from which to obtain an image name.

Returns the current image name for an image source in the Application Manager control. Use the Images.FindImage method to acquire a reference to the image.

The current image name for the image source you specify. Specifies the type of image source from which to obtain an image name.

Occurs when a caller invokes the Command.Execute method. The event occurs after the Command object performs an action.

Specifies the command that executed.

Occurs when a caller invokes the Command.Execute method. When you return False through the cancel parameter, the Command.Execute method does not perform an action and the ApplicationMgr.PostCommandExecute event does not occur.

Specifies the command about to execute. Set this parameter to False to prevent the command from executing. When you cancel the command execution, you do not receive an ApplicationMgr.PostCommandExecute event.

Occurs when a UIMsg_RefreshWindows UIMessage posts. Handle this event to refresh custom controls as needed.

A step or callback sequence typically posts the UIMsg_RefreshWindows UIMessage to force a refresh, such as updating the status of a step in the Execution view when TestStand does not normally update it. Specifies the ActiveXData of the UIMessage object. Specify NULL to refresh data for all files and executions. Specify a PropertyObjectFile to refresh the data of a specific file. Specify a SequenceContext to refresh the SequenceContext of an execution. You can also specify an Object Reference Array that contains multiple values.

Refreshes all connected controls for all manager controls.

Returns True when the Application Manager control is shutting down. The Application Manager control shuts down between the time when the ApplicationMgr.Shutdown method is called until the ApplicationMgr.ExitApplication or ApplicationMgr.ShutDownCancelled event is called.

Returns True when the ApplicationMgr.Start method has been called. Returns False when the Application Manager control has been shutdown.

Launches an Open File dialog box, in which you can select more than one sequence file.

This method adds the opened sequence files to the SequenceFiles collection and generates the ApplicationMgr.SequenceFileOpened event for each opened file and generates the ApplicationMgr.DisplaySequenceFile event for the first file opened. A collection of the opened sequence files.

Launches an Open File dialog box, in which you can select more than one sequence file.

Returns True when the application exits on start as a result of using the command-line switch /? or /useExisting. Check this property before you call the ApplicationMgr.Start method. When this property is True, do not launch a splash screen or do any unnecessary time-consuming tasks.

Occurs when the Application Manager control wants to reload a modified sequence file because you called the ApplicationMgr.ReloadModifiedSequenceFiles method or because the Application Manager control detected a modified sequence file.

Use this event to customize how the application prompts the user to reload the modified sequence file or to reload or ignore modified sequence files without prompting the user. Specifies the sequence file to reload. Use QueryReloadSequenceFileOptions with this parameter. This parameter is initialized to QueryReloadSequenceFile_Prompt. You can change the value of this parameter to make the Application Manager control reload or discard the modified file without prompting the user.

Note: This event is obsolete. Use the ApplicationMgr.ProcessUserCommandLineArguments event instead.

Use this event to process custom command-line arguments. This event occurs when the ApplicationMgr.Start method is called and when another instance of the application is executed with the /useExisting command-line switch. This event occurs before the Application Manager control processes any command-line arguments. Specifies the user command-line arguments. This collection is created by splitting up the command line used to start the application using white space as a delimiter. When the ApplicationMgr.ProcessCommandLine property is True, the first argument the Application Manager control does not recognize marks the start of the user arguments. When the ApplicationMgr.ProcessCommandLine property is False, all arguments are user arguments.

Returns the set of Execution entry points that the station model sequence file defines. The collection includes only entry points that set the Sequence.ShowEntryPointForAllWindows property.

This collection can change when the station model sequence file changes.

Returns the set of Execution entry points that the station model sequence file defines. The collection includes only entry points that set the Sequence.ShowEntryPointForAllWindows property.

This collection can change when the station model sequence file changes.

Returns the set of Configuration entry points that the station model sequence file defines.

This collection can change when the station model sequence file changes.

Returns the set of Configuration entry points that the station model sequence file defines.

This collection can change when the station model sequence file changes.

Forwards TestStand Engine events after the manager controls process them.

Use this event to handle messages after the manager controls handle them. The Application Manager control automatically calls the UIMessage.Acknowledge method when this event completes. Therefore, you do not have to directly call the UIMessage.Acknowledge method from within this event. A TestStand user interface message.

Use this method to document command-line arguments you define.

The Application Manager control displays help for command-line arguments when you pass the /? switch to the application. The Application Manager control adds this string to the usage section in the command-line help dialog box. Specifies a string for the Application Manager control to add to the section of the command-line help dialog box that explains parameters to command-line arguments. Specifies a string for the Application Manager control to add to the end of the command-line help dialog box.

Use this method to document command-line arguments you define.

Call this method to generate an ApplicationMgr.EndEdit event that notifies the application an edit operation has completed. Call this method once for each call you make to the ApplicationMgr.BeginEdit method.

Specifies the file you are editing. Specifies the kind of edit. Pass the same value you pass to the ApplicationMgr.BeginEdit method. Specifies the edited objects. Pass the same objects you pass to the ApplicationMgr.BeginEdit method. Specifies whether the edit was cancelled. Pass the value you receive from the ApplicationMgr.BeginEdit method.

Specifies a key users can press to toggle the ApplicationMgr.IsEditor property. To prevent users from toggling the edit mode with a keystroke, set this property to ShortcutKey_VK_NOT_A_KEY.

Requests to switch an application to Editor Mode might prompt a user to activate a license when the Application Manager control cannot acquire the appropriate license to edit and save sequence files.

Specifies a key users can press to toggle the ApplicationMgr.IsEditor property. To prevent users from toggling the edit mode with a keystroke, set this property to ShortcutKey_VK_NOT_A_KEY.

Requests to switch an application to Editor Mode might prompt a user to activate a license when the Application Manager control cannot acquire the appropriate license to edit and save sequence files.

Specifies a modifier for the key users can press to toggle the ApplicationMgr.IsEditor property. Use any combination of the ShortcutModifiers constants.

Call this method to query whether the application gives permission to use the TestStand API to edit the sequence file the Application Manager control displays. This method generates an ApplicationMgr.CanEdit event to notify the application about the edit.

When the application implements custom editing actions on the selected sequence file using the TestStand API, call this method to determine whether to enable or disable the user interface element such as a menu or button that invokes the editing action. The application might not grant permission to edit based on a number of factors, such as the read-only state of the file, whether the file is executing, or other conditions the application considers when it responds to the ApplicationMgr.CanEdit event. Do not call this method to determine whether to enable a user interface element that invokes a Command object. Instead, obtain the value from the Command.Enabled property, which checks conditions specific to the command in addition to calling this method. When you connect a command to a button or when you connect a command to a menu item using the appropriate TestStand utility methods, the connection automatically queries the Command.Enabled property to enable or disable the button or menu item. Returns a Boolean value that indicates whether the application allows or denies permission to perform the edit. Specifies the file you are editing. Specifies the kind of edit you are making.

Call this method before using the TestStand API to edit files the Application Manager and SequenceFileView Manager controls display. This method generates an ApplicationMgr.BeginEdit event to notify the application about the edit.

Always make a corresponding call to the ApplicationMgr.EndEdit method after you modify the objectsToEdit parameter. Call the ApplicationMgr.EndEdit method even when the application cancels the edit. Do not call the ApplicationMgr.BeginEdit or ApplicationMgr.EndEdit methods when you execute a Command object to perform an edit. The Command object automatically calls the ApplicationMgr.BeginEdit and ApplicationMgr.EndEdit methods. Returns True when the application cancels the edit operation. When the application cancels the edit operation, do not modify the objectsToEdit parameter. Specifies the file you are editing. Specifies the kind of edit you are making. Specifies the objects you are modifying.

Occurs before an editing action initiates or when you explicitly call the ApplicationMgr.BeginEdit method.

Specifies the file being edited. Specifies the type of editing action. Specifies the objects to edit. The objectsToEdit parameter is passed as a one-dimensional array of containers where each array element is an object to edit. You can call the PropertyObject.GetNumElements method to obtain the length of the array and the PropertyObject.GetPropertyObjectByOffset method to access array elements. Pass True to prevent the edit from occurring. Specifies a set of EditingDenialReasons flags. When this parameter is non-zero, the flags in this parameter specify reasons why the edit cannot proceed. The application can clear these flags to allow the edit to proceed. For example, when the application integrates with source control systems and the EditingDenialReason_IsReadOnly flag is set, you could attempt to check out the selected file from source control to make it writable and then clear the EditingDenialReason_IsReadOnly flag if the checkout succeeds. Note: You cannot clear the EditingDenialReason_IsNotEditor flag.

Occurs when an editing action determines the enabled state or when you explicitly call the ApplicationMgr.CanEdit method.

The application can handle this event to modify the conditions that determine when to allow editing actions. Specifies the file being edited. Specifies the type of editing action. Pass False to disable the editing action. Specifies a set of EditingDenialReasons flags. When this parameter is non-zero, the flags in this parameter specify reasons why the edit cannot proceed. The application can clear these flags to allow the edit to proceed. For example, when the application integrates with source control systems and the EditingDenialReason_IsReadOnly flag is set, you could attempt to check out the selected file from source control to make it writable and then clear the EditingDenialReason_IsReadOnly flag if the checkout succeeds. Note: You cannot clear the EditingDenialReason_IsNotEditor flag.

Occurs when the ApplicationMgr.IsEditor property changes when directly set or when processing command-line arguments.

Occurs after an editing action completes or when you explicitly call the ApplicationMgr.EndEdit method.

For each ApplicationMgr.BeginEdit event the application receives, the application also receives a corresponding EndEdit event. Specifies the file being edited. Specifies the type of editing action. Specifies the edited objects. Specifies whether the editing action was cancelled.

Use this event to validate and process command-line arguments you define.

The Application Manager control generates this event while validating and processing command-line arguments. When the Application Manager control validates the command line, the Application Manager control generates this event for command-line arguments that it does not recognize. For these events, you must validate the unrecognized command-line arguments. In addition, when the Application Manager control processes the command line, the Application Manager control generates this event again for command-line arguments that it does not recognize. For these events, you must perform the action that the arguments require. Use the processCommand parameter of this event to determine whether you must perform the action that the arguments requires. The Application Manager control passes False to this parameter when the control is only validating and not actually processing the command line. When this parameter is False, handle this event the same as when this parameter is True, without performing the action the command-line specifies. Specifies the command-line arguments passed to the application. Specifies the index into arguments of the command-line argument the Application Manager control does not recognize. Increment this parameter for every argument you process. The Application Manager control continues processing the command-line arguments at this parameter when this event returns. When you set the errorProcessing parameter to ProcessCommandLineError_CustomError, set this parameter to a custom error message. The Application Manager control initializes this parameter to ProcessCommandLineError_None. Set this parameter to ProcessCommandLineError_UnrecognizedArgumentError when you do not recognize the command-line argument. Set this parameter to ProcessCommandLineError_CustomError when you encounter any other error processing the command line. The Application Manager control stops processing the command line and generates the ReportError event when an error occurs while processing the command line.

Set this property to False to prevent users from changing the edit mode of the application by passing /operatorInterface or /editor on the command line.

Requests to launch an application in Editor Mode might prompt a user to activate a license when the Application Manager control cannot acquire the appropriate license to edit and save sequence files.

Set this property to False to prevent users from changing the edit mode of the application by passing /operatorInterface or /editor on the command line.

Requests to launch an application in Editor Mode might prompt a user to activate a license when the Application Manager control cannot acquire the appropriate license to edit and save sequence files.

Specifies that the Application Manager control creates a new, empty sequence file at startup when the application is in edit mode, no initially opened sequences files exist, and a user logs in with the privilege to edit sequence files. When users open or create another file before making any changes to the empty automatically created file, the automatically created file closes.

If you do not want the Application Manager control to create an empty file for the user, set this property to False in the designer or in the application before you call the ApplicationMgr.Start method.

Occurs when you drop a file onto a TestStand User Interface (UI) Control that supports drag and drop. When you drop multiple files at once, the Application Manager control generates this event once for each file dropped.

This event is useful for supporting drag and drop of files that are not sequence files and must be handled differently. You can customize TestStand to natively support opening custom file formats and translating them into sequence files. When you drop a file onto a SequenceView control and the file is a valid TestStand code module file, the control inserts a step with its code module configured to call the file. Before the SequenceView control inserts the step, the Application Manager control generates the DropFile event for the dropped file. If your application handles the DropFile event, the SequenceView control does not insert the step. Specifies the absolute pathname of the file you dropped. Set this parameter to True when you programmatically open the file in the event handler and do not want the Application Manager to try to open the file. When you do not set this parameter to True, the Application Manager control opens the file as a sequence file or, if the file is a valid code module file and the file was dropped on a SequenceView control, the SequenceView control inserts a step configured to call the code module file.

Reloads the specified file. When the file is reloaded, this method returns a reference to the newly loaded version of the file in the file parameter. This method supports only sequence files the Application Manager control opens. For all other files, this method returns False.

TestStand generates an ApplicationMgr.QueryReloadSequenceFile event to allow the application to cancel the reload operation or specify to prompt the user to reload the file. When you specify ReloadFileOption_NoOptions for the options parameter for this method and an ApplicationMgr.QueryReloadSequenceFile event does not alter the opt parameter of the event, TestStand does not prompt to reload the file. When you specify ReloadFileOption_OnlyIfModifiedInMemory or ReloadFileOption_OnlyIfModifiedOnDisk for the options parameter to this method and an ApplicationMgr.QueryReloadSequenceFile event does not alter the opt parameter of the event, TestStand prompts the user to reload the file. Returns True when the file was reloaded. This method returns False when the TestStand Engine cannot unload the file, when an ApplicationMgr.QueryReloadSequenceFile event cancels the operation, or when TestStand prompts the user and the user cancels the operation. Specifies a reference to the file you want to reload. The reference changes to the reloaded version of the file when TestStand reloads the file. Specifies one or more ReloadFileOptions constants. Use the bitwise-OR operator to specify multiple options. Pass 0 to reload the file unconditionally.

Returns the run state of an execution.

The value obtained from this method does not necessarily correspond to the value obtained from the Execution.GetStates method. The Execution.GetStates method returns the instantaneous state of the execution. This method returns the current state the TestStand User Interface (UI) Controls display. Note: When you write a user interface that uses TestStand UI Controls, National Instruments recommends using this method or the ExecutionViewMgr.RunState property instead of directly calling the Execution.GetStates method on the execution. A slight delay exists between when the instantaneous state of the execution changes and when TestStand updates the state this method returns to reflect the change. This occurs because the state this method returns does not change until TestStand processes the UIMessages involved, thus allowing for synchronization of the updates necessary for displaying an execution. Specifies the execution on which to operate.

Returns the run state of an execution.

Returns the termination state of an execution.

The value obtained from this method does not necessarily correspond to the value obtained from the Execution.GetStates method. The Execution.GetStates method returns the instantaneous state of the execution. This method returns the current state that the TestStand User Interface (UI) Controls display. Note: When you write a user interface that uses TestStand UI Controls, National Instruments recommends using this method or the ExecutionViewMgr.TerminationState property instead of directly calling the Execution.GetStates method on the execution. A slight delay exists between when the instantaneous state of the execution changes and when TestStand updates the state this method returns to reflect the change. This occurs because the state this method returns does not change until TestStand processes the UIMessages involved, thus allowing for synchronization of the updates necessary for displaying an execution. Specifies the execution on which to operate.

Returns the termination state of an execution.

The value obtained from this method does not necessarily correspond to the value obtained from the Execution.GetStates method. The Execution.GetStates method returns the instantaneous state of the execution. This method returns the current state that the TestStand User Interface (UI) Controls display. Note: When you write a user interface that uses TestStand UI Controls, National Instruments recommends using this method or the ExecutionViewMgr.TerminationState property instead of directly calling the Execution.GetStates method on the execution. A slight delay exists between when the instantaneous state of the execution changes and when TestStand updates the state this method returns to reflect the change. This occurs because the state this method returns does not change until TestStand processes the UIMessages involved, thus allowing for synchronization of the updates necessary for displaying an execution. Specifies the execution on which to operate.

Specifies whether the Application Manager control uses the selected step list configurations specified in the Edit Step List Configurations dialog box that set the non-border properties of connected SequenceView controls. When this property is True, the Application Manager control enables commands that select or configure step list configuration. In addition, the non-border SequenceView properties you specify at edit time on the SequenceView property pages apply only when no applicable step list configurations exist in the application configuration file. When this property is False, the Application Manager control hides commands that select or configure step list configurations, and the Application Manager control uses the non-border SequenceView properties you specify at edit time on the SequenceView property pages.

Use this event when you need to perform cleanup or otherwise require a notification when the Application Manager control closes a sequence file. This event is generated immediately before the Application Manager control closes the file. The event handler for this event cannot cancel closing the file. Use the ApplicationMgr.QueryCloseSequenceFile event when you want an opportunity to cancel the closing of sequence files.

Specifies a reference to the sequence file about to be closed.

Determines whether loaded sequence files have been modified on disk and generates an ApplicationMgr.QueryReloadSequenceFile event to determine whether to prompt you to reload any modified files.

This method also refreshes the read-only state of open sequence files and updates the ApplicationMgr.ConfigurationEntryPoints and ApplicationMgr.ExecutionEntryPoints properties. Use the ApplicationMgr.ReloadFile method to reload a specific file. Returns True if this method reloads a sequence file.

Determines whether loaded sequence files have been modified on disk and generates an ApplicationMgr.QueryReloadSequenceFile event to determine whether to prompt you to reload any modified files.

Specifies the exit code of a user interface.

The Application Manager control sets the value of this property based on the status of executions and uses the following exit codes to indicate the specified status:@table(2,8,True,Status!Exit Code!Run-time Error!the error code of the run-time error!Normal Exit!0!Command-line Error!1!Sequence Failed!2!Sequence Terminated!3!Sequence Aborted!4!Killed Threads!5) If a run-time error with a non-negative error code occurs, the exit code is -17009 (TS_Err_ConvertedErrorCode). As a user interface developer, set the exit code of the application to this property. The development environment you use determines how you return an exit code in an application. LabVIEW does not support returning exit codes. If you use a command line to run the user interface, you must use the start /wait command to obtain the exit code from a user interface, as follows: start /wait TestExec -Quit -Run MainSequence SequenceFile1.seq Use the –OutputToStdIO command-line flag to send additional status information for completed executions to standard output.

Specifies the exit code of a user interface.

Occurs before TestStand launches the default run-time error dialog box. You can use this event to launch a custom run-time error dialog box.

Specifies the SequenceContext in which the run-time error occurred. Set this parameter to True to pause the current execution. Set this parameter to True to set the Execution.RTEOptionForThisExecution property to the value of the rteOption parameter. Set this parameter to True to set the Thread.SetBatchRTEOption method to the value of the rteOption parameter. Use the RTEOptions constants to specify how TestStand handles the run-time error. Set this parameter to True to launch the default run-time error dialog box.

Use Command objects in applications to implement a user interface element that performs a standard action, such as opening a sequence file or executing a set of selected steps in a sequence. A Command object determines the dimming, visibility, shortcut key, and caption for the menu item, button, or checkbox that invokes the command. The Command object also provides the implementation of the action, which it performs when you call the Command.Execute method. In many cases you can use a TestStand Utility Library function, such as InsertCommandsInMenu, instead of Command objects to create menu items that invoke the commands you specify. You can also call the ConnectCommand method on a TestStand manager control to connect a command to a TestStand button or checkbox control. To create Command objects, call the ApplicationMgr.NewCommands method to create a Commands collection. You specify the commands to create with the CommandKinds enumeration constants. When you call the Commands.InsertKind method, you can also specify a TestStand manager control. A command you create uses the specified manager control to determine the currently selected sequence file, execution, sequence, or steps. According to the selection and the type of command, the command determines the state of its properties, such as enabled and visible, and determines which items the command operates on when it executes. Some commands do not require a manager control, while others require a specific manager control. Refer to the CommandKinds enumeration for more information about which manager controls work with specific commands. You can also create commands using the following methods: * ApplicationMgr.GetCommand * ExecutionViewMgr.GetCommand * SequenceFileViewMgr.GetCommand * Commands.InsertKind

Specifies to enable or disable the menu item or user interface element that invokes the command.

The command computes the value of this property according to the kind of command and the current state of the items to which the command applies. However, when you set this property, the command returns only the property values that you set for the remainder of the life of the Command object.

Specifies whether to show or hide the menu item or user interface element that invokes the command.

The command computes the value of this property according to the kind of command and the current state of the items to which the command applies. However, when you set this property, the command returns only the property values you set for the remainder of the life of the Command object.

Specifies the menu item or user interface element that represents the command displays as a menu separator or other appropriate user interface divider element when this property is True.

The command computes the value of this property according to the kind of command. However, when you set this property, the command returns only the property values you set for the remainder of the life of the Command object.

Specifies whether the menu item or user interface element that represents the command can toggle between the on and off states. When this property is True, a menu item that represents the command displays a checkmark the user can enable or disable.

The command computes the value of this property according to the kind of command and the current state of the items to which the command applies. However, when you set this property, the command returns only the property values you set for the remainder of the life of the Command object.

When the Command.IsToggle property is True, this property specifies the on or off state of the menu item or user interface element that represents the command. When a menu item represents the command, the state of the menu item indicates the value of this property.

The command computes the value of this property according to the kind of command and the current state of the items to which the command applies. However, when you set this property, the command returns only the property values you set for the remainder of the life of the Command object.

Specifies which shortcut key to assign to a user interface element that represents a command.

Use the Command.ShortcutModifier property to specify <Shift>, <Ctrl>, and <Alt> modifiers for the shortcut key. For example, to assign the shortcut Ctrl+F12 to the command, set this property to ShortcutKey_VK_F12 and set the Command.ShortcutModifier property to ShortcutModifier_Control. The command computes the value of this property according to the kind of command and the current state of the items to which the command applies. However, when you set this property, the command returns only the property values you set for the remainder of the life of the Command object.

Specifies which shortcut key modifiers to assign to a user interface element that represents a command.

The command computes the value of this property according to the kind of command and the current state of the items to which the command applies. However, when you set this property, the command returns only the property values you set for the remainder of the life of the Command object.

Holds a data item you associate with the Command object.

Typically, you do not use this property unless you are implementing an event handler that requires specific data you define.

Holds an ActiveX object you associate with the Command object.

Typically, you do not use this property unless you are implementing an event handler that requires specific data you define.

Specifies the SequenceFileView Manager control to which the command applies. The enabled, visible, or other states of the command, as well as the entity on which the command operates, vary according to the type of command and the SequenceFileView Manager control selections for the sequence file, sequence, step group, and steps.

A value of NULL specifies that the command does not apply to an SequenceFileView Manager control.

Specifies the ExecutionView Manager control to which the command applies. The enabled, visible, or other states of the command, as well as the entity on which the command operates, vary according to the type of command and the ExecutionView Manager control selections for the execution, thread, call stack, and steps.

A value of NULL specifies that the command does not apply to an ExecutionView Manager control.

Returns a code that identifies the action the command performs.

Specifies the subsidiary commands the command contains. When a menu contains an item for the command, the subsidiary commands appear as items in a submenu that attach to the item for the command. When the command has no subsidiary commands, the value can be NULL or the Commands collection is empty.

Returns text that describes the command to the end user. The default text value is localized for the currently selected language. Typically, this text labels the menu item or button that invokes the command.

Specifies the character(s) you want to precede the accelerator character, when one exists, in the display name the method returns. The accelerator prefix for menu items and button labels varies according to the programming environment. For example, LabVIEW uses "_", LabWindows/CVI uses "__", and C#, Microsoft Visual C++, and Microsoft Visual Basic .NET use "&". When you are not assigning the display name to the label of a user interface element that supports accelerators, pass an empty string. Pass True to append characters that represent the shortcut key for the command to the display name the method returns. When the command does not have a shortcut key, the display name remains unchanged.

Specifies text that describes the command to the user.

Pass the new value for the command display name. When the new display name has a character you want to designate as the accelerator character, precede the character with an ampersand (&).

Executes the action that the command performs.

Specifies how the method reports an error that occurs when executing the command. When this parameter is False, the method returns the error to the caller. When this parameter is True, the method calls the ApplicationMgr.ReportError event to report the error.

Specifies the shortcut key that invokes the menu item or user interface element that represents the command. Use this value for the shortcut key element of the short cut cluster input to the LabVIEW Set Menu Item Info function when you create a menu item for the command. This property accounts for the set of shortcut keys LabVIEW run-time menus allow.

All LabVIEW shortcut key operations require the <Ctrl> key to be pressed. Examples of shortcut key values include "x", "w", and "F12". Set the Command.LVShortcutModifier property to True to specify that the shortcut key requires the <Shift> key to be pressed to invoke the command. The command computes the value of this property according to the kind of command and the current state of the items to which the command applies. However, when you set this property, the command returns only the property values you set for the remainder of the life of the Command object.

Specifies whether to include the <Shift> key for the shortcut key that invokes the menu item or user interface element that represents the command. Use this value for the include Shift key? element of the short cut cluster input to the LabVIEW Set Menu Item Info function when you create a menu item for the command.

The command computes the value of this property according to the kind of command and the current state of the items to which the command applies. However, when you set this property, the command returns only the property values you set for the remainder of the life of the Command object.

Specifies the name of the icon that represents the command. This property specifies an empty string when the command does not have an icon.

Returns the index of an Execution or Configuration entry point for a CommandKind_RunEntryPoint command.

Returns an EntryPoint object that represents an Execution or Configuration entry point for a CommandKind_RunEntryPoint command.

Contains a set of Command objects. To create new commands within the collection, call the Commands.InsertKind method.

Returns a reference to an item at the specified index in the collection.

Specifies the zero-based index. Use a non-negative number less than the value of the Commands.Count property.

Returns the number of items in the collection.

Removes all items from the collection.

Removes the specified item from this collection, if it exists.

Specifies the zero-based index of the item to remove.

Adds a new item to the collection.

Specifies the command object to insert. Specifies the index of the existing command before which to insert the new command. When you want the new command to insert at the end, pass -1 to this parameter.

Inserts a new Command object or objects into the collection.

This method uses the menu name the currentMenuName parameter specifies to determine whether to insert entry point items that specify a matching menu hint name when you pass the following values to the cmdKind parameter: CommandKind_ExecutionEntryPointInsertionMarker
CommandKind_ConfigurationEntryPointInsertionMarker
CommandKind_ExecutionEntryPointDefaultMenuInsertionMarker
CommandKind_ConfigurationEntryPointDefaultMenuInsertionMarker When an entry point does not specify a menu hint name or the menu hint names do not match any of the menu names listed in the allMenuNames parameter, the method creates commands to insert the entry point menus when you pass the following values to the cmdKind parameter: CommandKind_ExecutionEntryPointDefaultMenuInsertionMarker
CommandKind_ConfigurationEntryPointDefaultMenuInsertionMarker Specifies the type of command to insert. Depending on the value you pass and the state of the application, the method might insert one command, a set of commands, or no commands. Pass a SequenceFileView Manager or ExecutionView Manager control when the command you insert requires it. Specifies the position in the collection at which to insert the new command. Pass -1 to insert the new command at the end of the collection. Specifies the name of the menu when you create commands to insert into a menu in a top-level menu bar. Otherwise, pass an empty string. This method ignores accelerator prefix characters when comparing menu hints to the menu name you pass. Specifies the name of all top-level menus in order, separated by commas, when you create commands to insert into a menu in a top-level menu bar. Otherwise, pass an empty string. The commands use this to decide into which menu to insert based on the menu hint name. This method ignores accelerator prefix characters when comparing menu hints to the menu names you pass. Returns the number of commands the method inserted into the collection.

Inserts a menu item into a menu for each command in the Commands collection. Use this method to build a context menu for a control that generates the SequenceView.CreateContextMenu or ListBar.CreateContextMenu event.

Specifies the Microsoft Windows menu handle (HMENU) to insert the menu items into. The menu items invoke their corresponding Command objects when selected. You do not handle menu events for items this method inserts. Specifies the position or menu item identifier (resource ID/command ID) of the menu item before which the method inserts the new menu items. To insert at the end of the menu, pass -1 and pass True to the byPosition parameter. Pass True when the menuItemToInsertBefore parameter contains a zero-based menu item position. Pass False when the menuItemToInsertBefore parameter contains a menu item identifier (resource ID/command ID). Pass True to show shortcut key text for each item this method inserts that has a shortcut key. Typically, you use this method to build context menus which do not automatically implement shortcut key handling. Therefore, show shortcut keys only for items that also appear in the main menu bar, unless you explicitly provide shortcut key handling for items that appear only in the context menu.

Use these constants with the CommandConnection.Options property.

(Value: 0x0) No options.

(Value: 0x1) The connection does not change the visibility of the connected control.

(Value: 0x2) The connection does not set the caption on the connected control.

(Value: 0x4) The connection does not enable or disable the connected control.

(Value: 0x8) The connection sets the image on the connected control.

These constants specify types of standard commands. CommandKinds values specify a single command or a set of commands that can contain several commands or no commands, depending on the state of the application. You can pass these constants to the ApplicationMgr.ConnectCommand, SequenceFileViewMgr.ConnectCommand, and ExecutionViewMgr.ConnectCommand methods to connect commands to buttons or checkboxes. You can also connect commands to menu items. Note: If you connect a command that applies to the control that has the input focus, such as CommandKind_Edit_Cut and CommandKind_Edit_EditCode, to a button control, the command does not function after the first time the user clicks the button because the button acquires the input focus. To avoid this issue, you must ensure the button does not acquire the input focus when clicked. For a TestStand Button, you can achieve this by setting the Button.Style property to ButtonStyle_ToolBar. You can pass these constants to the Commands.InsertKind method to directly create command objects. Most commands, such as OpenSequenceFile, Login, and Restart, behave the same as the corresponding menu items in the TestStand Sequence Editor with regard to the action they take and the circumstances under which they are enabled. Refer to the NI TestStand Environment Reference Help for the corresponding sequence editor menu item for more information about how the item behaves. TestStand assigns default images to some commands, which TestStand displays when you connect the command to a Button control and you enable images for the control.

(Value: 28) Removes all code modules from memory.

(Value: 29) Opens a file in the most recently used (MRU) file list. Each command in the set opens one of the files from the most recently used file list. Do not directly create commands of this type. Instead, use CommandKind_MRUFiles_Set to create a set of commands of this type.

(Value: 30) Unloads all files and exits the application.

(Value: 40) Restarts the selected execution. This command applies only to the ExecutionView Manager control. This command has a default image.

(Value: 41) Runs a particular Process Model entry point sequence. Do not directly create commands of this type. Instead, use one of the following constants to create commands of this type as needed: CommandKind_ExecutionEntryPoints_Set
CommandKind_ConfigurationEntryPoints_Set
CommandKind_ExecutionEntryPointInsertionMarker
CommandKind_ExecutionEntryPointDefaultMenuInsertionMarker
CommandKind_ConfigurationEntryPointInsertionMarker
CommandKind_ConfigurationEntryPointDefaultInsertionMarker This command has a default image.

(Value: 42) Runs the selected steps using a specific Process Model entry point sequence. Do not directly create commands of this type. Instead, use one of the following constants to create commands of this type, as needed: CommandKind_RunSelectedStepsUsingEntryPoints_Set
CommandKind_RunSelectedStepsUsingEntryPointSubmenu These commands apply only to the SequenceFileView Manager control.

(Value: 43) Launches the Loop On Selected Steps dialog box, in which you can specify how many times the command loops on the selected steps using a specific Process Model entry point sequence. Do not directly create commands of this type. Instead, the following constants contain commands of this type as needed: CommandKind_LoopOnSelectedStepsUsingEntryPoints_Set
CommandKind_LoopOnSelectedStepsUsingEntryPointsSubmenu This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 44) Runs the selected sequence without using a process model. This command applies only to the SequenceFileView Manager control. This command has a default image.

(Value: 45) Runs a specific sequence without using a process model. You do not directly create commands of this type. Instead, the CommandKinds_RunSequences_Set constant contains commands of this type as needed. This command applies only to the SequenceFileView Manager control.

(Value: 46) Runs the selected steps without using a process model. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 47) For each applicable Process Model entry point, this command contains a subsidiary command that runs the selected steps with that entry point. When you insert this command into a menu, each subsidiary command appears as an item in a submenu. This command applies only to the SequenceFileView Manager control.

(Value: 48) Launches the Loop On Selected Steps dialog box, in which you can specify how many times the command loops on the selected steps without using a process model. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 49) For each applicable Process Model entry point, this command contains a subsidiary command that launches the Loop On Selected Steps dialog box, in which you can specify how many times the subsidiary command loops on the selected steps using the entry point. When you insert this command into a menu, each subsidiary command is listed as a submenu item. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 50) Toggles whether executions suspend at the first step.

(Value: 51) Toggles whether executions suspend when a step fails.

(Value: 52) Toggles whether executions suspend when a sequence fails.

(Value: 53) Toggles whether the user interface application displays the steps in an execution as they execute.

(Value: 60) Toggles the breakpoint state of the selected steps. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 61) Contains the following subsidiary commands: CommandKind_RunModeForcePass
CommandKind_RunModeForceFail
CommandKind_RunModeSkip
CommandKind_RunModeForceNormal When you insert this command into a menu, each subsidiary command appears as an item in a submenu. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 62) Sets the run mode of the selected steps to Force Pass. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 63) Sets the run mode of the selected steps to Force Fail. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 64) Sets the run mode of the selected steps to Skip. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 65) Sets the run mode of the selected steps to Normal. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 66) Resumes the selected execution. This command applies only to the ExecutionView Manager control. This command has a default image.

(Value: 67) Steps into the current step in the selected execution. This command applies only to the ExecutionView Manager control. This command has a default image.

(Value: 68) Steps over the current step in the selected execution. This command applies only to the ExecutionView Manager control. This command has a default image.

(Value: 69) Resumes execution through the end of the current sequence and suspends before the next step in the calling sequence. This command applies only to the ExecutionView Manager control. This command has a default image.

(Value: 70) Moves the execution pointer to the selected step. This command applies only to the ExecutionView Manager control. This command has a default image.

(Value: 71) Suspends the selected execution. This command applies only to the ExecutionView Manager control. This command has a default image.

(Value: 72) Suspends the selected execution if it is executing. Resumes the selected execution if it is suspended. This command applies only to the ExecutionView Manager control.

(Value: 73) Terminates the selected execution. This command applies only to the ExecutionView Manager control. This command has a default image.

(Value: 74) Terminates the selected execution if it is executing or suspended and restarts the selected execution if it has completed. This command applies only to the ExecutionView Manager control. This command has a default image.

(Value: 75) Aborts the current execution. The execution does not run the Cleanup steps. This command applies to the ExecutionView Manager control only.

(Value: 76) Suspends all executions. This command applies only to the Application Manager control. This command has a default image.

(Value: 77) Terminates all executions. This command applies only to the Application Manager control. This command has a default image.

(Value: 78) Aborts all executions. This command applies only to the Application Manager control.

ExecutionView Manager control

(Value: 79) Resumes all executions. This command applies only to the Application Manager control. This command has a default image.

(Value: 80) Launches the Edit Breakpoints/Watch Expressions dialog box.

(Value: 81) Launches the Breakpoint Settings dialog box for the selected step. This command applies to the ExecutionView Manager or SequenceFileView Manager controls.

(Value: 85) Contains the CommandKind_ToggleBreakpoint and CommandKind_DisplayBreakpointSettings subsidiary commands. When you insert this command into a menu, each subsidiary command appears as a submenu item. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 90) Launches the Adapter Configuration dialog box.

(Value: 91) Launches the Station Options dialog box.

(Value: 92) Launches the Edit Search Directories dialog box.

(Value: 93) Launches the Configure External Viewers dialog box.

(Value: 100) Executes a particular tool item in the TestStand Tools menu. Do not directly create commands of this type. Instead, the CommandKind_Tools_Set constant contains a command of this type for each item in the TestStand Tools menu.

(Value: 101) Launches the Customize Tools Menu dialog box.

(Value: 110) Specifies a set of commands that contains a CommandKind_RunEntryPoint command for each Execution entry point with a menu hint that selects the current menu.

(Value: 111) Specifies a set of commands that contains a CommandKind_RunEntryPoint command for each Execution entry point with a menu hint that does not select a menu other than the current menu. Because most entry points do not have menu hints, this constant typically specifies all Execution entry points.

(Value: 112) Specifies a set of commands that contains a CommandKind_RunEntryPoint command for each Configuration entry point with a menu hint that selects the current menu.

(Value: 113) Specifies a set of commands that contains a CommandKind_RunEntryPoint command for each Configuration entry point with a menu hint that does not select a menu other than the current menu. Because most entry points do not have menu hints, this constant typically specifies all Configuration entry points.

(Value: 120) Specifies a set of commands that correspond to the typical items in the File menu of a TestStand application. Although the specific commands this constant represents might vary according to the version of TestStand, the following is a representative set of commands: CommandKind_Login
CommandKind_Logout
CommandKind_Separator
CommandKind_Edit_NewSequenceFile*
CommandKind_OpenSequenceFiles
CommandKind_Close
CommandKind_Separator
CommandKind_CloseAll
CommandKind_CloseCompletedExecutions
CommandKind_Separator
CommandKind_OpenWorkspaceBrowser
CommandKind_Separator
CommandKind_Edit_Save*
CommandKind_Edit_SaveAs*
CommandKind_Edit_SaveAll*
CommandKind_Separator*
CommandKind_UnloadAllModules
CommandKind_LockUnlock
CommandKind_Separator
CommandKind_ExecutionEntryPointInsertionMarker
CommandKind_ConfigurationEntryPointInsertionMarker
CommandKind_Separator
CommandKind_MRUFiles_Set
CommandKind_Separator
CommandKind_Exit * The command is present only when editing is enabled.

(Value: 121) Specifies a set of commands that correspond to the typical menu items in the Execute menu of a TestStand application. Although the specific commands this constant represents might vary according to the version of TestStand, the following is a representative set of commands: CommandKind_Restart
CommandKind_Separator
CommandKind_ExecutionEntryPointDefaultMenuInsertionMarker
CommandKind_ConfigurationEntryPointDefaultMenuInsertionMarker
CommandKind_Separator
CommandKind_RunCurrentSequence
CommandKind_Separator
CommandKind_RunSelectedSteps
CommandKind_RunSelectedStepsUsingEntryPointSubmenu
CommandKind_LoopOnSelectedSteps
CommandKind_LoopOnSelectedStepsUsingEntryPointSubmenu
CommandKind_Separator
CommandKind_BreakOnFirstStep
CommandKind_BreakOnStepFailure
CommandKind_BreakOnSequenceFailure
CommandKind_TracingEnabled This command applies only to the ExecutionView Manager control.

(Value: 123) Specifies a set of commands that correspond to the typical items in the Debug menu of a TestStand application. Although the specific commands this constant represents might vary according to the version of TestStand, the following is a representative set of commands: CommandKind_ExecutionEntryPointInsertionMarker
CommandKind_ConfigurationEntryPointInsertionMarker
CommandKind_Separator
CommandKind_ToggleBreakpoint
CommandKind_SetRunModeSubmenu
CommandKind_Separator
CommandKind_Resume
CommandKind_StepInto
CommandKind_StepOver
CommandKind_StepOut
CommandKind_SetNextStep
CommandKind_Separator
CommandKind_Break
CommandKind_Terminate
CommandKind_Abort
CommandKind_Separator
CommandKind_BreakAll
CommandKind_TerminateAll
CommandKind_AbortAll
CommandKind_ResumeAll
CommandKind_Separator
CommandKind_DisplayBreakAndWatchPoints

(Value: 124) Specifies a set of commands that correspond to the typical items in the Configure menu of a TestStand application. Although the specific commands this constant represents might vary according to the version of TestStand, the following is a representative set of commands: CommandKind_ConfigureStationOptions
CommandKind_ConfigureSearchDirectories
CommandKind_ConfigureExternalViewers
CommandKind_ConfigureAdapters
CommandKind_Separator
CommandKind_ExecutionEntryPointInsertionMarker
CommandKind_ConfigurationEntryPointDefaultMenuInsertionMarker

(Value: 125) Specifies a set of commands that correspond to the typical items found in the Tools menu of a TestStand application. Although the specific commands this constant represents might vary according to the version of TestStand, the following is a representative set of commands: CommandKind_Tools_Set
CommandKind_Separator
CommandKind_CustomizeTools
CommandKind_Separator
CommandKind_ExecutionEntryPointInsertionMarker
CommandKind_ConfigurationEntryPointInsertionMarker

(Value: 126) Specifies a set of commands that corresponds to the typical items in the sequence view context menu of a TestStand application. Although the specific commands this constant represents might vary according to the version of TestStand, the following are a representative set of commands: SequenceFileView Manager Control: CommandKind_Edit_InsertStepsSubmenu*
CommandKind_Edit_EncapsulateSelectedStepsSubmenu*
CommandKind_Edit_SelectDefaultAdapters_Set*
CommandKind_Separator*
CommandKind_Edit_EditSteps_Set*
CommandKind_Edit_SpecifyModule*
CommandKind_Edit_EditCode*
CommandKind_Edit_Preconditions*
CommandKind_Separator*
CommandKind_BreakpointSubmenu
CommandKind_SetRunModeSubmenu
CommandKind_Separator
CommandKind_Edit_Cut*
CommandKind_Edit_Copy*
CommandKind_Edit_Paste*
CommandKind_Edit_Delete*
CommandKind_Edit_Rename*
CommandKind_Separator
CommandKind_RunSelectedSteps
CommandKind_RunSelectedStepsUsingEntryPointsSubmenu
CommandKind_LoopOnSelectedSteps
CommandKind_LoopOnSelectedStepsUsingEntryPointsSubmenu
CommandKind_Separator
CommandKind_SequenceViewConfigurationsSubmenu
CommandKind_Separator*
CommandKind_Edit_StepProperties* ExecutionView Manager Control: CommandKind_BreakpointSubmenu
CommandKind_SetRunModeSubmenu
CommandKind_Separator
CommandKind_RunSelectedSteps
CommandKind_LoopOnSelectedSteps
CommandKind_Separator
CommandKind_SetNextStep
CommandKind_Separator*
CommandKind_SequenceViewConfigurationsSubmenu * The command is present only when editing is enabled.

(Value: 140) Specifies a set of CommandKind_MRUFile commands. Each command opens one of the files in the MRU file list. This command applies only to the Application Manager control.

(Value: 141) Specifies a set of commands that contains a CommandKind_RunEntryPoint command for each Execution entry point. When you specify commands to create menu items, use the CommandKind_ExecutionEntryPointInsertionMarker and CommandKind_ExecutionEntryPointDefaultInsertionMarker constants to honor any menu hints the entry points might specify.

(Value: 142) Specifies a set of CommandKind_RunSpecificSequence commands that contains commands to run each sequence in the selected file without using a process model. This command applies only to the SequenceFileView Manager control.

(Value: 143) Specifies a set of CommandKind_RunEntryPointOnSelectedSteps commands that contains a command to run the selected steps with each applicable Execution entry point.

(Value: 144) Specifies a set of CommandKind_LoopEntryPointOnSelectedSteps commands that contains a command to run the selected steps with each applicable Execution entry point.

(Value: 145) Specifies a set of commands that contains a CommandKind_RunEntryPoint command for each Configuration entry point. When you specify commands to create menu items, use the CommandKind_ConfigurationEntryPointInsertionMarker and CommandKind_ConfigurationEntryPointDefaultInsertionMarker constants to honor menu hints entry points can specify.

(Value: 146) Specifies a set of CommandKind_ToolItem commands that contains a command for each tool item in the Tools menu.

(Value: 0) Guaranteed to never be a valid command kind specifier.

(Value: 1) Contains only subsidiary commands.

(Value: 2) Denotes a visual separation between other commands. For example, when commands appear as items in a menu, commands of this type appear as menu item separator bars.

(Value: 3) Represents an action you define. You must set Command properties, such as the Command.Enabled and Command.Visible properties, to the values you require. Although this command does not perform an action when it executes, an application can perform an action when it receives the ApplicationMgr.PreCommandExecute or ApplicationMgr.PostCommandExecute event for the command. You can attach data you define to the command using the Command.UserObject and Command.UserData properties so the data is available to the application in the handlers for PreCommandExecute and PostCommandExecute events.

(Value: 20) Launches the Open File dialog box. When the user selects a sequence file, the command loads and displays the file. This command has a default image.

Open File

(Value: 21) Closes the currently selected sequence file or execution. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 22) Closes all executions and sequence files. This command applies only to the Application Manager control.

(Value: 23) Closes all completed executions. This command applies only to the Application Manager control.

(Value: 24) Launches the Workspace Browser dialog box.

(Value: 25) Launches the user login dialog box.

(Value: 26) Logs out the current user.

(Value: 27) Launches the user login dialog box when no user is logged in. Otherwise, logs out the current user.

(Value: 127) Specifies a set of commands that corresponds to the typical items in the list bar context menu of a TestStand application. Although the specific commands this constant represents might vary according to the version of TestStand, the following are a representative set of commands: SequenceFileView Manager Control: CommandKind_ExecutionEntryPointDefaultMenuInsertionMarker
CommandKind_Separator
CommandKind_RunCurrentSequence
CommandKind_Separator
CommandKind_OpenSequenceFile
CommandKind_Close ExecutionView Manager Control: CommandKind_Close
CommandKind_CloseCompletedExecutions
CommandKind_Separator
CommandKind_TerminateRestart
CommandKind_BreakResume
CommandKind_Abort
CommandKind_Separator
CommandKind_BreakAll
CommandKind_TerminateAll
CommandKind_AbortAll
CommandKind_ResumeAll

(Value: 148) When a sequence file is protected, this command launches the Lock File dialog box or the Unlock File dialog box, depending on whether the file is currently locked.

(Value: 147) Launches the Open Multiple File dialog box, in which the user can select any number of files to open. The command loads all selected sequence files and displays one of the selected sequence files. This command has a default image.

(Value: 200) Calls Undo on the UndoStack of the connected manager control. This command applies to the SequenceFileView Manager and Application Manager controls. When connected to a SequenceFileView Manager control, this command reverts the most recent edit to the currently selected sequence file. Before connecting this command to the Application Manager control, you must assign an UndoStack to the ApplicationMgr.UndoStack property. This command has a default image.

(Value: 201) Calls Redo on the UndoStack of the connected manager control. This command applies to the SequenceFileView Manager and Application Manager controls. When connected to a SequenceFileView Manager control, this command redoes the last edit to the currently selected sequence file an undo command reverted. Before connecting this command to the Application Manager control, you must assign an UndoStack to the ApplicationMgr.UndoStack property. This command has a default image.

(Value: 116) Do not directly create commands of this type. Instead the CommandKind_SequenceViewConfigurations_Set constant contains commands of this type as needed.

(Value: 139) Specifies a set of CommandKind_SequenceViewConfiguration commands. Each command in the set applies a specific configuration to all SequenceView controls that connect to the specified manager control. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 118) Contains all the CommandKind_SequenceViewConfiguration commands the CommandKind_SequenceViewConfigurations_Set constant specifies, followed by a CommandKind_Separator and a CommandKind_ConfigureSequenceViews command. Insert this command into a menu to create a submenu with menu items to apply any existing SequenceView configuration or to edit the set of available configurations. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 128) Specifies a set of commands that correspond to the typical items in the Edit menu of a TestStand application. Although the specific commands this constant represents might vary according to the version of TestStand, the following is a representative set of commands: CommandKind_Edit_Undo*
CommandKind_Edit_Redo*
CommandKind_Separator*
CommandKind_Edit_Cut*
CommandKind_Edit_Copy
CommandKind_Edit_Paste*
CommandKind_Edit_Delete*
CommandKind_Edit_Rename*
CommandKind_Separator
CommandKind_SelectAll
CommandKind_Separator*
CommandKind_Edit_EditSteps_Set*
CommandKind_Edit_SpecifyModule*
CommandKind_Edit_EditCode*
CommandKind_Edit_Preconditions*
CommandKind_Separator*
CommandKind_Edit_SequenceFileCallbacks*
CommandKind_Separator*
CommandKind_Edit_StepProperties*
CommandKind_Edit_SequenceProperties*
CommandKind_Edit_SequenceFileProperties* * The command is present only when editing is enabled.

(Value: 129) Specifies a set of commands that corresponds to the typical items in the sequence list context menu of a TestStand application. This constant applies to the SequenceFileView Manager control. Although the specific commands this constant represents might vary according to the version of TestStand, the following are a representative set of commands: CommandKind_Edit_InsertSequence*
CommandKind_Separator*
CommandKind_Edit_Cut*
CommandKind_Edit_Copy*
CommandKind_Edit_Paste*
CommandKind_Edit_Delete*
CommandKind_Edit_Rename*
CommandKind_Separator*
CommandKind_Edit_SequenceFileCallbacks*
CommandKind_Separator*
CommandKind_Edit_SequenceProperties* * The command is present only when editing is enabled.

(Value: 149) Launches the Edit Step List Configurations dialog box. This command applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 202) Enters name-editing mode for the step with focus or the sequence item in a SequenceView or ListBox control. This command applies to the SequenceFileView Manager control.

(Value: 203) Moves the selection onto the clipboard. This command applies to the SequenceFileView Manager control. This command has a default image.

(Value: 204) Copies the selection to the clipboard. This command applies to the SequenceFileView Manager control. This command has a default image.

(Value: 205) Pastes the contents of the clipboard into the selected file. This command applies to the SequenceFileView Manager control. This command has a default image.

(Value: 206) Deletes the selection. This command applies to the SequenceFileView Manager control.

(Value: 207) Inserts a step into the selected file. You do not create commands of this type. Instead, the CommandKind_Edit_InsertSteps_Set and CommandKind_Edit_InsertStepsSubmenu constants contain commands of this type as needed. This command applies to the SequenceFileView Manager control.

(Value: 208) Saves the selected sequence file. This command applies to the SequenceFileView Manager control. This command has a default image.

(Value: 209) Launches the Save As dialog box. The dialog box prompts you to choose a location in which to save the selected sequence file. This command applies to the SequenceFileView Manager control.

(Value: 210) Saves all modified sequences files. This command has a default image.

(Value: 211) Creates a new, empty sequence file. This command applies to the SequenceFileView Manager control. This command has a default image.

(Value: 212) Launches the Step Properties dialog box for the step with focus.

(Value: 213) Launches the Sequence Properties dialog box for the sequence with focus.

(Value: 214) Launches the Sequence File Properties dialog box for the selected sequence file.

(Value: 215) Launches the Specify Module dialog box for the step with focus. This command applies to the SequenceFileView Manager control.

(Value: 216) Displays the module source code for the step with focus. This command applies to the SequenceFileView Manager control.

(Value: 217) Performs a step type-dependent editing operation on the step with focus. Typically, the operation launches an editing dialog box. For example, this command might launch the Edit Numeric Limit Test dialog box for a Numeric Limit Test step. You do not create commands of this type. Instead, the CommandKind_Edit_EditSteps_Set and CommandKind_Edit_EditStepsSubmenu constants contain commands of this type as needed. This command applies to the SequenceFileView Manager control.

(Value: 218) Launches the Preconditions dialog box. This command applies to the SequenceFileView Manager control.

(Value: 219) Selects all the items or text in the control with focus.

(Value: 220) Select a specific module adapter for new steps. You do not create commands of this type. Instead, the CommandKind_Edit_SelectDefaultAdapters_Set and CommandKind_Edit_SelectDefaultAdaptersSubmenu constants contain commands of this type as needed.

(Value: 221) Inserts a new empty sequence into the selected sequence file. This command applies to the SequenceFileView Manager control.

(Value: 222) Launches the Sequence File Callbacks dialog box. This command applies to the SequenceFileView Manager control.

(Value: 300) Specifies a container command with subsidiary commands the CommandKind_Edit_InsertSteps_Set constant specifies. When you insert this command into a menu, each subsidiary command is visible as a submenu item. This command applies to the SequenceFileView Manager control.

(Value: 301) Specifies a container command with subsidiary commands the CommandKind_Edit_ EditSteps_Set constant specifies. When you insert this command into a menu, the subsidiary commands appear within a submenu item. This command applies to the SequenceFileView Manager control.

(Value: 302) Specifies a container command with subsidiary commands the CommandKind_Edit_SelectDefaultAdapters_Set constant specifies. When you insert this command into a menu, each subsidiary command is visible as a submenu item.

(Value: 340) Specifies a set of commands that contains a CommandKind_Edit_InsertStep command for each available step type. The commands are organized hierarchically as specified for the step types in the Step Type Menu Editor dialog box. Insert this command into a menu to create the contents of the Insert Step context menu. This command applies to the SequenceFileView Manager control.

(Value: 341) Specifies a set of commands that contains a CommandKind_Edit_EditStep command for each step type specific editing operation that applies to the step with focus. A step type can define the available editing operations for instances of the type by specifying Edit substeps, which typically call a module to launch an editing dialog box.

(Value: 342) Specifies a set of commands that contains a CommandKind_Edit_SelectDefaultAdapter command for each module adapter.

(Value: 420) Launches the NI TestStand Help file. This command is visible only when editing is enabled.

(Value: 421) Launches a topic that is a guide to the TestStand documentation. This command is visible only when editing is enabled.

(Value: 422) Launches the help for the currently active TestStand User Interface Control.

(Value: 423) Opens the TestStand support web page in a browser. This command is visible only when editing is enabled.

(Value: 424) Opens the TestStand discussion forum on ni.com in a web browser. This command is visible only when editing is enabled.

(Value: 425) Displays a list of National Instruments patents.

(Value: 440) Specifies a set of commands that corresponds to the typical items in the Help menu of a TestStand application. Although the specific commands this constant represents might vary according to the version of TestStand, the following is a representative set of commands: CommandKind_ShowTestStandHelp
CommandKind_ShowGuideToDocumentation
CommandKind_ShowHelpTopic
CommandKind_Separator
CommandKind_ShowTestStandWebResources
CommandKind_ShowTestStandDiscussionForum
CommandKind_Separator
CommandKind_ShowPatents
CommandKind_Separator
CommandKind_ExecutionEntryPointInsertionMarker
CommandKind_ConfigurationEntryPointInsertionMarker

(Value: 223) Launches the Edit Paths in Files dialog box.

(Value: 400) Takes the selected step for an ExecutionView Manager control and selects the step in a SequenceFileView Manager control. This command is used in the context menu of a SequenceView control connected to an ExecutionView Manager control, and the command displays the step in the SequenceView control connected to a SequenceFileView Manager control.

(Value: 401) Takes the selected step for an ExecutionView Manager control and selects the step in a VariablesView control connected to the ExecutionView Manager control. This command is used in the context menu of a SequenceView control connected to an ExecutionView Manager control.

(Value: 450) Displays the Attributes dialog box. TestStand supports this command only for a sequence connection. This command applies to the SequenceFileView Manager control. This command has a default image.

(Value: 451) Contains the CommandKind_Edit_Attributes subsidiary command. When you insert this command into a menu, the subsidiary commands appear within a submenu item. This command applies to the SequenceFileView Manager control.

(Value: 452) Launches the NI Update Service. This option is available only when you have installed the NI Update Service.

(Value: 453) Launches the help for the NI TestStand example programs.

(Value: 224) Surrounds the selected steps with the specified step and a corresponding end step. You do not create commands of this type. Instead, the CommandKind_Edit_EncapsulateSelectedSteps_Set and CommandKind_Edit_EncapsulateSelectedStepsSubmenu constants contain commands of this type as needed. This command applies to the SequenceFileView Manager control.

(Value: 343) Specifies a set of commands that contains a CommandKind_Edit_EncapsulateSelectedSteps command for each available step type with the StepType.CanEncapsulate property set to True and that starts a block structure in a sequence. Insert this command into a menu to create the contents of the Encapsulate With context menu. This command applies to the SequenceFileView Manager control.

(Value: 303) Specifies a container command whose subsidiary commands the CommandKind_Edit_EncapsulateSelectedSteps_Set constant specifies. When you insert this command into a menu, each subsidiary command is visible as a submenu item. This command applies to the SequenceFileView Manager control.

(Value: 454) Launches the Getting Started with TestStand manual.

(Value: 455) Displays the module source code for the step with focus. This command is similar to CommandKind_Edit_EditCode, but does not increment the change count of the current sequence file. Unlike CommandKind_Edit_EditCode, this command is available when a sequence file is not editable, such as while the sequence is executing. CommandKind_UnloadStepModule is not available while any executions are actively running; the user must suspend all executions to use this command. This command applies to the SequenceFileView Manager and ExecutionView Manager control.

(Value: 94) Launches the Configure Environment dialog box.

These constants specify types of caption sources. Each caption source provides text that describes an aspect of the current application state. You can use these constants to connect a caption to a Label or StatusBarPane using the ApplicationMgr.ConnectCaption, ExecutionViewMgr.ConnectCaption, or SequenceFileViewMgr.ConnectCaption method. To obtain the text of a caption without connecting it to a control, call the ApplicationMgr.GetCaptionText, ExecutionViewMgr.GetCaptionText, or SequenceFileViewMgr.GetCaptionText method. A caption source applies to all manager controls unless the help for the enumeration element specifies the particular manager control or controls with which it applies.

(Value: 0) Guaranteed to never be a valid caption source specifier.

(Value: 2) Displays the serial number of the UUT for the current execution. A process model sends the UUT serial number through the UIMsg_ModelState_Identified UIMessageCode. This caption source applies only to the ExecutionView Manager control.

(Value: 3) Displays the result status of the UUT for the current execution. A process model sends the UUT status through the UIMsg_ModelState_TestingComplete UIMessageCode. This caption source applies only to the ExecutionView Manager control.

(Value: 4) Displays the batch serial number for the batch that contains the current execution. A process model sends the batch serial number through the UIMsg_ModelState_Identified UIMessageCode. This caption source applies only to the ExecutionView Manager control.

(Value: 5) Displays the batch result status for the batch that contains the current execution. A process model sends the batch status through the UIMsg_ModelState_TestingComplete UIMessageCode. This caption source applies only to the ExecutionView Manager control.

(Value: 6) Displays a description of the execution state of the batch that contains the current execution. For example, this caption might display Initializing, Testing, Waiting, or Completed [Passed]. This caption source applies only to the ExecutionView Manager control.

(Value: 7) Displays a description of the execution state of the current execution. For example, this caption might display Initializing, Testing, Waiting, or Completed [Passed]. This caption source applies only to the ExecutionView Manager control.

(Value: 8) Displays the name of the current user. When you pass True to the long name option for the caption, the caption displays the full user name. Otherwise, the caption displays the user login name.

(Value: 9) Displays the progress message for the current execution. A process model sends the progress text through the UIMsg_ProgressText UIMessageCode. This caption source applies only to the ExecutionView Manager control.

(Value: 10) Displays the progress percentage information for the current execution. This caption indicates the progress of operations for which the execution chooses to report the amount of progress. The caption does not necessarily reflect the progress of the execution as a whole. A process model sends the progress percent through the UIMsg_ProgressPercent UIMessageCode. This caption source applies only to the ExecutionView Manager control.

(Value: 11) Displays the path name of the currently executing or currently selected sequence file with a read-only, locked, executing, or modified file state suffix. When you pass True to the long name option for the caption, the caption displays the full path name. Otherwise, the caption displays the base filename. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 13) Displays the name of the currently executing or currently selected sequence. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 15) Displays the name of the currently executing or currently selected step group. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 16) Displays the name of the current step in the current execution. This caption source applies only to the ExecutionView Manager control.

(Value: 18) Displays the zero-based index of the current step in the current execution. This caption source applies only to the ExecutionView Manager control.

(Value: 19) Displays the one-based index of the current step in the current execution. This caption source applies only to the ExecutionView Manager control.

(Value: 20) Displays a description of which steps are selected. The description uses zero-based indexes. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 21) Displays a description of which steps are selected. The description uses one-based indexes and the word test in place of the word step. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 22) Displays the number of steps in the currently executing or currently selected step group. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 23) Displays the number of steps in the currently executing or currently selected step group. The description uses the word test in place of the word step. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 24) Displays a name that identifies the current execution. This caption source applies only to the ExecutionView Manager control.

(Value: 25) Displays a name that identifies the foreground thread in the current execution. This caption source applies only to the ExecutionView Manager control.

(Value: 26) Displays a name that identifies the current call stack item in the foreground thread in the current execution. This caption source applies only to the ExecutionView Manager control.

(Value: 27) Displays the path name of the process model file for the currently executing or currently selected sequence file. When you pass True to the long name option for the caption, the caption displays the full path name. Otherwise, the caption displays the base filename.

(Value: 28) Displays the location of the report for the current execution. The Report.Location property specifies the display value for a report. This caption source applies only to the ExecutionView Manager control.

(Value: 12) Displays the comment for the currently executing or currently selected sequence file. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 14) Displays the comment for the currently executing or currently selected sequence. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 17) Displays the comment for the current step in the current execution. This caption source applies only to the ExecutionView Manager control.

(Value: 1) Displays the evaluated result of a format expression that can contain macros that specify text from other caption sources. You can use this caption source to combine text from multiple caption sources. Place the macros that specify other caption sources within string constants in the format expression for the caption text or caption connection you create with this caption source. The following are the available macros: Macro, Caption Source, Specifies caption source long name %UUTSerialNumber%, CaptionSource_UUTSerialNumber, no
%UUTStatus%, CaptionSource_UUTStatus, no
%BatchSerialNumber%, CaptionSource_BatchSerialNumber, no
%BatchStatus%, CaptionSource_BatchStatus, no
%BatchState%, CaptionSource_BatchState, no
%ModelState%, CaptionSource_ModelState, no
%UserName%, CaptionSource_UserName, no
%ProgressText%, CaptionSource_ProgressText, no
%ProgressPercent%, CaptionSource_ProgressPercent, no
%CurrentSequenceFile%, CaptionSource_CurrentSequenceFile, no
%CurrentSequence%, CaptionSource_CurrentSequence, no
%CurrentStepGroup%, CaptionSource_CurrentStepGroup, no
%CurrentStep%, CaptionSource_CurrentStep, no
%CurrentStepIndex_ZeroBased%, CaptionSource_CurrentStepIndex_ZeroBased, no
%CurrentTestIndex_OneBased%, CaptionSource_CurrentTestIndex_OneBased, no
%NumberOfSteps%, CaptionSource_NumberOfSteps, no
%CurrentExecution%, CaptionSource_CurrentExecution, no
%CurrentThread%, CaptionSource_CurrentThread, no
%CurrentCallStackEntry%, CaptionSource_CurrentCallStackEntry, no
%CurrentProcessModelFile%, CaptionSource_CurrentProcessModelFile, no
%UUTSerialNumberLongName%, CaptionSource_UUTSerialNumber, yes
%UUTStatusLongName%, CaptionSource_UUTStatus, yes
%BatchSerialNumberLongName%, CaptionSource_BatchSerialNumber, yes
%BatchStatusLongName%, CaptionSource_BatchStatus, yes
%BatchStateLongName%, CaptionSource_BatchState, yes
%ModelStateLongName%,CaptionSource_ModelState,yes
%UserNameLongName%,CaptionSource_UserName,yes
%ProgressTextLongName%,CaptionSource_ProgressText,yes
%ProgressPercentLongName%,CaptionSource_ProgressPercent,yes
%CurrentSequenceFileLongName%,CaptionSource_CurrentSequenceFile,yes
%CurrentSequenceLongName%,CaptionSource_CurrentSequence,yes
%CurrentStepGroupLongName%,CaptionSource_CurrentStepGroup,yes
%CurrentStepLongName%,CaptionSource_CurrentStep,yes
%CurrentStepIndex_ZeroBasedLongName%,CaptionSource_CurrentStepIndex_ZeroBased,yes
%CurrentTestIndex_OneBasedLongName%, CaptionSource_CurrentTestIndex_OneBased, yes
%NumberOfStepsLongName%, CaptionSource_NumberOfSteps, yes
%CurrentExecutionLongName%, CaptionSource_CurrentExecution, yes
%CurrentThreadLongName%, CaptionSource_CurrentThread, yes
%CurrentCallStackEntryLongName%, CaptionSource_CurrentCallStackEntry, yes
%CurrentProcessModelFileLongName%, CaptionSource_CurrentProcessModelFile, yes

(Value: 29) Displays the zero-based index of the test socket for the current execution. Displays nothing when the execution is not participating in a multi-socket test process. A process model sends the text socket index through the UIMsg_ModelState_BeginTesting and UIMsg_ModelState_Waiting UIMessageCodes. This caption source applies only to the ExecutionView Manager control.

(Value: 31) Displays the current date. When you pass True to the long name option for the caption, the caption displays the system long date format. Otherwise, the caption displays the system short date format.

(Value: 30) Displays the current time using the system time format.

(Value: 32) Displays the path name of the currently executing or currently selected sequence file without a file state suffix. When you pass True to the long name option for the caption, the caption displays the full path name. Otherwise, the caption displays the base filename. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 33) Displays only the read-only, locked, executing, or modified file state of the currently executing or currently selected sequence file. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 34) Displays the path name of the current TestStand environment. When you pass True to the long name option for the caption, the caption displays the full path name. Otherwise, the caption displays the base filename.

These constants specify types of image sources. Each image source provides an icon that indicates an aspect of the current application state. You can use these constants to connect an image to a StatusBar pane or button using the ExecutionViewMgr.ConnectImage or SequenceFileViewMgr.ConnectImage methods. To obtain an image name without connecting it to a control, call the ApplicationMgr.GetImageName, ExecutionViewMgr.GetImageName, or SequenceFileViewMgr.GetImageName method. An image name is an icon name you can use to retrieve an icon from the TestStand Engine. An image source applies to all manager controls unless the help for the enumeration element specifies particular manager controls to which it applies.

(Value: 0) Guaranteed to never be a valid image source specifier.

(Value: 3) Displays an image that indicates the result status of the unit under test for the current execution. This image source applies only to the ExecutionView Manager control.

(Value: 5) Displays an image that indicates the batch result status for the batch that contains the current execution. This image source applies only to the ExecutionView Manager control.

(Value: 6) Displays an image that indicates the execution state of the batch that contains the current execution. This image source applies only to the ExecutionView Manager control.

(Value: 7) Displays an image that indicates the state of the current execution. This image source applies only to the ExecutionView Manager control.

(Value: 11) Displays a sequence file icon when a currently executing or currently selected file exists. Otherwise, the image source displays an empty image. This image source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 12) Displays a sequence icon when a currently executing or currently selected sequence exists. Otherwise, the image source displays an empty image. This image source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 13) Displays an image that indicates the currently executing or currently selected step group. This image source applies to the ExecutionView Manager and SequenceFileView Manager controls.

(Value: 14) Displays the icon for the current step in the current execution. This image source applies only to the ExecutionView Manager control.

(Value: 21) Displays an execution icon when a current execution exists. Otherwise, the image source displays an empty image. This image source applies only to the ExecutionView Manager control.

(Value: 22) Displays a thread icon when a current thread for the current execution exists. When no current thread exists, the image source displays an empty image. This image source applies only to the ExecutionView Manager control.

(Value: 23) Displays a call stack icon for the selected stack frame in the current execution thread. When no current thread exists, the image source displays an empty image. This image source applies only to the ExecutionView Manager control.

(Value: 24) Displays a sequence file icon when a process model exists for the currently executing or currently selected file. Otherwise, the image source displays an empty image. This image source applies to the ExecutionView Manager and SequenceFileView Manager controls.

These constants specify types of numeric sources. Each numeric source provides numeric values that describe an aspect of the current application state. You can use these constants to connect the execution progress state to a StatusBarPane progress indicator with the ExecutionViewMgr.ConnectNumeric method. To obtain a numeric value without connecting it to a control, call the ExecutionViewMgr.GetNumericValue method. A numeric source applies to all manager controls unless the help for the enumeration element specifies a particular manager control or controls with which it applies.

(Value: 0) Guaranteed to never be a valid numeric source specifier.

(Value: 10) A value from 0.0 to 100.0 that indicates the percentage of progress the current execution reports. This value indicates the progress of operations for which the execution chooses to report the amount of progress. The value does not necessarily reflect the progress of the execution as a whole. This numeric source applies only to the ExecutionView Manager control.

Use these constants with the ExpressionEdit.WantReturn and ExpressionEdit.WordWrap properties.

(Value: 1) Specifies a value of True.

(Value: 0) Specifies a value of False.

(Value: 3) Use the corresponding preference option in the Expression Editing Options dialog box.

Represents an item in the ListBarPage.

Returns the zero-based index of an item.

Specifies the icon name for an item.

TestStand User Interface Controls use the icon files in the <TestStand>\Components\Icons and <TestStand Public>\Components\Icons directories. To change an icon for any item, specify the name of the .ico file. Note: When you connect a ListBarPage to a manager control, the ListBarPage becomes read-only. Attempting to change the icon name results in an error.

Specifies the caption for an item.

Note: When you connect a ListBarPage to a manager control, the ListBarPage becomes read-only. Attempting to change the caption of an item in the page results in an error.

Specifies the tooltip for an item. When this property is an empty string, the item uses the ListBarPageItem.Caption property for the tooltip.

A collection of ListBarPageItem objects. Use the ListBarPage.Items property to retrieve a ListBarPageItems object. Use the ListBarPage.Cursor property to determine the selected item in the page.

Returns a reference to an item with the specified name or at the specified index in the collection.

You can pass a number to obtain a page item by its index value. You can also pass a string to obtain the page item using its name.

Returns the number of items in the collection.

Inserts a new item into the ListBarPage.

Note: When you connect a ListBarPage to a manager control, the ListBarPage becomes read-only. Attempting to change the content by calling this method results in an error. Specifies the caption for the new item. Specifies the name of the icon for the new item. Refer to the ListBarPageItem.IconName property for more information about naming icons for an item. Icon files are located in the <TestStand>\Components\Icons and <TestStand Public>\Components\Icons directories. Specifies the index of the existing item before which the new item is inserted. Pass -1 to insert the item at the end.

Use this method to delete an item on the page.

This method takes the numeric index of an item. Note: When the ListBarPage is connected to a manager control, you cannot remove any items from the page. Specifies the zero-based index of the item to remove.

Removes all items from the collection.

Note: When the ListBarPage object is connected to a manager control, you cannot remove any items from the page.

An EntryPoint object represents an Execution or Configuration entry point. You can execute the entry point sequence using the EntryPoint.LoopOnSelectedSteps, EntryPoint.Run, or EntryPoint.RunSelectedSteps methods. Use the ExecutionViewMgr.ConfigurationEntryPoints, ExecutionViewMgr.ExecutionEntryPoints, SequenceFileViewMgr.ConfigurationEntryPoints, and SequenceFileViewMgr.ExecutionEntryPoints properties to retrieve an EntryPoints object that is a collection of entry points.

Runs the entry point.

The new execution. Specifies the EditArgs object for the new execution. Use this parameter only to override the EditArgs object the SequenceFileView Manager control creates.

Starts an interactive execution that runs the selected steps using the entry point of the process model.

Use the EntryPoint.InteractiveExecutionAllowed property to determine whether you can call this method. The new interactive execution Specifies the InteractiveArgs objects for the new interactive execution. Use this parameter only to override the InteractiveArgs objects the SequenceFileView Manager control creates. Specifies the EditArgs object for the new interactive execution. Use this parameter only to override the EditArgs object the SequenceFileView Manager control creates.

Starts an interactive execution that loops on the selected steps using the entry point of the process model.

Use the EntryPoint.InteractiveExecutionAllowed property to determine whether you can call this method. The new interactive execution. Specifies an InteractiveArgs object for the new interactive execution. Use this parameter only to override the InteractiveArgs object the SequenceFileView Manager control creates. Specifies the EditArgs object for the new interactive execution. Use this parameter only to override the EditArgs object the SequenceFileView Manager control creates.

Returns the display name of the entry point.

Returns a Boolean value that indicates whether the entry point can be used to create an execution.

Use this value to update the enabled state of the control that might call the entry point. When you use a Button control connected to an entry point command source, the enabled state of the button updates automatically.

Returns True if interactive executions are permitted using this entry point.

When this property is True, you can call the EntryPoint.RunSelectedSteps or EntryPoint.LoopOnSelectedSteps methods.

Returns the sequence that defines this entry point.

Use this property to access additional information about the entry point you cannot obtain from properties or methods of the entry point. For example, use this property to determine whether the entry point is an Execution or a Configuration entry point.

Use these constants with the opts parameter of the ApplicationMgr.QueryShutdown event.

(Value: 0) The ApplicationMgr.Shutdown method continues shutdown and launches a dialog box if the method needs to terminate a running execution.

(Value: 1) The ApplicationMgr.Shutdown method continues shutdown. If the shutdown process cannot continue because of a running execution, the application generates an error.

(Value: 2) The ApplicationMgr.Shutdown method does nothing.

Use these constants to indicate which mouse button has been clicked for MouseDown, MouseMove, and MouseUp events.

(Value: 1) The left mouse button.

(Value: 2) The right mouse button.

(Value: 4) The middle mouse button.

Use these constants with the opt parameter of the ApplicationMgr.QueryCloseExecution event.

(Value: 0) Launches a dialog box if the execution is not terminated.

(Value: 1) Terminates the execution if it is running.

(Value: 4) Cancels the closing of an execution.

(Value: 3) Marks the execution to close automatically when it completes. The dialog box prompts the user to abort, auto-close, terminate, or cancel.

(Value: 2) Aborts the execution if it is running.

(Value: 5) Turns off tracing and hides the execution. The execution continues to run. If the execution hits a breakpoint, tracepoint, or run-time error, the execution displays again.

Use these constants with the opts parameter of the ExecutionViewMgr.ConnectExecutionView method.

(Value: 0) No options.

(Value: 1) The control connected to the ExecutionView Manager control does not change colors based on the execution state when this option is used.

Use these constants with controls that have a FontSource property.

(Value: 0) A corresponding Font property of the control determines the font.

(Value: 1) The default system font for user interface objects.

(Value: 2) The font the container supplies.

(Value: 3) The system font for a title bar.

(Value: 4) The system font for an inactive titlebar.

(Value: 5) The system font for an icon title.

(Value: 6) The system font for a menu.

(Value: 7) The system font for a message box.

(Value: 8) The system font for the title of a Tools window.

(Value: 9) The system font for the selected menu items.

(Value: 10) The system font for tooltips and status bars.

(Value: 11) The system font for monospaced text.

(Value: 12) The font the UIStyle object supplies.

These values are passed as a parameter to the ApplicationMgr.DisplaySequenceFile event to provide the reason for why the event was generated.

(Value: 0) The event was generated because the TestStand Engine sent the UIMsg_OpenWindows message for the sequence file.

(Value: 1) The event was generated because the sequence file was opened.

(Value: 3) The event was generated because of a request to display a location that resides in the file.

(Value: 2) The event was generated because a new sequence file was created.

These constants are passed as a parameter in the ApplicationMgr.DisplayExecution event to provide the reason for why the event was generated.

(Value: 5) Event occurred because of a request to display a location that resides in the execution.

(Value: 0) Event occurred because the TestStand Engine sent the UIMsg_OpenWindows message for the execution.

(Value: 1) Event occurred because the execution was started.

(Value: 2) Event occurred because the execution hit a breakpoint.

(Value: 3) Event occurred because the user paused the execution.

(Value: 4) Event occurred because the execution was paused as a result of a run-time error.

Use these constants with the ExpressionEdit.TextType property.

(Value: 0) Indicates the text in an ExpressionEdit control is not an expression. The value of the ExpressionEdit.Text property is equivalent to the value of the ExpressionEdit.DisplayText property. This value makes an ExpressionEdit control behave like an edit or text box control. The ExpressionEdit control does not use syntax highlighting, perform error checking, perform autocompletion, or display function tips. The ExpressionEdit control context menu contains only menu items for text editing.

(Value: 1) Indicates the text in an ExpressionEdit control is an expression.

(Value: 2) Indicates the text in an ExpressionEdit control is an expression that might contain C++ scope resolution and template operators.

Use these constants with the ExpressionEdit.DisplayError method.

(Value: 0x0) No options.

(Value: 0x1) Use this option to show or hide the error for all ExpressionEdit controls. This is useful when you modify a PropertyObject used as the context for several ExpressionEdit controls and you want those ExpressionEdit controls to re-evaluate their expressions for errors.

A Borders object specifies the frame and draggable borders that surround a control. A frame is a thin rectangle that surrounds a control on all sides. A draggable border is a rectangular strip of configurable thickness you can place on any combination of the edges of a control. When the application handles the BorderDragged event for the control, users can drag the borders to resize or move the control. When a control fills a rectangular view area of an application window, you can enable the draggable borders to implement splitter bars that resize the view. Although you can implement splitter bars in some environments without using draggable borders, some environments do not provide any other way to create a splitter bar. For other environments, creating a resizable view using draggable borders is sometimes simpler than using a separate splitter bar. You can also disable the BorderDragged event for a control to use borders for their cosmetic effect only.

Specifies which draggable borders the control displays.

Use any combination of the WhichBorders constants. Use the bitwise-OR operator to specify more than one value.

Specifies the width of the draggable borders the control displays.

Specifies the appearance of the draggable borders the control displays.

Specifies the appearance of the frame the control displays.

When this property is True, the control displays a thin rectangular frame that surrounds the control.

When this property is True, the control displays the frame within the draggable borders. When this property is False, the control displays the frame around the draggable borders.

When this property is True, the control displays a resizing cursor over the draggable borders, and the control generates BorderDragged events when the user drags a draggable border with the mouse.

Returns the vertical and horizontal thickness of the frame around the control. The values returned are based on the frame visibility and style.

Returns the thickness, in pixels, of the vertical portion of the frame. Returns the thickness, in pixels, of the horizontal portion of the frame.

The following constants specify the appearance of the edge of a control or a control element:

(Value: 1) The edge appears flat.

(Value: 2) The edge is a black line, one pixel thick.

(Value: 3) The edge has the appearance of a control edge. The appearance can vary depending on the Microsoft Windows appearance settings and on the specific property to which you apply this value.

(Value: 4) The edge has a raised three-dimensional appearance.

(Value: 5) The edge has a sunken three-dimensional appearance.

These constants specify the draggable borders of a control. The control can have borders on any combination of edges or it can have no borders at all. To specify multiple borders, combine these constants with a bitwise-OR operator.

(Value: 0x0) Specifies no borders.

(Value: 0x1) Specifies a border at the top edge of the control.

(Value: 0x2) Specifies a border at the bottom edge of the control.

(Value: 0x4) Specifies a border at the left edge of the control.

(Value: 0x8) Specifies a border at the right edge of the control.

These constants specify the state of the <Shift>, <Ctrl>, and <Alt> keys for the KeyDown, KeyUp, MouseDown, MouseUp, and MouseMove events.

(Value: 0x1) The <Shift> key is pressed.

(Value: 0x2) The <Ctrl> key is pressed.

(Value: 0x4) The <Alt> key is pressed.

(Value: 0x0) The <Shift>, <Ctrl>, and <Alt> keys are not pressed.

These constants specify the virtual key codes for the KeyDown and KeyUp events.

(Value: 0x0C) The Clear key.

(Value: 0x09) The Tab key.

(Value: 0x08) The Backspace key.

(Value: 0x03) The Cancel key.

(Value: 0x91) The Scroll Lock key.

(Value: 0x90) The Num Lock key.

(Value: 0x87) The F24 key.

(Value: 0x86) The F23 key.

(Value: 0x85) The F22 key.

(Value: 0x84) The F21 key.

(Value: 0x83) The F20 key.

(Value: 0x82) The F19 key.

(Value: 0x81) The F18 key.

(Value: 0x80) The F17 key.

(Value: 0x7F) The F16 key.

(Value: 0x7E) The F15 key.

(Value: 0x7D) The F14 key.

(Value: 0x7C) The F13 key.

(Value: 0x7B) The F12 key.

(Value: 0x7A) The F11 key.

(Value: 0x79) The F10 key.

(Value: 0x78) The F9 key.

(Value: 0x77) The F8 key.

(Value: 0x76) The F7 key.

(Value: 0x75) The F6 key.

(Value: 0x74) The F5 key.

(Value: 0x73) The F4 key.

(Value: 0x72) The F3 key.

(Value: 0x71) The F2 key.

(Value: 0x70) The F1 key.

(Value: 0x6F) The Divide key.

(Value: 0x6E) The Decimal key.

(Value: 0x6D) The Subtract key.

(Value: 0x6C) The Separator key.

(Value: 0x6B) The Add key.

(Value: 0x6A) The Multiply key.

(Value: 0x69) The numeric keypad 9 key.

(Value: 0x68) The numeric keypad 8 key.

(Value: 0x67) The numeric keypad 7 key.

(Value: 0x66) The numeric keypad 6 key.

(Value: 0x65) The numeric keypad 5 key.

(Value: 0x64) The numeric keypad 4 key.

(Value: 0x63) The numeric keypad 3 key.

(Value: 0x62) The numeric keypad 2 key.

(Value: 0x61) The numeric keypad 1 key.

(Value: 0x60) The numeric keypad 0 key.

(Value: 0x5D) The Applications key.

(Value: 0x5C) The Right Microsoft Windows key.

(Value: 0x5B) The Left Microsoft Windows key.

(Value: 0x5A) The Z key.

(Value: 0x59) The Y key.

(Value: 0x58) The X key.

(Value: 0x57) The W key.

(Value: 0x56) The V key.

(Value: 0x55) The U key.

(Value: 0x54) The T key.

(Value: 0x53) The S key.

(Value: 0x52) The R key.

(Value: 0x51) The Q key.

(Value: 0x50) The P key.

(Value: 0x4F) The O key.

(Value: 0x4E) The N key.

(Value: 0x4D) The M key.

(Value: 0x4C) The L key.

(Value: 0x4B) The K key.

(Value: 0x4A) The J key.

(Value: 0x49) The I key.

(Value: 0x48) The H key.

(Value: 0x47) The G key.

(Value: 0x46) The F key.

(Value: 0x45) The E key.

(Value: 0x44) The D key.

(Value: 0x43) The C key.

(Value: 0x42) The B key.

(Value: 0x41) The A key.

(Value: 0x39) The 9 key.

(Value: 0x38) The 8 key.

(Value: 0x37) The 7 key.

(Value: 0x36) The 6 key.

(Value: 0x35) The 5 key.

(Value: 0x34) The 4 key.

(Value: 0x33) The 3 key.

(Value: 0x32) The 2 key.

(Value: 0x31) The 1 key.

(Value: 0x30) The 0 key.

(Value: 0x2F) The Help key.

(Value: 0x2E) The Delete key.

(Value: 0x2D) The Insert key.

(Value: 0x2C) The Snapshot key.

(Value: 0x2B) The Execute key.

(Value: 0x2A) The Print key.

(Value: 0x29) The Select key.

(Value: 0x28) The Down Arrow key.

(Value: 0x27) The Right Arrow key.

(Value: 0x26) The Up Arrow key.

(Value: 0x25) The Left Arrow key.

(Value: 0x24) The Home key.

(Value: 0x23) The End key.

(Value: 0x22) The Page Down key.

(Value: 0x21) The Page Up key.

(Value: 0x20) The Space key.

(Value: 0x1F) The IME Mode Change Request key.

(Value: 0x1E) The Input Method Editor (IME) Accept key.

(Value: 0x1D) The IME Nonconvert key.

(Value: 0x1C) The IME Convert key.

(Value: 0x1B) The Escape key.

(Value: 0x19) The Kanji key.

(Value: 0x19) The Hanja key.

(Value: 0x18) The Final key.

(Value: 0x17) The Junja key.

(Value: 0x15) The Hangul key.

(Value: 0x15) The Hangeul key.

(Value: 0x15) The Kana key.

(Value: 0x14) The Caps Lock key.

(Value: 0x13) The Pause key.

(Value: 0x12) The Alt key.

(Value: 0x11) The Ctrl key.

(Value: 0x10) The Shift key.

(Value: 0x0D) The Enter key.

Use these constants with the SequenceView.BlockDisplayOptions property.

(Value: 0x0) No options.

(Value: 0x1) Indents the steps within a block.

(Value: 0x2) Draws a vertical bar to the left of the steps in a block.

(Value: 0x4) Draws the vertical bar to the left of the block with a dotted line.

(Value: 0x8) Displays icons for steps that define or operate according to the block structure of the sequence.

(Value: 0x10) Displays the step name in bold for steps that define or operate according to the block structure of the sequence.

(Value: 0x20) Draws the step name in red for steps that start blocks that do not have an End step and for block ending steps that do not match with a block starting step. Also draws the vertical block bar red for blocks that do not have an ending step.

(Value: 0x40) Draws a vertical bar to the left of the steps in a step group.

Connect a manager control to a CheckBox control so users can toggle the state of a common user interface command, such as Break on Step Failure. When you connect to a command, the CheckBox control automatically updates the caption text, visibility, and enabled state. When you enable the checkbox, the checkbox executes the command, which toggles the state of the command. The CheckBox control supports the following commands: * CommandKind_BreakonFirstStep * CommandKind_BreakonSequenceFailure * CommandKind_BreakonStepFailure * CommandKind_ToggleBreakPoint * CommandKind_TracingEnabled

The control responds to user input only when this property is True.

Specifies the font for the control when the value of the CheckBox.FontSource property is FontSource_UseFontProperty.

Specifies the background color for the control. This property does not change the appearance of a control when you set the CheckBox.Style property to CheckBoxStyle_Button.

Specifies the foreground color for the CheckBox control. This property does not change the appearance of a control when you set the CheckBox.Style property to CheckBoxStyle_Button.

Specifies the text the control displays.

In the caption, include an ampersand (&) immediately before the character, if any, you want to designate as an accelerator character. The character displays as underlined. Press <Alt> and click the underlined character to move the focus to the control. To include an ampersand character in a caption without creating an accelerator character, include two consecutive ampersands. A single ampersand displays in the caption and no characters display as underlined. When you connect this control to a manager control, the manager control sets this property automatically.

Specifies the text the control displays.

In the caption, include an ampersand (&) immediately before the character, if any, you want to designate as an accelerator character. The character displays as underlined. Press <Alt> and click the underlined character to move the focus to the control. To include an ampersand character in a caption without creating an accelerator character, include two consecutive ampersands. A single ampersand displays in the caption and no characters display as underlined. When you connect this control to a manager control, the manager control sets this property automatically.

Returns a Window handle for the CheckBox control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns a Window handle for the CheckBox control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Specifies a custom graphic for the CheckBox control.

This property is used only when the style of the control is CheckBoxStyle_Button. Use the Engine.Images property to obtain the TestStand images collection, and use the Images.FindImage method to obtain a particular image reference. Icon files are located in the <TestStand>\Components\Icons and <TestStand Public>\Components\Icons directories.

Specifies a custom graphic for the CheckBox control.

Specifies the horizontal and vertical alignment of text on a CheckBox control.

When the style of the control is CheckBoxStyle_Normal, the control supports only the ContentAlignmentStyle_MiddleLeft and ContentAlignmentStyle_MiddleRight values.

Specifies the horizontal and vertical alignment of text on a CheckBox control.

When the style of the control is CheckBoxStyle_Normal, the control supports only the ContentAlignmentStyle_MiddleLeft and ContentAlignmentStyle_MiddleRight values.

Specifies a value that indicates whether the CheckBox control is in the checked state.

Returns True when the CheckBox control is in the checked state. Otherwise, returns False.

Specifies a value that indicates whether the CheckBox control is in the checked state.

Returns True when the CheckBox control is in the checked state. Otherwise, returns False.

The control uses the color the CheckBox.MaskColor property specifies as a mask color when this property is True. You can use the mask color to create transparent regions.

This property is used only when the style of the control is CheckBoxStyle_Button.

The control uses the color the CheckBox.MaskColor property specifies as a mask color when this property is True. You can use the mask color to create transparent regions.

This property is used only when the style of the control is CheckBoxStyle_Button.

Specifies a color in the picture of the control as a mask color. You can use the mask color to create transparent regions.

The color specified is used as a mask color when the CheckBox.UseMaskColor property is True. This property is used only when the style of the control is CheckBoxStyle_Button.

Specifies a color in the picture of the control as a mask color. You can use the mask color to create transparent regions.

The color specified is used as a mask color when the CheckBox.UseMaskColor property is True. This property is used only when the style of the control is CheckBoxStyle_Button.

Specifies the appearance of the control.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty if you expect the font the CheckBox.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies the font the control uses. The default value for this property is FontSource_UseGUIFont.

When the value of this property is FontSource_UseFontProperty, the corresponding Font property specifies the particular font the control uses. Otherwise, the control uses the font from the source this property specifies. Refer to the FontSources enumeration for the list of valid font sources. Set this property to a value other than FontSource_UseFontProperty if you expect the font the CheckBox.Font property specifies to not be present on a computer at run time. For example, a font present on an English version of the Microsoft Windows operating system might not be present on a Japanese version of the Windows operating system.

Specifies how the control scales based on the dots per inch (DPI) setting.

Specifies the horizontal and vertical alignment of an Image on a CheckBox control.

This property is used only when the style of the control is CheckBoxStyle_Button.

Specifies the horizontal and vertical alignment of an Image on a CheckBox control.

This property is used only when the style of the control is CheckBoxStyle_Button.

Localizes the text caption on the button in this control.

Occurs when you press and release the mouse on the control or when the checked state of the control changes.

Occurs when the user presses a key while the control has the input focus. This event occurs before the CheckBox.KeyPress event.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user presses a key while a control is active. This event occurs after the CheckBox.KeyDown event.

Specifies the ASCII value of the pressed key.

Occurs when the user releases a key while the control has the input focus.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Occurs when the user clicks the mouse on the control.

Occurs when the user moves the mouse over the control.

Occurs when the user releases the mouse on the control.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

An ExpressionEditButton can be a non-custom button, such as an Expression Browser button, which the ExpressionEdit control manages automatically. An ExpressionEditButton can also be a custom button. You can manage the custom button using the properties of an ExpressionEditButton.

The control responds to user-generated events only when this property is True.

The ExpressionEdit button is disabled when this property is False or the ExpressionEdit.Enabled property is False.

Returns the Window handle of the ExpressionEdit button.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Specifies the picture the ExpressionEdit button displays.

To programmatically add an icon to a custom button, store the icon in the <TestStand Public>\Components\Icons directory and use the following pseudocode to set the image to use: ExpressionEditButton.Icon = (stdole.IPictureDisp)Engine.Images.FindImage("MyIcon.ico", 16, 16)

Specifies the type of ExpressionEdit button. Use the ExpressionEditButtonKinds constants with this property.

Specifies the tooltip for the ExpressionEdit button.

Set this property to a non-empty string to create a menu item in the ExpressionEdit control context menu for the ExpressionEdit button. Selecting the context menu item is equivalent to clicking the ExpressionEdit button.

Note: The Browse and Check for Errors context menu items do not correspond to the Browse Expression and Check Expression buttons on the ExpressionEdit control. The default ContextMenuItemCaption property for the Browse Expression and Check Expression buttons is empty.

Specifies a keyboard shortcut for clicking the ExpressionEdit button when the ExpressionEdit control is active.

Specifies modifiers for a keyboard shortcut for clicking the ExpressionEdit button. Use any combination of the ShortcutModifiers constants.

Specifies whether the button is visible.

Specifies the background color for the ExpressionEdit button.

Specifies the appearance of the button.

Call this method to simulate a button click.

You can call this method to simulate a button click when the button is disabled or invisible.

A collection of ExpressionEditButton objects. Use the ExpressionEdit.Buttons property to retrieve the ExpressionEditButtons object for an ExpressionEdit control.

Returns the ExpressionEdit button at the specified index or of the specified kind.

When you pass SpecifyButton_ByIndex as the specify parameter, indexOrKind is the zero-based index of the button to return. When you pass SpecifyButton_ByKind, the first button in the collection with a kind of indexOrKind is returned or NULL is returned when no button with a kind of indexOrKind exists. Specifies whether indexOrKind is a button index or a button kind.

Returns the number of items in the collection.

Removes all items from the collection.

Adds a new item to the collection.

The button added to the collection. Specifies the zero-based index where the new button is inserted. Pass -1 to insert the ExpressionEdit button at the end of the collection. Use the ExpressionEditButtonKinds constants to specify what kind of ExpressionEdit button is created.

Removes the specified item from this collection, if it exists.

When you pass SpecifyButton_ByIndex as the specify parameter, indexOrKind is the zero-based index of the button to remove from the collection. When you pass SpecifyButton_ByKind, all buttons with a kind of indexOrKind are removed from the collection. Specifies whether indexOrKind is a button index or a button kind.

An ExpressionEditComboBoxItem is an item that appears in the drop-down list when the ExpressionEdit control is a combo box.

Specifies the picture that appears in the drop-down list for this item.

Specifies an expression that replaces the text in the ExpressionEdit control when the user selects this item in the drop-down list. The value appears in the drop-down list when the ExpressionEditComboBoxItem.DisplayName property is empty.

When this property is not empty, the display name is shown in the drop-down list instead of the ExpressionEditComboBoxItem.Value property. When you choose this item in the drop-down list, the ExpressionEditComboBoxItem.Value property, not the display name, replaces the existing text. This property is useful for displaying a simple name for a complex expression in the drop-down list.

A collection of ExpressionEditComboBoxItem objects. Use the ExpressionEdit.ComboBoxItems property to retrieve the ExpressionEditComboBoxItems for an ExpressionEdit control.

Returns a reference to an item at the specified index in the collection.

Specifies the zero-based index of the item to return.

Returns the number of items in the collection.

Removes all items from the drop-down list.

Adds a new ExpressionEditComboBoxItem in the drop-down list.

The item added to the drop-down list. Specifies the zero-based index where the new item is inserted. Pass -1 to insert the item at the end of the drop-down list. Specifies the ExpressionEditComboBoxItem.Value property of the new item. This value appears in the drop-down list when the displayName parameter is empty. Specifies the ExpressionEditComboBoxItem.DisplayName property of the new item. When this value is not empty, the display name is shown in the drop-down list for the item instead of the val parameter. Display names are useful for displaying a simple name for a complex expression in the drop-down list. Specifies the ExpressionEditComboBoxItem.Icon property of the new item. This method makes a copy of the picture you pass. You can use the ExpressionEditComboBoxItem.Icon property to either use a picture directly or make a copy of a picture.

Removes an item from the drop-down list.

Specifies the zero-based index of the item to remove from the drop-down list.

Use these constants to specify the alignment of content on the drawing surface.

(Value: 0) Content is vertically aligned in the middle and horizontally aligned on the left.

(Value: 1) Content is vertically aligned in the middle and horizontally aligned on the right.

(Value: 2) Content is vertically aligned in the middle and horizontally aligned in the center.

(Value: 3) Content is vertically aligned at the top and horizontally aligned on the left.

(Value: 4) Content is vertically aligned at the top and horizontally aligned on the right.

(Value: 5) Content is vertically aligned at the top and horizontally aligned in the center.

(Value: 6) Content is vertically aligned at the bottom and horizontally aligned on the left.

(Value: 8) Content is vertically aligned at the bottom and horizontally aligned in the center.

(Value: 7) Content is vertically aligned at the bottom and horizontally aligned on the right.

Use these constants with CheckBox.Style to specify the style of the CheckBox control.

(Value: 0) Specifies that the CheckBox control is normal in appearance.

(Value: 1) Specifies that the CheckBox control is a toggle button that you can toggle to an up or down state.

Use these constants with the ExpressionEditButtons.Insert method and the ExpressionEditButton.Kind property.

(Value: 1) This kind of button calls the ExpressionEdit.DisplayBrowseExprDialog method. The ExpressionEditButton.Enabled, ExpressionEditButton.Icon, ExpressionEditButton.ToolTipText, and ExpressionEditButton.Visible properties are managed automatically for this kind of button.

(Value: 2) This kind of button calls the ExpressionEdit.CheckExpression method and displays the result in a dialog box. The ExpressionEditButton.Enabled, ExpressionEditButton.Icon, ExpressionEditButton.ToolTipText, and ExpressionEditButton.Visible properties are managed automatically for this kind of button.

(Value: 1000) Use constants starting at ExpressionEditButtonKind_CustomBase to define custom buttons. You define the behavior and appearance of custom buttons yourself. Use the ExpressionEdit.ButtonClick event to respond to button clicks.

Use these constants with the ExpressionEdit.Style property to specify the appearance of the control and how the control operates.

(Value: 0) Specifies that the ExpressionEdit control is an edit control.

(Value: 1) Specifies that the ExpressionEdit control is a combo box control.

Use these constants with the opt parameter of the ApplicationMgr.QueryReloadSequenceFile event.

(Value: 0) The Application Manager control prompts the user to reload the sequence file.

(Value: 1) The Application Manager control reloads the sequence file.

(Value: 2) The Application Manager control does not reload the sequence file.

Use these constants with the ExpressionEditButtons.GetItem and ExpressionEditButtons.Remove methods.

(Value: 0) The indexOrKind parameter is a zero-based index of a button.

(Value: 1) The indexOrKind parameter is an ExpressionEditButtonKinds constant.

Connect a SequenceFileView Manager or an ExecutionView Manager control to a VariablesView control to display the variables and properties in the selected file or execution. You can modify values of existing properties and variables, and you can insert and delete variables when editing a sequence file.

Occurs when you drag a draggable border of a control. This event provides the location and size to which you must set the control for the draggable borders to track the mouse cursor. However, you can choose to modify the location or size to which you set the control. For example, you can limit the width of the control so the left edge of the control cannot be dragged off of the visible portion of the window. In addition to changing the size and position of the control, you can also update the sizes and positions of the other controls on the window to account for the change.

If you are using LabVIEW, you must add the Horizontal and Vertical components of the origin of the LabVIEW front panel to the newX and newY event parameter values before you can use the newX and newY event parameters to set the ActiveX Container (AxCont) Left and Top properties for the control. To obtain the origin of a LabVIEW front panel, place an ActiveX property node on the block diagram of the VI, right-click the node, and select Link to»Pane from the context menu. Right-click the node again and select Select Property»Origin. Specifies which borders you dragged. Refer to the WhichBorders constants for more information about draggable borders. Specifies the new x-coordinate for the control Specifies the new y-coordinate for the control. Specifies the new width for the control. Specifies the new height for the control. Specifies whether the event is the final event for the drag operation the user performs.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

Specifies how the control scales based on the dots per inch (DPI) setting.

Some environments scale native controls based on the DPI settings of their display, while other environments do not. The TestStand User Interface Controls are designed to work in all environments. National Instruments recommends the following settings for various platforms: * LabVIEW, LabWindows/CVI, C#, and Microsoft Visual Basic .NET—Set this property to False. * Active Template Library (ATL)/Microsoft Foundation Class (MFC)—Set this property to True.

Specifies how the control scales based on the dots per inch (DPI) setting.

Some environments scale native controls based on the DPI settings of their display, while other environments do not. The TestStand User Interface Controls are designed to work in all environments. National Instruments recommends the following settings for various platforms: * LabVIEW, LabWindows/CVI, C#, and Microsoft Visual Basic .NET—Set this property to False. * Active Template Library (ATL)/Microsoft Foundation Class (MFC)—Set this property to True.

The control responds to user-generated events only when this property is True.

When you connect this control to a manager control, the manager control automatically sets this property.

The control responds to user-generated events only when this property is True.

When you connect this control to a manager control, the manager control automatically sets this property.

Returns a Window handle for the control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns a Window handle for the control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns the frame and draggable borders that surround the control.

Occurs when the user presses any key while the control has the input focus.

Specifies the KeyCodes constant of the key the user pressed. Specifies a combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Connect a SequenceFileView Manager control to an InsertionPalette control so users can insert steps and template items into a sequence file by dragging or double-clicking. Select Customize from the context menu of the Step Types list to launch the Step Type Menu Editor dialog box, in which you can customize the structure of the menu. You can add sequences, steps, or variables to the Templates list by dragging sequences, steps, or variables to the InsertionPalette control from a ListBox, ListBar, SequenceView, or VariablesView control. You can rename, copy, paste, delete, import, and export the items in the Templates list using the context menu, and you can rearrange the items using drag and drop. You can use one of the following operations to insert a step from the Step Types list or a sequence, step, or variable from the Templates list to a user interface control that displays a list of the corresponding object type: * Double-click an item in the InsertionPalette control. TestStand inserts the item below the current step, sequence, or variable depending on the type of the item. * Select an item in the InsertionPalette control and press <Enter>. TestStand inserts the item below the current step, sequence, or variable depending on the type of the item. * Right-click an item in the InsertionPalette control and select Insert from the context menu. TestStand inserts the item below the current step, sequence, or variable depending on the type of the item. * Drag an item from the InsertionPalette control and drop the item in the corresponding user interface control that contains a list of the type of items.

The control responds to user-generated events only when this property is True.

When you connect this control to a manager control, the manager control automatically sets this property.

The control responds to user-generated events only when this property is True.

When you connect this control to a manager control, the manager control automatically sets this property.

Returns a Window handle for the control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns a Window handle for the control.

You can use the returned Window handle with the Microsoft Windows API functions. Note: Using Windows API functions with this property can cause undefined behavior.

Returns the frame and draggable borders that surround the control.

Specifies how the control scales based on the dots per inch (DPI) setting.

Some environments scale native controls based on the DPI settings of their display, while other environments do not. The TestStand User Interface Controls are designed to work in all environments. National Instruments recommends the following settings for various platforms: * LabVIEW, LabWindows/CVI, C#, and Microsoft Visual Basic .NET—Set this property to False. * Active Template Library (ATL)/Microsoft Foundation Class (MFC)—Set this property to True.

Specifies how the control scales based on the dots per inch (DPI) setting.

Some environments scale native controls based on the DPI settings of their display, while other environments do not. The TestStand User Interface Controls are designed to work in all environments. National Instruments recommends the following settings for various platforms: * LabVIEW, LabWindows/CVI, C#, and Microsoft Visual Basic .NET—Set this property to False. * Active Template Library (ATL)/Microsoft Foundation Class (MFC)—Set this property to True.

If you are using LabVIEW, you must add the Horizontal and Vertical components of the origin of the LabVIEW front panel to the newX and newY event parameter values before you can use the newX and newY event parameters to set the ActiveX Container (AxCont) Left and Top properties for the control. To obtain the origin of a LabVIEW front panel, place an ActiveX property node on the block diagram of the VI, right-click the node, and select Link to»Pane from the context menu. Right-click the node again and select Select Property»Origin. Specifies which borders you dragged. Refer to the WhichBorders constants for more information about draggable borders. Specifies the new x-coordinate for the control. Specifies the new y-coordinate for the control. Specifies the new width for the control. Specifies the new height for the control. Specifies whether the event is the final event for the drag operation the user performs.

Occurs after the connection to a manager control makes a change to a user interface control.

Specifies the type of change.

Occurs when the user presses any key while the control has the input focus.

Specifies the KeyCodes constant of the key the user pressed. A combination of the KeyModifiers constants that specifies the state of the <Shift>, <Ctrl>, and <Alt> keys.

Specifies whether you can modify the templates list and step types list panels of the control.

Specifies a serialized string you use to persist the layout of the control. Use the serialized string to later restore the layout of the control.

The layout information is composed of the state of the nodes in the Step Types list and the Templates list on the Insertion Palette pane, including information about the selected nodes and whether the nodes are expanded or collapsed.

Specifies a serialized string you use to persist the layout of the control. Use the serialized string to later restore the layout of the control.

Returns a collection of the InsertionPalette pages.

Use these constants with the ApplicationMgr.AutomaticallyReloadModifiedFiles property.

(Value: 1) Specifies that the Application Manager control never calls the ApplicationMgr.ReloadModifiedSequenceFilesEx method. You must call the ApplicationMgr.ReloadModifiedSequenceFilesEx method to reload modified sequence files.

(Value: 2) Specifies that the Application Manager control calls the ApplicationMgr.ReloadModifiedSequenceFilesEx method at the interval you specify with the ApplicationMgr.ReloadModifiedFilesInterval property.

(Value: 3) Specifies that the Application Manager control calls the ApplicationMgr.ReloadModifiedSequenceFilesEx method when you activate the application.

The ExpressionEdit control passes one of these constants as the reason parameter to the ExpressionEdit.ContextChanged event to specify why the ExpressionEdit control generated the ExpressionEdit.ContextChanged event.

(Value: 1) Specifies that the application programmatically set the ExpressionEdit.Context property to a new value.

(Value: 2) Specifies that the user modified the context the ExpressionEdit.Context property specifies when creating a variable through the context menu in the ExpressionEdit control.

(Value: 3) Specifies that the user modified the context the ExpressionEdit.Context property specifies through the context menu in the Expression Browser dialog box. A user can rename, insert, or delete properties. This constant is not set when the user modifies only the value of a variable or property.

This data type contains values that specify the type of change or refresh the connection to a manager control makes to a user interface control. Use these values with a ConnectionActivity event.

(Value: 1) The connection changed or refreshed the text of the control.

(Value: 2) The connection changed or refreshed the numerical value of the control.

(Value: 3) The connection changed or refreshed the Boolean value of the control.

(Value: 4) The connection changed or refreshed an image the control displays.

(Value: 5) The connection changed or refreshed the contents of the control, such as the available items in a Listbox, Combobox, ReportView, or ListBarPage.

(Value: 6) The connection changed or refreshed the cursor or selection in the control.

(Value: 7) The connection changed or refreshed the enabled state of the control.

(Value: 8) The connection changed or refreshed the visibility of the control.

This data type contains values that indicate reasons why an editing action cannot take place. Use these constants with the ApplicationMgr.BeginEdit and ApplicationMgr.CanEdit events.

(Value: 0x1) Editing is blocked because the file to edit is read-only.

(Value: 0x2) Editing is blocked because the value of the ApplicationMgr.IsEditor property is False.

(Value: 0x4) Editing is blocked because the file to edit is executing.

(Value: 0x8) Editing is blocked because the file to edit is locked.

(Value: 0x10) Editing is blocked because the current user does not have privileges to edit the file.

Use these constants with the ApplicationMgr.Refresh method.

(Value: 0xFFFFFFFF) Refresh all controls connected to any manager control.

(Value: 0x1) Refresh all controls connected to any SequenceFileView Manager control.

(Value: 0x2) Refresh all controls connected to any ExecutionView Manager control.

(Value: 0x4) Refresh all commands connected to the Application Manager control.

(Value: 0x8) Refresh all captions connected to the Application Manager control.

(Value: 0x10) Refresh all commands connected to any manager control.

(Value: 0x20) Refresh all captions connected to any manager control.

(Value: 0x40) Refresh the connected adapter list.

(Value: 0x80) Refresh the ApplicationMgr.ExecutionEntryPoints and ApplicationMgr.ConfigurationEntryPoints properties.

Use these constants with the ExpressionEditButton.Style property.

(Value: 1) The button looks like a standard button for the operating system of the user.

(Value: 2) The button is three-dimensional.

(Value: 3) The button is flat.

(Value: 4) This style is the same as ExpressionEditButtonStyle_System except when the application supports Microsoft Windows XP themes, the button has no border when you hover over the button.

Use these constants with ExecutionViewMgr.StepGroupMode to specify how to display step groups.

(Value: 1) Displays only one step group.

(Value: 2) Displays the Setup, Main, and Cleanup step groups.

This data type contains values that specify general editing capabilities you can selectively enable for certain controls.

(Value: 0x7) Cut, Paste, and Delete operations are allowed, when applicable.

(Value: 16) Drag and Drop operations are allowed, when applicable.

(Value: 32) You can rename items, when applicable.

(Value: 8) Copy operation is allowed, when applicable.

Use these constants with the Button.Style property to specify the appearance of the button and how the button operates.

(Value: 1) The button displays a three-dimensional border.

(Value: 2) You cannot tab to the button. When the application supports Microsoft Windows XP themes, the button displays a border only when you hover over it.

Use these constants with Button.TextImageRelation to specify how to display the image in relation to the text.

(Value: 0) Displays the image behind the text.

(Value: 1) Displays the image below the text.

(Value: 2) Displays the image above the text.

(Value: 3) Displays the image to the left of the text.

(Value: 4) Displays the image to the right of the text.

Use these constants with Button.ActionStyle to specify how the button behaves when you click it.

(Value: 0) Specifies that the button changes to a pressed state only when you click it.

(Value: 1) Specifies that the button changes to a pressed state when you set the Button.Value property to True and changes to a normal state when you set the value to False.

The ListBoxColumn object represents a visible column in the ListBox control. Use the ListBox.ColumnSet property to obtain a list of columns for the control. When using a SequenceListConnection, use the SequenceListConnection.GetColumnIndex and SequenceListConnection.SetColumnVisible methods to determine the columns the ListBox control displays and the index for each column in ListBoxColumns.

Returns the zero-based numeric index of the column within the ListBoxColumns collection.

Specifies the width of the column in pixels.

Specifies whether the column automatically grows or shrinks to adjust to changes in the size of the control. This property does not take effect unless the ListBox.AutoSizeColumns property is True.

Returns the caption in the header for the column.

A collection of ListBoxColumn objects. Use the ListBox.ColumnSet property to obtain a collection of columns for a ListBox control.

Returns a reference to an item at the specified index in the collection.

Pass the zero-based index of the column to return.

Returns the number of items in the collection.

Use these constants with the SeqViewColumn.Autosizing and ListBoxColumn.Autosizing properties.

(Value: 0) The item does not automatically resize itself.

(Value: 1) The item resizes when the container resizes. The item determines the amount to resize from the proportion that the current size occupies of the total size of all resizable items in the same container.

Use these constants in the ApplicationMgr.ProcessUserCommandLineArguments event to specify an error that occurs while processing the command line.

(Value: 0) Specifies that no error occurred while processing the command line.

(Value: 1) Specifies that you encountered an unrecognized command-line argument while processing the command line.

(Value: 2) Specifies that an error you define occurred while processing the command line.

Use an InsertionPalettePage object to control whether a page is expanded or visible on an InsertionPalette control.

Returns the zero-based index of the page on the InsertionPalette.

Specifies whether the page is visible.

Specifies the percentage of the InsertionPalette the page uses. Changes to this property affect this property for other pages. Note: This property is valid only when pages exist after the current page. In all other cases, this property is ignored.

Specifies whether the content of the page is expanded to show the list.

A collection of InsertionPalettePage objects. Use the InsertionPalette.Pages property to retrieve the InsertionPalettePages object for an InsertionPalette. Use the InsertionPalettePage.Visible property to control whether the page is visible.

Returns a reference to an item at the specified index in the collection.

Specifies the zero-based index of the item.

Returns the number of items in the collection.

Use these constants with the ApplicationMgr.ReloadFile method.

(Value 0x1) Use this option when you want to make reloading occur conditionally based on whether the file has been modified on disk since the user was last prompted to reload it. You can combine this option with ReloadFileOption_OnlyIfModifiedInMemory.

(Value 0x2) Use this option when you want to make reloading occur conditionally based on whether the file is modified in memory. You can combine this option with ReloadFileOption_OnlyIfModifiedOnDisk.

(Value 0x0) No options.