Engine.DisplayBrowseExprDialog
- Updated2026-02-03
- 2 minute(s) read
Engine.DisplayBrowseExprDialog
Syntax
Engine.DisplayBrowseExprDialog( dlgTitle, sequenceContextParam, expressionIn, selectionStartIn, selectionEndIn, initialVariableName, usesCRLF, modalToAppMainWind, expressionOut, selectionStartOut, selectionEndOut)
Return Value
Returns True if you click OK in the dialog box. Returns False if you click Cancel .
Purpose
Remarks
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.
sequenceContextParam As SequenceContext
[In] Specifies the sequence context into which to browse. You can use the SequenceFile.NewEditContext method to obtain an edit time sequence context from a sequence file.
expressionIn As String
[In] Specifies the initial expression string for the dialog box. 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.
initialVariableName As String
[In] Specifies the name of the initial variable or property to show as selected in the dialog box.
usesCRLF As Boolean
[In] If the initial expression string uses a carriage return/linefeed combination ("\r\n") to indicate the end of a line of text, pass True for this parameter. If the string uses only a linefeed ("\n"), pass False . This parameter also determines if the carriage return/linefeed is inserted in the output expression for new lines.
modalToAppMainWind As Boolean
[In] By default, the dialog box is modal to the last active window of the calling thread, or if there is none, to the last active window from AppMainHwnd. If you set this option, the dialog box is modal with respect to the window handle of the Engine.AppMainHwnd property. Typically, you do not need to set this option.
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 Engine.DelocalizeExpression for more information about converting 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.