DspStr

Displays a string at a specified AN.

Note: This function was designed to only be used on Cicode objects, or the animation point object from the version 3.xx/4.xx toolbox.

Syntax

DspStr(nAN, sFont, sText [, iLength] [, iAlignMode] [, iLengthMode] [, bTooltip])

nAN:

The AN where the text will be displayed.

sFont:

The name of the font that is used to display the text. The Font Name needs to be defined in the Fonts database. If the font is not found, the default font is used.

sText:

The text to display.

iLength:

Length of the text to display, either in characters or pixels depending on Mode (default -1, no truncation)

iAlignMode:

The alignment of the text string:

0 - Left Justified (default)

1 - Right Justified.

2 - Center Justified.

iLengthMode:

The length mode of the text string:

0 - Length as pixels truncated (default)

1 - Length as pixels truncated with ellipsis

2 - Length interpreted as characters.

bTooltip:

Determines if the original text is provided as tool tip when the displayed text becomes truncated.

0 - Tool tip is not available (default).

1 - Tool tip is available.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

DspText

Example

DspStr(25,"RedFont","Display this text");
/* Displays "Display this text" using "RedFont" at AN25. "RedFont"
needs to be defined in the Fonts database. */

See Also

Display Functions