0% found this document useful (0 votes)
124 views

Test Stand U I Controls Reference Poster

Test Stand

Uploaded by

Brian Tejeda
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
124 views

Test Stand U I Controls Reference Poster

Test Stand

Uploaded by

Brian Tejeda
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 1

REFERENCE POSTER

Legend Manager Controls View Controls Text Display Controls


NI TestStand
TM

Control  A visible or invisible ActiveX component that you use on user interface windows.
Object A programmable software component representing an instance of a class. You Manager controls call the TestStand API to perform tasks such as loading files, launching executions, and editing and retrieving sequence information. Manager Connect a SequenceFileView Manager An ExpressionEdit control allows you to edit a TestStand expression with the convenience of syntax coloring,
controls also notify you when application events occur, such as when a user logs in, an execution reaches a breakpoint, or a user changes the file or sequence or an ExecutionView Manager control

User Interface Controls


popup help, and statement completion.
interact with the object using the methods, properties, and events that the class that they are viewing. These controls are visible at design time but invisible at run time. Use an Application Manager control to perform basic operations that are to a SequenceView control to display
Connect a manager control to an ExpressionEdit control in a custom sequence editor to allow users to view and
defines. necessary to use the TestStand Engine in your application. Your application must have a single Application Manager control that exists for the duration of the the steps of a sequence from a
edit expressions. In a user interface, connect a manager control to a read-only ExpressionEdit control to
application. Use a SequenceFileView Manager control to manage how visible TestStand UI Controls view, edit, and interact with a selected sequence file. Your selected file or execution. Connect an
automatically display text information about the application state, such as the pathname of the selected
Property A container of information, which stores and maintains a setting or attribute of 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 allow ExecutionView Manager control to a
sequence file or the name of the current user.
a user to select the current sequence file. Use an ExecutionView Manager control to manage how visible TestStand UI Controls view and interact with a ReportView control to display the report
an object. A property can contain a single value, an array of values of the same selected TestStand execution. Your application must have one ExecutionView Manager control for each location, such as a window, form, or panel, in which you for the selected execution. Connect a manager control to panes of a StatusBar control to display text, image, or progress information about
type, or no value at all. display an execution or allow a user to select the current execution. Connect a SequenceFileView Manager
the application state. Connect a manager control to a Label control to automatically display text information
Overview (Read Only) Properties that can be read but not changed.  ApplicationMgr Logout
 ExecutionViewMgr  SequenceFileViewMgr
control to an InsertionPalette control
for inserting steps in sequences.
about the application state in the label.

NewCommands
The NI TestStand User Interface (UI) Controls are a set of ActiveX controls The TestStand UI Controls greatly reduce the need for an application to Properties OpenSequenceFile Properties Properties Connect a SequenceFileView Manager  ExpressionEdit ButtonClick MousePointer
that implement the common functionality operator interfaces and custom directly call the TestStand API. However, you can still call the TestStand Method Performs an operation or function on an object. ApplicationWillExitOnStart (Read Only) OpenSequenceFileDialog ApplicationMgr (Read Only) ApplicationMgr (Read Only) or an ExecutionView Manager control Properties
Change ScaleWithDPI
CheckExpression UseMnemonic
sequence editors need in order to display, execute, edit, and debug test API directly on objects you create or obtain from the TestStand UI Controls AutomaticallyReloadModifiedFiles OpenSequenceFilesDialog ConfigurationEntryPoints (Read Only) ConfigurationEntryPoints (Read Only) to a VariablesView control to display AllowEmpty Click WordWrap
sequences. These ActiveX controls greatly reduce the amount of source properties, methods, or events. If you call the TestStand API from a user
Event Method that an object invokes to inform a client application of a status or state BreakOnFirstStep RaiseError Connections (Read Only) Connections (Read Only)
variables and properties. AutoCompletionHwnd (Read Only) ConnectionActivity
BreakOnSequenceFailure Refresh Execution ExecutionEntryPoints (Read Only) Method
change. AutomaticallyPrefixVariables ContextChanged
code a user interface application requires. interface that uses the TestStand UI Controls, follow the guidelines listed BreakOnStepFailure RefreshAllViewMgrs ExecutionEntryPoints (Read Only) ReplaceSequenceFileOnClose Localize
BackColor ContextMenuItemClick
CommandLineArguments (Read Only) ReplaceExecutionOnClose SelectedPropertyObjects (Read Only)
The TestStand UI Controls are divided into two categories: manager
in the Using the TestStand API with TestStand UI Controls section of
Collection An object that contains zero or more objects of the same class. CommandLineCanChangeEditMode
RefreshFile
ReloadConfigFile RunState (Read Only) SelectedSequences (Read Only) InsertionPalette Borders (Read Only)
BrowseExprDialogOptions
CreateContextMenu
DblClick
Events
Change
Chapter 9, Creating Custom User Interfaces, in the NI TestStand Reference ConfigFile (Read Only) ReloadFile SelectedPropertyObjects (Read Only) SelectedSteps (Read Only) Properties
controls and visible controls. This poster describes the visible controls— BrowseExprDialogTitle DropDown Click
Manual. ConfigFilePath SelectedSteps (Read Only) Sequence
text display, selector, command, and view—as well as the manager Collection Class Denotes a class that has a corresponding collection class. The top (lighter) text ReloadModifiedSequenceFiles
SequenceFile
AllowEditing Buttons (Read Only) InsertComboBoxItem ConnectionActivity
ConfigurationEntryPoints (Read Only) SetAutoCloseExecution SequenceContext Borders (Read Only) ComboBoxItems (Read Only) MouseDown
controls. Class represents the collection. The lower (darker) text represents the type of object Connections (Read Only) SetVisible StepGroupMode StepGroup Enabled Context
KeyDown
MouseMove
StepGroupMode hWnd (Read Only) KeyPress
the collection contains. Collection class properties and methods are not listed on CreateEmptySequenceFileOnStart ShutDown TerminationState (Read Only) DisplayFormattedValue KeyUp MouseUp
National Instruments, NI, ni.com, NI TestStand, and LabVIEW are trademarks of National UndoStack (Read Only) Pages (Read Only)
National Instruments recommends that you use these controls to develop Instruments Corporation. Refer to the Terms of Use section on ni.com/legal for more
CurrentUIMessage (Read Only) Start Thread DisplayText MouseDown
your user interface applications. Refer to Chapter 9, Creating Custom User information about National Instruments trademarks. Other product and company names this poster. EditModeShortcutKey
Events
UserData UserData PaletteLayout
ScaleWithDPI DropDownListHwnd (Read Only) MouseMove  StatusBar
mentioned herein are trademarks or trade names of their respective companies. For patents EditModeShortcutModifier Methods Methods Enabled MouseUp
Interfaces, in the NI TestStand Reference Manual for more information AfterUIMessageEvent Methods Properties
covering National Instruments products, refer to the appropriate location: Help»Patents in your Denotes a connection between a manager control and another control. EditReadOnlyFiles AbortExecution BuildEditArgs Engine SelChange
BeginEdit Note: This object has no methods. AutoSize
about developing applications with the TestStand UI Controls. software, the patents.txt file on your CD, or ni.com/patents. Executing (Read Only) BreakExecution BuildInteractiveArgs ErrorCheck
Information is shared between the two controls. For example, a Button control Break Events Font
ExecutionEntryPoints (Read Only) ConnectCaption
© 2003–2007 National Instruments Corporation. All rights reserved. Printed in Ireland. Executions(Read Only)
BreakOnRunTimeError BuildEditArgs
ConnectCommand BorderDragged
Font ExpressionEditButtons FontSource
instructs a manager control to execute a command, whereas the manager IsEditor
CanEdit BuildInteractiveArgs
ConnectImage ConnectionActivity
FontSource
ExpressionEditButton hWnd (Read Only)
DisplayExecution ConnectCallStack KeyDown FunctionTipHwnd (Read Only) IconSize
control determines when the Button control is dimmed. IsShuttingDown (Read Only)
DisplayReport ConnectCaption ConnectInsertionPalette HideSelection Properties Panes (Read Only)
IsStarted (Read Only) ConnectSequenceFileList hWnd (Read Only) BackColor
ConnectCommand
LoginLogoutRunning (Read Only)
DisplaySequenceFile
DropFile ConnectExecutionList
ConnectSequenceList InsertionPalettePages MaxLength ContextMenuItemCaption
ScaleWithDPI
ShowResizingGrip
LoginOnStart
EditModeChanged ConnectExecutionView
ConnectSequenceView
ConnectStepGroupList
InsertionPalettePage MouseIcon Enabled ShowTopDivider
LoginRunning (Read Only) ConnectImage MousePointer hWnd (Read Only)
373423B-01 Apr07 Note: Some properties and methods from previous versions of TestStand are LogoutClosesSeqFilesAndExecs
EndEdit ConnectVariables Properties
Multiline Icon Methods
EndExecution ConnectNumeric GetCaptionText Expanded
obsolete and are not listed on this poster. LogoutRunning (Read Only) ConnectReportView Index (Read Only) NumericFormat Kind HitTest
ExecutionClosed GetCommand
MakeStepNamesUnique ConnectThreadList SplitterRatio ReadOnly ShortcutKey Localize
ExitApplication GetImageName
MRUFiles (Read Only) ConnectVariables Visible RequiredNamedTypeArrays (Read Only) ShortcutModifier ShowPanes
PostCommandExecute LoopOnSelectedSteps
ProcessCommandLine GetCaptionText Methods RequiredNamedTypes (Read Only) Style Events
PreCommandExecute NewEditContext
PromptForOverwrite GetCommand Note: This object has no methods. RequiredTypes ToolTipText ConnectionActivity
ProcessUserCommandLineArguments Refresh
ReloadModifiedFilesInterval GetImageName ScaleWithDPI Visible DblClick
ReloadSequenceFilesOnStart
QueryCloseExecution
QueryCloseSequenceFile GetNumericValue
RefreshStep
RefreshStepEx
 ReportView ScrollBars Method MouseDown
SaveOnClose LoopOnSelectedSteps SelLength MouseMove
QueryReloadSequenceFile Run Properties DoClick
SequenceFiles (Read Only) NewEditContext SelStart MouseUp
QueryShutdown RunSelectedSteps Borders (Read Only)
UndoStack Refresh ButtonsVisible SelText
UserData
RefreshWindows
ReportError RefreshStep
SetSequenceAndGroup
LargeIcons ShowDisplayNameWhenInactive
ExpressionEditComboBoxItems Resized
UseStepListConfigurations Events ExpressionEditComboBoxItem
Connection Types Selector Control Manager Control Methods
SequenceFileClosed
SequenceFileClosing
RefreshStepEx
RestartExecution PropertyObjectSelectionChanged
RefreshWindow
ScaleWithDPI
TextReportBackColor
Style
SyntaxHighlightingEnabled Properties StatusBarPanes
TextReportColor
Connect a manager control to a visible control to automatically display sequences or reports, present a list Displays Items (invisible at run time)
AddCommandLineArgumentsHelp
BeginEdit
SequenceFileOpened ResumeExecution
RunSelectedSteps
SelectionChanged TextReportFont
Text
TextLength (Read Only)
DisplayName StatusBarPane
ShutDownCancelled SequenceChanged Icon
of items to the user, invoke an application command, or display information about the current state of the CanEdit TerminateExecution TextReportFontSource TextType Properties
Selects Current Item List Connection View Control ShutDownCompleted SequenceFileChanged ToolBarTextStyle Value
Caption
application. When you connect controls, your application does not need the majority of the source code you CloseAllExecutions StartExecution WantReturn
Events SequenceSelectionChanged ToolBarVisible Methods IconName
would usually write in order to update the user interface and respond to user input. Command Control View Connection Displays View CloseAllSequenceFiles UIMessageEvent Break StepGroupChanged
WordWrap
Methods Note: This object has no methods. Index (Read Only)
CloseExecution UserChanged ContextChanged Methods
Connections from manager controls to visible controls are many-to-one. Therefore, you can make the same Invokes Command Command Connection Text Display Control CloseSequenceFile
GetHTMLCtrl Name
UserMessage SequenceFiles
connection from a manager control to multiple visible controls. The specific connections you can make depend on
Caption Connection Displays Caption ConnectAdapterList Wait
DisplayReport
EndExecution
GetRichEditCtrl
PrintReport
CheckExpression
DisplayBrowseExprDialog  Label ProcessPercent
the type of manager control and visible control that you are connecting, as shown on the right. Specific examples ConnectCaption Note: The SequenceFiles object is a Style
ExecutionChanged UpdateFromExecution DisplayError Properties TextAlignment
of these connections are illustrated below. ConnectCommand Executions PropertyObjectSelectionChanged collection that contains SequenceFile Evaluate Alignment
Events ToolTipText
EndEdit RefreshWindow objects. The SequenceFile object is GetAdditionalEvaluationConstants AutoSize
Note: The Executions object is a BorderDragged UseAvailableSpace
GetAutoCloseExecution RunStateChanged described on the NI TestStand API ConnectionActivity Localize BackColor
GetCaptionText collection that contains Execution Reference Poster. Visible
SelectionChanged SelectAll BorderStyle
GetCommand objects. The Execution object is
described on the NI TestStand API TerminationStateChanged  SequenceView SetAdditionalEvaluationConstants Caption
Width
SequenceView (displaying a sequence file) ListBar SequenceView (displaying an execution) GetEngine
Reference Poster. ThreadChanged Properties
Properties Enabled Methods
GetExecutionViewMgr Trace Count (Read Only) Events Font Note: This object has no methods.
AutoSizeColumns
GetImageName UserMessage Item (Read Only) BackColor BorderDragged FontSource
GetModelFile Properties
Count (Read Only) Methods BlockDisplayOptions BrowseExprDialogClosed ForeColor
GetRunState Note: This object has no methods. Borders (Read Only) BrowseExprDialogOpened MouseIcon
GetSequenceFileViewMgr Item (Read Only)
CanEditLabel (Read Only) continued, next column continued, next column
GetTerminationState NumIncomplete (Read Only) Columns (Read Only)
GetVisible NumPaused (Read Only) CommentsColor
LocalizeAllControls NumRunning (Read Only) CommentsFont
Login Method CommentsFontSource
continued, next column ResumeAll CommentsOffset
Cursor
EditingFlags
FocusIndex
HeaderFont
HeaderFontSource
Command Controls
HorizLines
hWnd (Read Only)
IconSize
ItemBackColorExpression Connect a manager control to a Button control to specify that the button performs a common user interface
Selector Controls ItemTextColorExpression
LinesColor
MaxCommentsHeight
command. A Command object represents a standard action that you can initiate in a TestStand application, such
as opening a sequence file or executing a set of selected steps in a sequence. Command objects make it
RoundItemRects simpler for an application to implement a user interface element that performs a standard action. An EntryPoint
ScaleWithDPI object represents an Execution or Configuration entry point. You can execute the entry point sequence using
ShadeAlternateColumns
InsertionPalette ShowComments the Run, RunSelectedSteps, or LoopOnSelectedSteps methods. Use the ConfigurationEntryPoints and
Connect a SequenceFileView Manager or ExecutionView Manager control to a ComboBox or ListBox control to view or select a list of files, sequences, ShowCommentsBars ExecutionEntryPoints methods of the SequenceFileView Manager and ExecutionView Manager controls to
step groups, executions, threads, or stack frames. Use a ListBar control to display multiple pages where each page contains a list of items. Connect a ShowItemTipStrips retrieve an EntryPoints object that is a collection of entry points. Refer to the Menus and Menu Items section of
SequenceFileView Manager or ExecutionView Manager control to a ListBar page to view and select a list of items. Use the ComboBox control to connect StepIconsEnabled Chapter 9, Creating Custom User Interfaces, of the NI TestStand Reference Manual for information about how to
to and display the ExecutionList, CallStack, and ThreadList in the ExecutionView Manager control and to connect to and display the SequenceFileList, TextColor
ListBox SequenceList, and StepGroupList in the SequenceFileView Manager control. TextFont create menu items that perform common user interface commands.
TextFontSource
VertLines  Button Methods
DoClick
LVShortcutModifier
SequenceFileViewMgr
 CheckBox Method
GetItemText
ListBarPages Methods
EditLabel
Methods Properties Localize ShortcutKey
BeginUpdate
Properties
Events
ListBarPage GetItemText EditLabel
ActionStyle
AutoSizing Events
ShortcutModifier
BackColor HitTest SubsidiaryCommands
Change Properties EndUpdate BackColor Click
Application Caption HitTest ConnectionActivity
ToggleState
Click Caption Events Caption UserData
Manager Checked
ConnectionActivity Cursor BorderDragged
ItemIndexToStep
Enabled KeyDown
Enabled Localize UserObject
SequenceFileView ExecutionView DropDown Enabled Click Font KeyPress
Visible
Manager
Button Font
KeyDown Index (Read Only) ColumnsResized
StepToItemIndex
FontSource KeyUp
Manager FontSource Items (Read Only) Events MouseDown Methods
KeyPress ConnectionActivity ForeColor
ForeColor Name BorderDragged MouseMove Execute
KeyUp CreateContextMenu hWnd (Read Only)
hWnd (Read Only) ColumnResized MouseUp GetDisplayName
Methods DblClick ConnectionActivity Image
Image SetDisplayName
SequenceFileList ImageAlign  ListBar Note: This object has no methods. KeyDown
KeyPress
CreateContextMenu
CursorMoved
ImageAlignment
MaskColor Commands
Login MaskColor
Properties KeyUp DblClick MouseIcon Command EntryPoints
Logout ScaleWithDPI
SequenceView UserName ExecutionView Style
BackColor ListBarPageItems MouseDown KeyDown MousePointer
Properties
EntryPoint
SequenceList ExecutionList TextAlign
Borders (Read Only)
ButtonFont
ListBarPageItem MouseMove
MouseUp
MouseDown
MouseMove
ScaleWithDPI
ShowImage
Enabled Properties
StepGroupList CallStack UseMaskColor Properties EntryPoint (Read Only) Enabled (Read Only)
ButtonFontSource MouseUp ShowText
CurrentSequenceComment ThreadList Caption EntryPointIndex (Read Only) InteractiveExecutionAllowed (Read Only)
InsertionPalette Abort ReportView
Method
Localize
ButtonStyle
IconName
ListBoxColumns SeqViewColumns
Style
ExecutionViewMgr Name (Read Only)
ButtonTextColor TextAlignment
NumberOfSteps StepInto
Events CurrentPage Index (Read Only) ListBoxColumn SeqViewColumn TextImageRelation
IconName Sequence (Read Only)
SelectedSteps StepOver ToolTipText IsSeparator Methods
Click hWnd (Read Only) Properties ToolTipText
BreakResume Properties IsToggle LoopOnSelectedSteps
ConnectionActivity IconSize Methods AutoSizing UseMaskColor
Terminate AutoSizing Kind (Read Only) Run
KeyDown PageFont Note: This object has no methods. Caption (Read Only) UseMnemonic
ReportView BackColorExpression LVShortcutKey RunSelectedSteps
KeyPress PageFontSource Index (Read Only) Caption Value
UUTSerialNumber Pages (Read Only) Width
continued, next column
KeyUp
MouseDown PageStyle ListBox Methods
Expression
Index (Read Only)
MouseMove PageTextColor Properties Note: This object has no methods. Name
MouseUp ScaleWithDPI AutosizeColumns TextColorExpression
ShowItemCount BackColor Type
ShowItemTipStrips Borders (Read Only) Visible
 ComboBox ShowScrollBar CanEditLabel (Read Only) Width
Properties
Count (Read Only)
Enabled
Methods
HitTest
Localize
Columns
ColumnSet (Read Only)
Count (Read Only)
Methods
Note: This object has no methods.

 VariablesView
Miscellaneous
Font EditingFlags
Events Enabled Properties
FontSource
BorderDragged Font Borders (Read Only)
HeightWithDropDown
ConnectionActivity FontSource Enabled
hWnd (Read Only) A Borders object specifies the frame and
IconSize
CreateContextMenu ForeColor hWnd (Read Only) Borders
CurPageChanged ScaleWithDPI draggable borders that surround a control. If
ItemIndex hWnd (Read Only) Properties Method
MouseIcon
CursorMoved ItemIndex Methods your application handles the BorderDragged BorderDraggedEventEnabled
StatusBar MousePointer
DblClick MouseIcon Note: This object has no methods. event for the control, users can drag the BorderEdgeStyle
GetFrameThickness
KeyDown MousePointer Events borders to resize or move the control. Refer to BorderWidth
ReadOnly
MouseDown ScaleWithDPI BorderDragged FrameEdgeStyle
ScaleWithDPI the NI TestStand Help for information about
MouseMove ShowHeaders ConnectionActivity FrameInsideBorders
ShowImages additional Support UI classes, properties,
MouseUp ToolTipVisible KeyDown FrameVisible
Style
ToolTipVisible methods, and events. VisibleBorders

You might also like