Programming with Reflection

image\rwnprg32.gif Caption property

 

Syntax

object.Caption
object.Caption = Value

Data type

String

 

Description

Returns (first syntax line) or specifies (second syntax line) the string that appears in the Reflection title bar. This string is only relevant when the HelpDisplayMode property is set to rcStatusBar (the default value).

This string is also displayed on the taskbar when Reflection is running. If Reflection is running but minimized, the string shown on the taskbar button is defined by IconTitle.

For example, the following command sets the title bar to show the text "Session: " followed by the session type, transport type and connection status. For an unconnected 3270 Terminal using Telnet, the title bar would read "Session: IBM 3270 Terminal - Telnet - No Connection."

Session.Caption = "Session: &s - &t - &c"

Values

The default is "&f - &r - &s".

This string can be up to 220 characters long.

The following spectial characters can be included in this string:

Character Displays

&w "AttachmateWRQ"

&r "Reflection"

&f Settings File Name (or 'Untitled' if a settings file is not open)

&s Session Type

&t Transport

&h Host Name

&d Date

&c Connection Status (whether you are connected and over what transport)

&p Printer Status (relevant only in if the Session Type is IBM 5250 Printer or IBM 3270 Printer)

&x Transfer Status (the percentage complete of file and data transfers)

&v Assigned Device Name (relevant only for 5250 sessions that use an assigned Device Name)

&l Assigned LU Name (relevant only for 3270 sessions that use an assigned LU Name)

&o Profile Name

&& A Single Ampersand

 

 

image\jump.gif Keyword Index

image\popup.gif Related Topics

image\popup.gif Reflection products that use this property