Rotextfield – BrightSign Object Reference Manual (FW 5.1) User Manual
Page 88

80
roTextField
A text field represents an area of the screen that can contain arbitrary text. This feature is intended for presenting
diagnostic and usage information rather than for generating a user interface.
The object is created with several parameters:
CreateObject("roTextField", xpos As Integer, ypos As Integer, width_in_chars As Integer,
height_in_chars As Integer, metadata As Object)
•
xpos: The horizontal coordinate for the top left of the text field.
•
ypos: The vertical coordinate for the top left of the text field. The top of the screen is equivalent to zero.
•
width_in_chars: The width of the text field in character cells.
•
height_in_chars: The height of the text field in character cells.
•
containing extra parameters for the text field. You can pass zero if you
do not require this.
Note: In TV modes a border around the screen may not be displayed due to overscanning. You may want to use the
roVideoMode object functions GetSafeX and GetSafeY to ensure that the coordinates you use will be visible.
The metadata object supports the following extra parameters:
•
"CharWidth": The width of each character cell in pixels.
•
"CharHeight": The height of each character cell in pixels.
•
"BackgroundColor": The background color of the text field as an integer specifying eight bits (for each) for red,
green and blue in the form
&Hrrggbb.
•
"TextColor": The color of the text as an integer specifying eight bits (for each) for red, green and blue in the form
&Hrrggbb.