DisplayPropertiesDialog Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

PropertyObject.DisplayPropertiesDialog ( dlgTitle = "", file = NULL, dlgOptions = 0)

Return Value

Long

Returns one or more of the PropertyDialogOutputs status flags. Use the bitwise-AND operator to check for specific values.

Purpose

Launches a dialog box in which you can view and change properties of the object.

Remarks

This method launches a different dialog box according to the type of object. For example, calling this method on a Step object launches the Step Properties dialog box using the Engine.DisplayStepPropDialog 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. The string can contain '%1' to be replaced with object name and '%2' to be replaced with object type name.

This parameter has a default value of "".

file As PropertyObjectFile

[In] Specifies the property object file to which the object belongs. Use the SequenceFile.AsPropertyObjectFile method to obtain a property object file from a sequence file.

This parameter has a default value of NULL.

dlgOptions As Long

[In] Specifies any combination of the PropertyDialogOptions constants.

This parameter has a default value of 0.


See Also

Engine.DisplaySeqFilePropDialog

Engine.DisplaySequencePropDialog

Engine.DisplayStepPropDialog

PropertyDialogOptions

PropertyDialogOutputs

PropertyObjectFile

SequenceFile.AsPropertyObjectFile

Step Properties dialog box

Thread Safety of the PropertyObject API and TestStand Variables

WAS THIS ARTICLE HELPFUL?

Not Helpful