LABELTEXT


9.0, PLBCMP GUI Only

square.png Properties

square.png Events

square.png Methods

square.png Instructions

 

The LABELTEXT instruction defines an object that displays a string of static text on the screen. This object differs from a STATTEXT in that it can perform wordwrapping and is in a window. To define a LABELTEXT, use one of the following statement formats:

 

(1)

[label ]

LABELTEXT

[% ]

(2)

[label ]

LABELTEXT

(arraysize )

(3)

[label ]

LABELTEXT

^

(4)

[label ]

LABELTEXT

^ ,{target }

(5)

[label ]

LABELTEXT

^(arraysize)

(6)

[label ]

LABELTEXT

^(arraysize),({target}),...,({target})

 

Where:

label

Optional. A Data Label.

%

Optional. Denotes the item as being GLOBAL.

arraysize

Required. An integer decimal constant, CONST variable, or EQUATEd value indicating the number of array items.

^

Optional. Denotes the item as being a POINTER.

target

Required. The name of a previously defined data item of the same type.

Flags Affected: NONE

Note the following:

  1. A LABELTEXT contains only one item that is the text information.

  2. The LABELTEXT is always referenced as item number zero.

  3. Items are accessible through the SETITEM or GETITEM instructions.

  4. This object contains a line of text displayed using value of the font property.

  5. To force a line break in a LABELTEXT that has the WORDWRAP property enabled, insert a carriage return and a line feed in the text.

  6. Multi-dimension arrays are supported up to a maximum of fourteen dimensions.

  7. The ^ denotes Pointer Variable.

  8. Although a LABELTEXT may be defined as Global, it is DESTROYed during a CHAIN instruction.

  9. When using the PL/B Web Server, a LABELTEXT object use the CSS classes named 'ww0' and 'ww1' defined in the 'plbwebbasic.css' file. By using these classes, the end-user application behaviors for the HTML wrap attribute can be changed using user-custom classes. See the runtime keyword named 'PLBWEB_USER_CSS={filename.css}' for more information on user defined classes. The default 'plbwebbasic.css' class setting for the 'ww0' class is set to 'no wrap' and the 'ww1' class is set to 'wrap'

  10. Using the LABELTEXT object for the PL/B Web Server runtime, the APPEARANCE property has extended appearance values that have been added to allow additional styles and behaviors (9.7C). See the APPEARANCE property for details. If the LABELTEXT object is created using the $LIST appearance style, the click and double click events return a one-based value in the event result that identifies the list item which was clicked.

  11. When a single '&' character is to appear in a LABELTEXT using the PL/B Web Server, the data string must use the two character sequence of '&&' in the output string. The '&&' usage forces a single '&' output similar to a Windows control.

 

 

See Also: Example Code, Object Definitions, Object Output Instructions

 



PL/B Language Reference IMAGELIST LINE