DisplaySeqFilePropDialog Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.DisplaySeqFilePropDialog ( dlgTitle, sequenceFileParam, 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 file.

Remarks

You can edit the load/unload options, model options, and other options. Calling the PropertyObject.DisplayPropertiesDialog method on a SequenceFile object is equivalent to calling this method. Locking and unlocking a file on the Advanced tab of the Sequence File Properties dialog box immediately changes the lock state of 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.

sequenceFileParam As SequenceFile

[In] Pass a SequenceFile object to specify which sequence file 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 when a user clicks the View Contents button.

viewContents As Boolean

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


See Also

Advanced tab

Engine.AppMainHwnd

PropertyObject.DisplayPropertiesDialog

PropertyObjectFile.Locked

Sequence File Properties dialog box

SequenceFile

WAS THIS ARTICLE HELPFUL?

Not Helpful