GetInsertStepMenuStructure Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.GetInsertStepMenuStructure ( selectedFile, hiddenFlags)

Return Value

PropertyObject

The object that specifies the menu structure.

Purpose

Creates a PropertyObject object that specifies the structure of the menu used to insert steps in the sequence editor.

Remarks

The sequence editor uses this method to create the submenu that appears when you select Insert Step from the Steps pane context menu. The structure of this menu depends upon the types in the type palettes, the types in the sequence file, the default adapter, and the step type menu configuration. This method constructs a PropertyObject object that contains properties that specify the submenu structure.

Parameters

selectedFile As PropertyObjectFile

[In] Specifies the currently selected file. The method includes the step types defined in this file as well as the step types located in the type palette. Pass 0 or NULL if there is no selected file.

hiddenFlags As Long

[In] Pass a set of PropertyFlags that specify which step types are not included in the menu. For example, pass PropFlags_Hidden to exclude the hidden step types.


See Also

Engine.DisplayStepTypeMenuEditorEx

Engine.GetEditTimeToolMenuItems

Engine.GetInsertVariableMenuStructure

Engine.GetRunTimeToolMenuItems

MenuItemProperties

PropertyFlags

PropertyObject

PropertyObjectFile

Step.GetEditSubstepMenuStructure

StepType.GetSubstep

WAS THIS ARTICLE HELPFUL?

Not Helpful