SubDocument.AppendDocumentContent(String, DocumentFormat) Method

Appends content from the file.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

DocumentRange AppendDocumentContent(
    string fileName,
    DocumentFormat format
)

VB.NET

Function AppendDocumentContent(
    fileName As String,
    format As DocumentFormat
) As DocumentRange

Parameters

Name	Type	Description
fileName	String	A string representing a filename of the document whose content is being appended.
format	DocumentFormat	A DocumentFormat enumeration specifying the format of the data contained in the file.

Returns

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

Remarks

The AppendDocumentContent 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 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).

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 AppendDocumentContent(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#

winforms-richedit-remove-an-empty-paragraph-when-appending-a-content/CS/Form1.cs#L59

private void AppendDocumentContent() {
    richEditControl1.Document.AppendDocumentContent("sample1.rtf", DocumentFormat.Rtf);
}

how-to-use-docvariable-fields/CS/DocumentVariablesExample/Form1.cs#L68

private void richEditControl1_MailMergeRecordFinished(object sender, MailMergeRecordFinishedEventArgs e) {
    e.RecordDocument.AppendDocumentContent("Docs\\bungalow.docx", DocumentFormat.OpenXml);
}

word-document-api-use-docvariable-fields/CS/WordProcessingFileAPI_CalcDocumentVariable/Program.cs#L87

{
    e.RecordDocument.AppendDocumentContent("Docs\\bungalow.docx", DocumentFormat.OpenXml);
}

wpf-richedit-use-docvariable-fields/CS/MainWindow.xaml.cs#L65

private void richEditControl1_MailMergeRecordFinished(object sender, MailMergeRecordFinishedEventArgs e) {
    e.RecordDocument.AppendDocumentContent("Docs\\bungalow.docx", DocumentFormat.OpenXml);
}

word-document-api-examples/CS/CodeExamples/BasicActions.cs#L37

// Insert content from the file at the document end.
wordProcessor.Document.AppendDocumentContent("Documents//MovieRentals.docx",DocumentFormat.OpenXml);
#endregion #MergeDocuments

VB.NET

winforms-richedit-remove-an-empty-paragraph-when-appending-a-content/VB/Form1.vb#L55

Private Sub AppendDocumentContent()
    richEditControl1.Document.AppendDocumentContent("sample1.rtf", DocumentFormat.Rtf)
End Sub

how-to-use-docvariable-fields/VB/DocumentVariablesExample/Form1.vb#L67

Private Sub richEditControl1_MailMergeRecordFinished(ByVal sender As Object, ByVal e As MailMergeRecordFinishedEventArgs)
    e.RecordDocument.AppendDocumentContent("Docs\bungalow.docx", DocumentFormat.OpenXml)
End Sub

word-document-api-use-docvariable-fields/VB/WordProcessingFileAPI_CalcDocumentVariable/Program.vb#L70

Private Shared Sub wordProcessor_MailMergeRecordFinished(ByVal sender As Object, ByVal e As MailMergeRecordFinishedEventArgs)
    e.RecordDocument.AppendDocumentContent("Docs\bungalow.docx", DocumentFormat.OpenXml)
End Sub

wpf-richedit-use-docvariable-fields/VB/MainWindow.xaml.vb#L64

Private Sub richEditControl1_MailMergeRecordFinished(ByVal sender As Object, ByVal e As MailMergeRecordFinishedEventArgs)
    e.RecordDocument.AppendDocumentContent("Docs\bungalow.docx", DocumentFormat.OpenXml)
End Sub

word-document-api-examples/VB/CodeExamples/BasicActions.vb#L40

            ' Insert content from the file at the document end.
            wordProcessor.Document.AppendDocumentContent("Documents//MovieRentals.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
#End Region  ' #MergeDocuments