GetLocationForNextDialog Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.GetLocationForNextDialog ( locationLookupString, elementAtLocation, selectionStart, selectionLength, clearLoc = True)

Purpose

This method is typically used by a dialog box to obtain the information needed to select and highlight the control associated with the location the Engine.SetLocationForNextDialog method previously specified.

Parameters

locationLookupString As String

[Out] Returns a lookup string that indicates the subproperty of the object that contains the corresponding control you want to highlight in the dialog box.

elementAtLocation As Long

[Out] Returns one of the following SearchElements constants to indicate which part of the property to highlight in the dialog box: SearchElement_Name, SearchElement_Comment, SearchElement_StringValue, SearchElement_NumericValue, or SearchElement_BooleanValue.

selectionStart As Long

[Out] If the control the locationLookupString and elementAtLocation parameters indicate is an Edit control, use this parameter to determine a particular section of the text within the control for the dialog box to select. Returns the index of the character within the string for the start of the selection.

selectionLength As Long

[Out] If the control the locationLookupString and elementAtLocation parameters indicate is an Edit control, use this parameter to determine a particular section of the text within the control for the dialog box to select. Returns the number of characters, starting from the selStartIndex character, for the dialog box to select in the Edit control.

clearLoc As Boolean

[In] Typically, calling this method clears the internal data in the engine for the location of the dialog box so the next time this method is called, no location information is returned. To override this behavior, pass False for this parameter.

This parameter has a default value of True.


See Also

Engine.SetLocationForNextDialog

SearchElements

WAS THIS ARTICLE HELPFUL?

Not Helpful