Messagetextobject – CUE Design Director Script Language User Manual

Page 66

Advertising
background image

Reference Manual Design Director Script Language

www.cuesystem.com

Page 66 of 94

3.2.13. MessageTextObject

The object inherits from IdentificationObjectA and ObjectLookObjectA. It contains:

Property

Type

Description

BackColor

ColorObject

Background color. Reference to a real color object or to NoObject, if not
filled then the color is transparent. The object of the color can be the part
of the palette which has been defined in the design environment.

Beep

uint

The none zero value means when a message appears (i.e. at moment
when the Value value of MessageObject object is changed) it will beep.
The number zero means it will not beep for this message.

Bitmap

BitmapObject

Reference to the real picture object or to NoObject, if not filled.

BtmHOri

uint

The picture horizontal orientation. The values are defined 0..left,
1..middle, 2..right, 3..tile (i.e. it repeats) To insert a different values is not
checked, what will appear is not defined.

BtmVOri

uint

The picture vertical orientation. The values are defined 0..up, 1..middle,
2..down, 3..tile (i.e. it repeats) To insert a different values is not checked,
what will appear is not defined.

Color

ColorObject

Text color. Reference to a real color object – it can never be NoObject
then the color would be transparent. The objects of the color can be the
part of the palette, which has been defined in the design environment.

Default

uint

The none zero value means when there for the actual Value value of the
MessageObject object cannot be found any message (none does not fit
into interval), it will appear this one. The zero value means that it should
not appear this one. If it contains more messages with none zero value
under the same MessageObject object then it is not defined what
message will appear. In case none of the messages contain none zero,
and the message for the given Value is not found, then it is not defined
what will be displayed on the panel.

Father IdentificationObjectA

The

father of the object. For the button itself, for instance it is the board

that it is lying on. For the window and the page (as well as for the ”free”
objects – i.e. a picture, font or a color) the value is NoObject. The property
is for reading only.

Flash

uint

If the value is a zero then will not flash. Otherwise the text would flash
according to the entered Period and Ration parameters.

Font

FontObject

Reference to a real font object or to NoObject, if not filled (in this case the
text is not displayed).

MaxValue

uint

It is a value for which the gauge is displayed all over the object.

MinValue

uint

It is a value for which the gauge is not displayed.

Name

string*50

The object name. The property is for reading only. The value is default.

Period

uint

Assigns the text-flashing period in milliseconds. If the value is a zero then
the text will not be flashing.

Ratio

uint

Assigns the number percentage of the period when the text appears. For
instance for the value Period=4000 and Ratio=25 the text appears for 1
second and hides for 3 seconds.

Tag

uint

Free space where anyone, while the program is running, can note
something. For the virtual world itself it has no importance. For the design
environment it is forbidden. At the beginning the value is zero here.

Text

string*50

Text of caption.

TxtHOri

uint

The text horizontal orientation. The values are defined 0..left, 1..middle,
2..right. To insert a different value is not checked, what will appear is not
defined.

TxtVOri

uint

The text vertical orientation. The values are defined 0..left, 1..middle,
2..right. To insert a different value is not checked, what will appear is not
defined.

WordWrap

uint

If the value is a zero then the text appears on one line. In the opposite
case the text is automatically broken into more lines according to the width
of the object.

Advertising