SubDocument.InsertDocumentContent(DocumentPosition, String, DocumentFormat) Method

Inserts content from the file in the current document at the specified position.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

DocumentRange InsertDocumentContent(
    DocumentPosition pos,
    string fileName,
    DocumentFormat format
)

VB.NET

Function InsertDocumentContent(
    pos As DocumentPosition,
    fileName As String,
    format As DocumentFormat
) As DocumentRange

Parameters

Name	Type	Description
pos	DocumentPosition	A DocumentPosition specifying the position in the current document, after which content is inserted.
fileName	String	A string representing a filename of the document whose content is being inserted.
format	DocumentFormat	A DocumentFormat enumeration specifying the format of the data contained in the file.

Returns

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

Remarks

The InsertDocumentContent method imports the specified file into the internal document model. If the format parameter is set to DocumentFormat.Undefined, the importer attempts to auto detect the format of the specified file.

If the format auto detect fails, a fallback format is used. Currently the fallback format is plain text.

After the file 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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the InsertDocumentContent(DocumentPosition, String, DocumentFormat) 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#

protection-how-to-programmatically-create-a-protected-document-and-apply-range-permissions-e3017/CS/ReadOnlyRangesInCodeExample/Form1.cs#L60

DocumentPosition pos = richEditControl1.Document.CreatePosition(richEditControl1.Document.Range.End.ToInt() - 2);
DocumentRange range = richEditControl1.Document.InsertDocumentContent(pos, filename, DocumentFormat.OpenXml);
return range;

range-permissions-simple-example-t445222/CS/RangePermissionsSimpleExample/Form1.cs#L67

DocumentPosition pos = richEditControl1.Document.CreatePosition(richEditControl1.Document.Range.End.ToInt() - 2);
DocumentRange range = richEditControl1.Document.InsertDocumentContent(pos, filename, DocumentFormat.OpenXml);
return range;

page-layout-simple-example-t553072/CS/PageLayout/Form1.cs#L34

document.AppendSection();
document.InsertDocumentContent(document.Range.End, "Documents//Last Section.docx", DocumentFormat.OpenXml);
#endregion #InsertSections

VB.NET

protection-how-to-programmatically-create-a-protected-document-and-apply-range-permissions-e3017/VB/ReadOnlyRangesInCodeExample/Form1.vb#L58

Dim pos As DocumentPosition = richEditControl1.Document.CreatePosition(richEditControl1.Document.Range.End.ToInt() - 2)
Dim range As DocumentRange = richEditControl1.Document.InsertDocumentContent(pos, filename, DocumentFormat.OpenXml)
Return range

range-permissions-simple-example-t445222/VB/RangePermissionsSimpleExample/Form1.vb#L64

Dim pos As DocumentPosition = richEditControl1.Document.CreatePosition(richEditControl1.Document.Range.End.ToInt() - 2)
Dim range As DocumentRange = richEditControl1.Document.InsertDocumentContent(pos, filename, DocumentFormat.OpenXml)
Return range

page-layout-simple-example-t553072/VB/PageLayout/Form1.vb#L32

            document.AppendSection()
            document.InsertDocumentContent(document.Range.End, "Documents//Last Section.docx", DocumentFormat.OpenXml)
'            #End Region ' #InsertSections