Programming with Reflection

image\rwnprg32.gif Caption property

 

Syntax

object.Caption
object.Caption = Value

Works with

image\r124.gif

Data type

String

 

Description

Returns (first syntax line) or specifies (second syntax line) the text that appears on the Reflection title bar and is used to identify Reflection in Windows Task Manager. For example, to set the title bar text to "Telnet to Tate", use this command:

Session.Caption = "Telnet to Tate"

Setting this property to an empty string resets the caption to its default value, which consists of the name of the Reflection product plus the name of the settings file (or "Untitled" if there is no current settings file).

Various special characters can be included in this string:

Character

Displays

&a

The local IP address

&c

Connected or Not Connected

&d

The date

&f

The settings file name (or Untitled if there is no current settings file)

&h

The host name

&i

Instance number of Reflection. Note: The instance value continues to increment for each new Reflection window even if you close some existing windows. Closing all instances of Reflection resets the instance value to one.

&n

The full name of the Reflection application

&r

Reflection

&s

The host name and the connection type

&t

The connection type

&u

The Reflection product name.

&&

Ampersand (that is, use two && to produce one &)

So, for example, if you set the Caption property to "&f - &s - &c", your title bar might look like this:

My settings.r2w - Myhost via Telnet - Connected

If you need to use quotation marks within the string, use two sets instead of one. For example:

Session.Caption = "Temp Connection to ""Maki"""

Values

The default value is "&f - &n" (settings file name, product name).

The string can be up to 64 characters long.

 

image\jump.gif Keyword Index

image\popup.gif Related Topics

image\popup.gif Reflection products that use this property