DisplayBrowseExprDialogEx Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.DisplayBrowseExprDialogEx ( dlgTitle, objectToBrowse, expressionIn, selectionStartIn, selectionEndIn, initialVariableName, dlgOptions, expressionOut, selectionStartOut, selectionEndOut)

Return Value

Boolean

Returns True if you click OK in the dialog box. Returns False if you click Cancel.

Purpose

Launches a dialog box in which you can construct an expression string using variables, properties, constants, operators, and functions.

Parameters

dlgTitle As String

[In] Specifies the title of the dialog box. Pass an empty string to use the default title for the dialog box.

objectToBrowse As PropertyObject

[In] Specifies the object into which to browse. This is usually a SequenceContext object. You can use the SequenceFile.NewEditContext or Engine.NewEditContext methods to create a sequence context.

expressionIn As String

[In] Specifies the initial expression string for the dialog box. You can pass an empty string for this parameter. This string must be a localized expression.

selectionStartIn As Long

[In] Specifies the zero-based index of the location in the initial expression where the selected text begins. If you want a cursor instead of selected text, pass the same index for selectionEndIn.

selectionEndIn As Long

[In] Specifies the index of the location in the initial expression of the first character beyond the selected text. If you want a cursor instead of selected text, pass the same index for selectionStartIn. Pass -1 to select to the end of the text.

initialVariableName As String

[In] Specifies the name of the initial variable or property to show as selected in the dialog box. You can pass an empty string for the parameter to select the first item.

dlgOptions As Long

[In] Specifies any combination of the BrowseExprDialogOptions constants.

expressionOut As String

[Out] Returns the resulting expression from the dialog box when the user clicks OK. This expression string is a localized expression. You can convert a localized expression string to a standard form suitable for evaluation.

selectionStartOut As Long

[Out] Returns the index of the start of the selected text in the resulting expression when the user clicks OK.

selectionEndOut As Long

[Out] Returns the index of the first character beyond the selected text in the resulting expression when the user clicks OK.


See Also

BrowseExprDialogOptions

Engine.DelocalizeExpression

Engine.LocalizeExpression

Engine.NewEditContext

PropertyObject

SequenceContext

SequenceFile.NewEditContext

WAS THIS ARTICLE HELPFUL?

Not Helpful