DisplayBrowseExprDialogEx Method
Syntax
Engine.DisplayBrowseExprDialogEx ( dlgTitle, objectToBrowse, expressionIn, selectionStartIn, selectionEndIn, initialVariableName, dlgOptions, expressionOut, selectionStartOut, selectionEndOut)
Return Value
True if you click OK in the dialog box. 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] Pass 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] Pass the initial expression string for the dialog box. You may pass an empty string for this parameter. This string must be a localized expression. Refer to LocalizeExpression for more information.
selectionStartIn As long
[In] Pass 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] Pass 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] Pass the name of the initial variable or property to show as selected in the treeview portion of the dialog box. You may pass an empty string for the parameter to select the first item.
dlgOptions As long
[In] Pass 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. Refer to DelocalizeExpression for more information.
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.