PasteRTF

Description

Pastes rich text data from a string into a DataWindow control or DataStore object.

Applies to

DataWindow type

Method applies to

PowerBuilder

DataWindow control, DataStore object


Syntax

PowerBuilder

long rtename.PasteRTF ( string richtextstring, { Band band } )

Argument

Description

rtename

A reference to a DataWindow control or DataStore object. The DataWindow object in the DataWindow control or DataStore must be a RichTextEdit DataWindow.

richtextstring

A string whose value is data with rich text formatting.

band (optional)

A value specifying the band into which the rich text data is pasted. For a list of valid values, see Band.

The default is the band that contains the insertion point.


Return value

Returns -1 if an error occurs. If richtextstring is null, PasteRTF returns null.

Usage

A DataWindow in the RTE presentation style has only three bands. There are no summary or trailer bands and there are no group headers and footers.

PowerBuilder RichText Edit control

You can use the same syntax with any PowerBuilder RichTextEdit control. See the section called “PasteRTF” in PowerScript Reference.

Examples

This statement pastes rich text in the string ls_richtext into the header of the RichTextEdit rte_message:

string ls_richtext
rte_message.PasteRTF(ls_richtext, Header!)

See also

CopyRTF