DisplayStepPropDialog Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.DisplayStepPropDialog ( dlgTitle, step, readOnly, modalToAppMainWind, showViewContentsBtn, viewContents, modifiedStep)

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 edit the properties of a step.

Remarks

Calling the PropertyObject.DisplayPropertiesDialog method on a Step object is equivalent to calling this method.

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.

step As Step

[In] Specifies the Step object that contains the properties you want to edit.

readOnly As Boolean

[In] Pass True to launch a read-only version of the dialog box.

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.

showViewContentsBtn As Boolean

[In] Pass True to show a View Contents button in the dialog box. If you pass True, the viewContents parameter of this method returns True when a user clicks the View Contents button.

viewContents As Boolean

[Out] Returns True if the user clicks the View Contents button in the dialog box.

modifiedStep As Boolean

[Out] Returns True if the step was modified.


See Also

Engine.AppMainHwnd

PropertyObject.DisplayPropertiesDialog

Step

WAS THIS ARTICLE HELPFUL?

Not Helpful