Value
String Only Label
Using Interaction Properties
Commands
To assign a command to your label, right-click in the Property
Value field of the command property and select Define Command.
Commands can be set up to
execute when you click on an object or
automatically execute the command when the value of an object reaches a
specified threshold.
See Building
Displays>Define/Execute Command for information on how to set up
commands. Drill Down Displays
To specify a drill
down display, double click on the drillDownTarget property. Any display (.rtv)
file can be targeted as a drill down. Once a drill down target has been set, double-click on the
label to activate the drill down. Drill down displays can
be activated in the same window that contains the label or open in a separate
window. This allows you to build a customizable hierarchy of displays.
Tool Tips
Select the mouseOverFlag
to enable tool tips for your label. To display a tool tip, point to the label with
your mouse. The tool tip will contain information from your data attachment.
Background Properties
Image Properties
Property
Name |
Description |
image |
Enter the
name of an image or click on
the
button to open the
Select Image dialog. |
imageScaleFlag |
Select to scale your image to the size of the object. |
Interaction Properties
Property
Name |
Description |
command |
Assign a command to
your vu label. See Building
Displays>Define/Execute Command for information. |
commandCloseWindowOnSuccess |
If selected, the
window that initiates a system command will automatically close when the system
command is executed successfully. This
property only applies to system commands.
With data source commands, the window is closed
whether or not the command is executed successfully.
For multiple commands, this property is applied
to each command individually. Therefore if the first command in the multiple
command sequence succeeds, the window will close before the rest of the commands
are executed.
NOTE: The commandCloseWindowOnSuccess
property is not supported in the Display Server. |
commandConfirm |
If selected, the
command confirmation dialog is enabled. Use the commandConfirmText
property to write your own text for the confirmation dialog, otherwise text from
the command property will be used. For
multiple commands, if you Confirm the execution then all individual commands
will be executed in sequence with no further confirmation. If the you Cancel the
execution, none of the commands in the sequence will executed. |
commandConfirmText |
Enter command
confirmation text directly in the Property Value field or select the
button to open the Edit commandConfirmText dialog. If
commandConfirmText is not specified, then
text from the command property will be used. |
drillDownTarget |
Name of display (.rtv)
file targeted as a drill down. See Building
Displays>Drill Down Displays for information. |
mouseOverText |
Enter a tool tip for
this label. To
display the tool tip, move your mouse over the object. To enter a multi-line
tool tip, use \n to delimit the lines (e.g. my\nlabel). NOTE: The object
must be visible (i.e. visFlag property is selected), in order for the
tool tip to be visible. |
Label Properties
Property
Name |
Description |
label |
Edit label text directly in the Property Value
field or select the
button to open the Edit Label dialog. |
labelMinTabWidth |
Specify minimum width of the label tab.
NOTE: This property only applies if labelTextPosY is
set to TabTop. |
labelTextColor |
Select the
button and choose from the palette to set the color of the label text. |
labelTextFont |
Select the font style of the label text from drop
down menu. |
labelTextHeight |
Set the height (in pixels) of the label text. |
labelTextPosX |
Set
x-axis position of label text. Select from the following options:
- Left - Position outside the left
side of the background rectangle.
- Inside Left - Position inside the left side of the background
rectangle.
- Center
-
Position in the center of the background rectangle.
- Inside Right - Position inside the
right side of the background rectangle.
- Right - Position outside the right side of the background
rectangle.
|
labelTextPosY |
Set
y-axis position of label text. Select from the following options:
- Outside Top - Position well above the background rectangle.
- Top -
Position just above the background rectangle.
- Tab Top - Position tab just above the background rectangle. NOTE: Height
and width of the label tab is dependent on the height and width of the text. Use
the labelMinTabWidth property to specify a minimum tab width.
- Title Top - Position along the top
line of the background rectangle.
- Inside Top - Position inside the top
of the background rectangle.
- Center - Position in the center of the background rectangle.
- Inside Bottom - Position inside the
bottom of the background rectangle.
- Bottom - Position just below the background rectangle.
- Outside Bottom
- Position well below
the background rectangle.
|
labelVisFlag |
Control visibility of the label. |
labelWordWrapMode |
Text will be wrapped
to fit the width of the object depending on the mode selected. Default is
None.
Space
|
Whenever possible,
only add line breaks at whitespaces. If a single word is longer than the
object is wide, the line break will be added to the word so that the text
fits within the width of the object. |
Space and
Punctuation |
Whenever possible,
only add line breaks at whitespaces and punctuation characters. Supported
punctuation characters are: comma(,), period(.), semi-colon(;), colon (:),
hyphen(-), question mark(?), asterisk(*),
ampersand(&), greater than(<), less than(>), backslash(\), forward slash(/),
pipe(|), plus(+), exclamation point(!), and at(@).
If a single word is longer than the object is
wide and none of these characters is in the word, the line break will be
added to the word so that the text fits within the width of the object. |
NOTE: The labelWordWrapMode property is
ignored, and text will not be wrapped, if:
- labelTextPosX is set to Outside Right or
Outside Left
- labelTextPosY is set to
Tab Top or Title Top.
|
Object Properties
Property
Name |
Description |
anchor |
Specify where to
anchor an object in the display. NOTE: If an object has the dock property
set, the anchor property will be ignored.
The anchor property is only applied when the
dimensions of the display are modified, either by editing
Background Properties or resizing the window in
Layout mode
Select None, or one or more the following
options:
None
|
Object
not anchored. This is the default. |
Top |
Anchor
top of object at top of display. |
Left |
Anchor
left side of object at left of display. |
Bottom |
Anchor
bottom of object at bottom of display. |
Right |
Anchor
right side of object at right of display. |
When a display is resized, the number of pixels
between an anchored object and the specified location remain constant. If an
object is anchored on opposite sides (i.e. Top and Bottom or
Left and Right), the object will be stretched to fill the available
space. |
dock |
Specify the docking
location of an object in the display.
Select from the following options:
None
|
Object
is not docked. This is the default. |
Top |
Dock
object at top of display. |
Left |
Dock
object at left of display. |
Bottom |
Dock
object at bottom of display. |
Right |
Dock
object at right of display. |
Fill |
Dock
object in available space remaining in the display after all docked objects
are positioned. |
If the dimensions of the display are modified,
either by editing Background Properties or
resizing the window in Layout mode, the
properties (objX, objY, objWidth and objHeight) of
docked objects will automatically adapt to match the new size of the display.
When multiple objects are docked to the same side
of the display, the first object is docked against the side of the display, the
next object is docked against the edge of the first object, and so on.
When objects are docked to multiple sides of the
display, the order in which objects were added to the display controls docking
position. For example, let's say the first object added to the display is docked
at the Top and the second object is docked at the Left.
Consequently, the first object will fill the entire width of the display and the
second object will fill the left side of the display from the bottom of the
first object to the bottom of the display.
Objects in a display have the dock property set
to Fill, are laid out across a grid in the available space remaining
after all docked objects are positioned. By default, the grid has one row and as
many columns as there are objects in the display. You can modify the grid in the
Background Properties dialog.
Once an object is docked, there are some
limitations on how that object can be modified.
- Docked objects cannot be dragged or
repositioned using objX and objY properties.
- Docked objects cannot be resized using the
objWidth or objHeight properties. To resize you must drag on the
resize handle.
- Docked objects can only be resized toward the
center of the display (e.g. If an object is docked at the Top, only its
height can be increased by dragging down toward the center of the display).
- Docked objects set to Fill cannot be
resized at all.
- Docked objects cannot be moved using Align.
Non-docked objects can be aligned against a docked object, but a docked object
will not move to align against another object.
- Docked objects are ignored by Distribute.
|
objHeight |
Set height of the object in pixels. |
objName |
Name given to facilitate object management via
the Object List dialog. Select Tools>Object List. |
objWidth |
Set width of the object in pixels. |
objX |
Set the x position of the object. |
objY |
Set the y position of the object. |
styleClass |
Enter the style class name for this object as
defined in your style sheet.
If not specified, the object class name is used. NOTE: The value entered
must not contain spaces and cannot start with rtv-. |
transparencyPercent |
Set transparency of the object. Enter a value
between 0 and 100. A value of 0, the default, sets the object to be completely
opaque. A value of 100 will render the object completely transparent. |
visFlag |
Control visibility of the object. |
|