DspRichTextEnable

Cicode Programming Reference > Cicode Function Categories > Display Functions Introduction > DspRichTextEnable

DspRichTextEnable

Enables the rich text object at AN if nEnable = TRUE, and disables the object if nEnable = FALSE. When the object is disabled, its contents cannot be selected or copied etc.

Syntax

DspRichTextEnable(AN, bEnable)

AN:

The reference AN for the rich text object.

bEnable:

The value of this argument determines whether the rich text object at AN will be enabled or disabled. Enter TRUE to enable the object (that is you can select and copy the contents of the RTF object, but you can't make changes). Enter FALSE to disable the object (that is make it display only).

Return Value

0 if successful, otherwise an error is returned.

Related Functions

DspRichTextEdit

Example

// This line disables the rich text object at AN 25 - if one

exists. Otherwise an error will be returned to iResult //

iResult = DspRichTextEnable(25,FALSE);