ConnectCaption Method

TestStand 2017 Help

Edition Date: November 2017

Part Number: 370052W-01

»View Product Info

Download Help (Windows Only)
NI TestStand 2014 Help
NI TestStand 2014 SP1 Help
TestStand 2016 Help
TestStand 2016 SP1 Help
TestStand 2017 Help

Syntax

ApplicationMgr.ConnectCaption ( uiObj, captionSource, longName)

Return Value

CaptionConnection

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

Purpose

Connects a caption source in the Application Manager control to a visible control or an element of a visible control. The connection automatically updates the visible control with the text that describes an aspect of the application state.

Remarks

You can use this method to display a caption in a Label, ExpressionEdit or StatusBarPane control.

To disconnect an existing connection, you must first obtain the ApplicationMgrConnections object from the ApplicationMgr.Connections property. Then, access the ApplicationMgrConnections.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 the long or short version of the caption text. Refer to the CaptionSources enumeration for more information about the difference between the long and short versions of the text and to determine when this option affects a caption source.


See Also

ApplicationMgr.Connections

ApplicationMgr.GetCaptionText

ApplicationMgrConnections

ApplicationMgrConnections.Caption

CaptionConnection

CaptionConnections

CaptionSources

ExecutionViewMgr.ConnectCaption

ExpressionEdit

Label

SequenceFileViewMgr.ConnectCaption

StatusBarPane

WAS THIS ARTICLE HELPFUL?

Not Helpful