SequenceFileViewMgr.ConnectCaption

Syntax

SequenceFileViewMgr.ConnectCaption( uiObj, captionSource, longName)

Return Value

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 caption source in a SequenceFileView Manager control to a visible control or an element of a visible control. The connection automatically updates the visible control with text that describes an aspect of the current application state.

Remarks

To disconnect an existing connection, you must first obtain the SequenceFileViewMgrConnections object from the SequenceFileViewMgr.Connections property. Then, call the SequenceFileViewMgrConnections.Caption property to obtain the CaptionConnections collection.

Parameters

uiObj As Object

[In] Specifies the visible control or element of a visible control to which the caption source connects. Pass a Label , ExpressionEdit , or StatusBarPane .

captionSource As CaptionSources

[In] Specifies the type of caption source to connect.

longName As Boolean

For certain caption sources, this parameter specifies whether the connection displays a long or short version of the caption text. Refer to the CaptionSources enumeration for more information about determining when this option affects a caption source and for more information about the difference between the long and short versions of the text.

TestStand API Reference

Table of Contents

SequenceFileViewMgr.ConnectCaption

SequenceFileViewMgr.ConnectCaption

Syntax

Return Value

Purpose

Remarks

Parameters

See Also

Log in to get a better experience