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

DspRichTextEdit

Enables editing of the contents of the rich text object at AN if nEdit = TRUE, and disables editing if nEdit = FALSE.

Syntax

DspRichTextEdit(AN, bEdit)

AN:

The reference AN for the rich text object.

bEdit:

The value of this argument determines whether you will be able to edit the contents of the rich text object at AN. Enter TRUE to enable editing, or enter FALSE to make the contents read-only.

Changes made to the contents of the object will not be saved until the DspRichTextSave function is used.

Return Value

0 if successful, otherwise an error is returned.

Related Functions

PageRichTextFile, DspRichTextEnable, DspRichTextSave

Example

// Enables editing of the rich text object at AN 25 - if one
exists. Otherwise an error will be returned to iResult //
iResult = DspRichTextEdit(25,TRUE);

See Also

Display Functions