Syntax

SequenceFileViewMgr.GetCaptionText( captionSource, longName, formatExpression = "")

Return Value

String

The current text for the caption source you specify.

Purpose

Returns the current caption text for a caption source in a SequenceFileView Manager control.

Parameters

captionSource As CaptionSources

[In] Specifies the type of caption source from which to obtain text.

longName As Boolean

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

formatExpression As String

[In] Specifies a format expression to evaluate when generating the caption text. For the CaptionSource_MacroExpression caption source, specify a format expression that evaluates to a string value that contains macros that specify other caption sources. For all other caption sources, specify an expression that evaluates to a string value that contains the characters %1 . The method replaces the %1 characters with the text from the caption source. Pass an empty string to use the default format string for the caption source.

This parameter has a default value of "" .

See Also

ApplicationMgr.GetCaptionText

CaptionSources

ExecutionViewMgr.GetCaptionText