SubDocument.InsertDocumentContent(DocumentPosition, Stream, DocumentFormat, String) Method

Insert content from the stream in the current document at the specified position.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

DocumentRange InsertDocumentContent(
    DocumentPosition pos,
    Stream stream,
    DocumentFormat format,
    string sourceUri
)

VB.NET

Function InsertDocumentContent(
    pos As DocumentPosition,
    stream As Stream,
    format As DocumentFormat,
    sourceUri As String
) As DocumentRange

Parameters

Name	Type	Description
pos	DocumentPosition	A DocumentPosition specifying the position in the current document after which, content is inserted.
stream	Stream	A Stream representing a sequence of bytes interpreted as the content to insert.
format	DocumentFormat	A DocumentFormat enumeration specifying the format of data contained in the stream.
sourceUri	String	A string representing the URI for the document being inserted. Required to import formats with external content such as HTML.

Returns

Type	Description
DocumentRange	A DocumentRange representing the document range with inserted content.

Remarks

The InsertDocumentContent method loads the specified stream into the internal document model with the help of the specific importer. The sourceUri parameter is passed to the importer so the importer may use it when required. If the HTML-specific importer is created, the sourceUri is used to find pictures and other external content, such as .css files.

After the stream is imported successfully, 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.

When you pass the DocumentFormat.Undefined value as the format parameter, the inserted content’s format is determined automatically.