SubDocument.AppendDocumentContent(DocumentRange, InsertOptions) Method

Appends content from the specified range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

DocumentRange AppendDocumentContent(
    DocumentRange range,
    InsertOptions insertOptions
)

VB.NET

Function AppendDocumentContent(
    range As DocumentRange,
    insertOptions As InsertOptions
) As DocumentRange

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange to append.
insertOptions	InsertOptions	An InsertOptions enumeration value, specifying how destination formatting is applied to inserted content in certain cases.

Returns

Type	Description
DocumentRange	A DocumentRange representing a range with the appended content.

Remarks

The AppendDocumentContent method inserts the specified document range at the end of the main document.

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

Specify the insertOptions parameter to define how formatting is applied to the formatted text inserted into a document. Refer to the InsertOptions enumeration description for information on how formatting is applied to the pasted document elements depending on the property value.

When the content being inserted is divided into sections, the inserted and destination sections interact as follows:

• If the content is inserted into an empty document, all inserted section properties are retained.
• If the content is inserted into a document divided into sections, all but the last inserted sections retain their parameters. The last section takes on the destination section’s options.
• If the content is inserted after a section break, both destination and inserted sections retain their properties.

If the content is copied without section properties (the last section’s paragraph is not included), the destination section’s settings stay intact after insertion.

If the text being inserted contains document styles that 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. The Shape.Range property of a floating object determines whether it falls within the range being inserted and will therefore be added to the resulting document.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AppendDocumentContent(DocumentRange, InsertOptions) 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#

snap-convert-snx-to-repx/CS/SnxToRepx/Converter/SnapReportConverter.cs#L167

SubDocument headerDocument = section.BeginUpdateHeader(HeaderFooterType.Primary);
server.Document.AppendDocumentContent(headerDocument.Range, InsertOptions.KeepSourceFormatting);
section.EndUpdateHeader(headerDocument);

VB.NET

snap-convert-snx-to-repx/VB/SnxToRepx/Converter/SnapReportConverter.vb#L142

Dim headerDocument As SubDocument = section.BeginUpdateHeader(HeaderFooterType.Primary)
server.Document.AppendDocumentContent(headerDocument.Range, InsertOptions.KeepSourceFormatting)
section.EndUpdateHeader(headerDocument)