VRTransparentText

The Transparent Text Object is designed to help design panels for VX-REXX where text is required overwriting an image.

The text within a Transparent Text Object can be justified both horizontally and vertically and wrapped within the area of the object.

When you start a program that uses Transparent Text Objects there will be a short delay before they are shown on the window. This is so that the objects can obtain an image of the underlying window.

Note: The background of the Transparent Text Object is NOT transparent in the design environment: it will take on the background of the top window. This is due to the behaviour of the VX-REXX design environment.

Warning: The Transparent Text Object makes a copy of the image in the window over which it lies, if you use many Transparent Text Objects the memory signature of your program may increase noticeably.

Specific Properties
The Transparent Text Object has following specific properties:
 * Justification
 * SizeToText
 * VertJustification
 * WrapText

Justification
This property determines the horizontal justification of the text in the object. It behaves in the same way as the Justification property of the Descriptive Text Object.
 * Data Type : String
 * Possible Values
 * Left
 * Centered
 * Right

SizeToText
This property will have different effects on the appearance and behaviour of the Transparent Text Object depending on the setting of the WrapText property.

If WrapText is on, then the size of the object will be adjusted to the nearest fit to its current size.

If WrapText is off then the object will be sized in the same way as a Descriptive Text Object.
 * Data Type : Boolean
 * Possible Values
 * 1 (true)
 * 0 (false)

VertJustification
This property will have different effects on the appearance and behaviour of the Transparent Text Object depending on the setting of the WrapText property.

If WrapText is on, then the size of the object will be adjusted to the nearest fit to its current size.

If WrapText is off then the object will be sized in the same way as a Descriptive Text Object.
 * Data Type: String
 * Possible Values
 * Top
 * Centered
 * Bottom

WrapText
This property will cause the text in a Transparent Text Object to be wrapped over several lines if it is too long to fit in the width of the object. If SizeToText property is set, the object will resize to show the complete text.


 * Note:If the object is not wide enough for a word in the text, this word will be cut.
 * Data Type: Boolean
 * Possible Values
 * 1 (true)
 * 0 (false)

Standard Properties
The Transparent Text Object also has the following standard properties:
 * Caption
 * ClassName
 * ClipSiblings
 * Enabled
 * FirstChild
 * Font
 * ForeColor
 * Height
 * HelpTag
 * HelpText
 * HintText
 * HWnd
 * Left
 * Name
 * Painting
 * Parent
 * Query
 * QueryColumns
 * Self
 * Sibling
 * SiblingOrder
 * Top
 * UserData
 * Visible
 * Width

Methods
The Transparent Text Object has the following specific methods:

Refresh
This method will hide the text in order to refresh the background and then re-draw the text. You should call this method whenever the background of the text changes. It is a good idea to include this method in the parent window Resize event. ok = VRMethod( object, "Refresh");
 * Returns
 * 1 (true) if successful
 * 0 (false) otherwise

TextLength
This method will return the length of the caption text in TWIPS. You can then use this to determine whether the text will fit in the space you have and the modify the SizeToText and/or WrapText properties accordingly. Len = VRMethod( object, "TextLength");
 * Returns: The length of the caption text
 * See Also
 * Justification
 * SizeToText
 * WrapText