ConnectCommand Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

SequenceFileViewMgr.ConnectCommand ( uiObj, cmdKind, index = 0, opts = 0)

Return Value

CommandConnection

A reference to an object that represents the new connection. Discarding the reference does not affect the connection. When the object is already connected to this type of connection, the existing connection is returned.

Purpose

Connects a command source in a SequenceFileView Manager control to a TestStand button or checkbox control. The connection automatically updates the enabled, visible, and caption properties of the button or checkbox according to the state of the current execution. Clicking the button or enabling the checkbox control executes the command.

Remarks

To disconnect an existing connection, you must first obtain the SequenceFileViewMgrConnections object from the SequenceFileViewMgr.Connections property. Then, access the SequenceFileViewMgrConnections.Command property to obtain the CommandConnections collection.

Parameters

uiObj As Object

[In] Specifies the button or checkbox control to which the command connects.

cmdKind As CommandKinds

[In] Specifies the type of command to connect.

index As Long

[In] For CommandKinds that are sets, this parameter indexes the set to obtain a particular command.

This parameter has a default value of 0.

opts As Long

[In] Specifies the options for the CommandConnection. Refer to the CommandConnectionOptions constants for more information about options for the CommandConnection object.

This parameter has a default value of 0.


See Also

Button

CommandConnectionOptions

CommandConnections

CommandKinds

SequenceFileViewMgr.Connections

SequenceFileViewMgr.GetCommand

SequenceFileViewMgrConnections

SequenceFileViewMgrConnections.Command

WAS THIS ARTICLE HELPFUL?

Not Helpful