SubDocument.InsertRtfText(DocumentPosition, String) Method

Inserts the specified formatted text into the specified position.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

DocumentRange InsertRtfText(
    DocumentPosition pos,
    string rtfText
)

VB.NET

Function InsertRtfText(
    pos As DocumentPosition,
    rtfText As String
) 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.

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.

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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the InsertRtfText(DocumentPosition, String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-replace-document-fields-with-their-values-e3482/CS/Form1.cs#L49

    document.Delete(field.Range);
    document.InsertRtfText(fieldPosition, fieldResult);
}

search-api-an-example-of-use-e3147/CS/Form1.cs#L34

DocumentRange insertRange = richEditControl1.Document.InsertText(searchResult.CurrentResult.Start, replaceString);
richEditControl1.Document.InsertRtfText(insertRange.End, replaceRtfPart.Replace("$number$", count.ToString()));
count++;

RichEdit-How-to-insert-RTF-text-to-a-document/CS/RichInsertRTF/Controllers/HomeController.cs#L39

var pos = server.Document.CreatePosition(position.Value);
server.Document.InsertRtfText(pos, rtf);

VB.NET

how-to-replace-document-fields-with-their-values-e3482/VB/Form1.vb#L51

    document.Delete(field.Range)
    document.InsertRtfText(fieldPosition, fieldResult)
Next i

search-api-an-example-of-use-e3147/VB/Form1.vb#L36

Dim insertRange As DocumentRange = richEditControl1.Document.InsertText(searchResult.CurrentResult.Start, replaceString)
richEditControl1.Document.InsertRtfText(insertRange.End, replaceRtfPart.Replace("$number$", count.ToString()))
count += 1

RichEdit-How-to-insert-RTF-text-to-a-document/VB/RichInsertRTFVB/Controllers/HomeController.vb#L27

Dim pos = server.Document.CreatePosition(position.Value)
server.Document.InsertRtfText(pos, rtf)