DisplaySequencePropDialog Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.DisplaySequencePropDialog ( dlgTitle, sequence, readOnly, modalToAppMainWind, showViewContentsBtn, viewContents)

Return Value

Boolean

Returns True if you make modifications and click OK in the dialog box. Returns False if you click Cancel or make no modifications.

Purpose

Launches a dialog box in which you can edit the properties of a sequence.

Remarks

Calling this method is equivalent to calling the PropertyObject.DisplayPropertiesDialog method on a Sequence object. Locking and unlocking a file on the Advanced tab immediately apply to the file. To determine whether the lock state changes, even when the return value from the method is False, you can use the PropertyObjectFile.Locked property to acquire the lock state before and after calling this method and compare the values.

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.

sequence As Sequence

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

readOnly As Boolean

[In] Pass True if you want 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 if the user clicks the View Contents button in the dialog box.

viewContents As Boolean

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


See Also

Engine.AppMainHwnd

PropertyObject.DisplayPropertiesDialog

PropertyObjectFile.Locked

Sequence

WAS THIS ARTICLE HELPFUL?

Not Helpful