SetLocationForNextDialog Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.SetLocationForNextDialog ( locationLookupString, elementAtLocation, selectionStart, selectionLength)

Purpose

Sets the location of the control in a dialog box that edits the property you specify. When you launch the dialog box again, the control associated with the location is selected and highlighted. The following methods launch dialog boxes that support this feature: PropertyObject.DisplayAttributesDialog, PropertyObject.DisplayPropertiesDialog, Step.SpecifyModule, StepType.SpecifyModule, Engine.DisplayEditUserDialog, Engine.DisplayStepPropDialog, Engine.DisplaySequencePropDialog, Engine.DisplaySeqFilePropDialog, Engine.DisplayPreconditionDialog.

Parameters

locationLookupString As String

[In] Specifies the subproperty of the object that specifies the corresponding control that is highlighted in the dialog box the next time it is launched.

elementAtLocation As Long

[In] Pass one of the following SearchElements constants to indicate which part of the property you want to highlight in the dialog box while editing: SearchElement_Name, SearchElement_Comment, SearchElement_StringValue, SearchElement_NumericValue, or SearchElement_BooleanValue. For example, to highlight a portion of a local variable comment, pass an empty string for the locationLookupString parameter and SearchElement_Comment for this parameter, then call PropertyObject.DisplayPropertiesDialog on the variable property.

selectionStart As Long

[In] If the control the locationLookupString and elementAtLocation parameters indicate is an Edit control, you can use this parameter to select a particular section of the text within the control when TestStand launches the dialog box. Pass the index of the character within the string where you want the selection to start.

selectionLength As Long

[In] If the control the locationLookupString and elementAtLocation parameters specify is an Edit control, you can use this parameter to select a particular section of the text within the control when TestStand launches the dialog box. Starting from the selStartIndex character, pass the numbers of characters you want the dialog box to select in the Edit control.


See Also

Engine.DisplayEditUserDialog

Engine.DisplayPreconditionDialog

Engine.DisplaySeqFilePropDialog

Engine.DisplaySequencePropDialog

Engine.DisplayStepPropDialog

Engine.GetLocationForNextDialog

PropertyObject.DisplayAttributesDialog

PropertyObject.DisplayPropertiesDialog

SearchElements

Step.SpecifyModule

StepType.SpecifyModule

WAS THIS ARTICLE HELPFUL?

Not Helpful