SubDocument.InsertRtfText(DocumentPosition, String, InsertOptions) Method

Inserts the specified formatted text into the specified position.

Namespace : DevExpress.XtraRichEdit.API.Native

Assembly : DevExpress.RichEdit.v25.2.Core.dll

NuGet Package : DevExpress.RichEdit.Core

Declaration

C#
VB.NET

csharp

DocumentRange InsertRtfText(
    DocumentPosition pos,
    string rtfText,
    InsertOptions insertOptions
)

Function InsertRtfText(
    pos As DocumentPosition,
    rtfText As String,
    insertOptions As InsertOptions
) As DocumentRange

Parameters

Name	Type	Description
pos	DocumentPosition

A DocumentPosition object specifying the position at which the text should be inserted.

| | rtfText | String |

A string in RTF format specifying the text to insert.

| | insertOptions | InsertOptions |

An InsertOptions enumeration value, specifying how destination formatting is applied to inserted content in certain cases.

Returns

Type	Description
DocumentRange

A DocumentRange object representing the DocumentRange.Start and DocumentRange.End positions of the inserted text.

Remarks

The InsertRtfText method imports the specified string in RTF format into the internal document model.

After the string is successfully imported, the new document model is inserted at the specified position of the main document.

Use the InsertOptions.KeepSourceFormatting value for the insertOptions parameter if you observe that the last item in the numbered list is copied as a simple paragraph (not in the list) after insertion using the InsertRtfText method.

The inserted text starts with a new paragraph and preserves formatting. It is inserted into an existing section and gets all section details (header, footer, page and print layout).

If the text being inserted contains document styles which are not present in the current document, the styles are copied to the resulting document.

If the document whose content is being inserted contains floating objects, such as pictures or text boxes, they are inserted into the corresponding positions in a newly created range.

Note

If you want more control over the text before it is inserted, create an instance of the RichEditDocumentServer and load the string into it. Then use the SubDocument.InsertDocumentContent method to insert the modified document.