RichEditControl.CreateDocumentServer() Method

Gets an object implementing the IRichEditDocumentServer interface.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

Declaration

C#

public virtual IRichEditDocumentServer CreateDocumentServer()

VB.NET

Public Overridable Function CreateDocumentServer As IRichEditDocumentServer

Returns

Type	Description
IRichEditDocumentServer	An object with the IRichEditDocumentServer interface.

Remarks

Obtains an object that can be used instead of the RichEditDocumentServer instance. The CreateDocumentServer method is implemented for Mail Merge technique.

Example

The following code creates an instance of Word Processing Document API, loads a document from the stream with the IRichEditDocumentServer.LoadDocument method and inserts the content of the document in the RichEditControl at the caret position using the SubDocument.InsertDocumentContent method.

The RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

View Example

RichEditControlActions.cs

static void buttonCustomAction_ItemClick_DocumentServer(object sender, ItemClickEventArgs e) {
    RichEditControl richEdit = e.Item.Tag as RichEditControl;
    IRichEditDocumentServer server = richEdit.CreateDocumentServer();
    using(System.IO.FileStream fs = new System.IO.FileStream("Documents\\DocumentServerTest.docx", System.IO.FileMode.Open)) {
        server.LoadDocument(fs, DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
        richEdit.Document.InsertDocumentContent(richEdit.Document.CaretPosition, server.Document.Range);
    }
}

RichEditControlActions.vb

Private Shared Sub buttonCustomAction_ItemClick_DocumentServer(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
    Dim server As IRichEditDocumentServer = richEdit.CreateDocumentServer()
    Using fs As New System.IO.FileStream("Documents\DocumentServerTest.docx", System.IO.FileMode.Open)
        server.LoadDocument(fs, DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
        richEdit.Document.InsertDocumentContent(richEdit.Document.CaretPosition, server.Document.Range)
    End Using
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateDocumentServer() 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-create-a-master-detail-report/CS/RichEditMasterDetailMailMerge/Form1.cs#L82

//Create a new RichEditDocumentServer for further processing:
IRichEditDocumentServer result = masterRichEdit.CreateDocumentServer();

winforms-richedit-syntax-highlighting-with-devexpress-codeparser-library/CS/WindowsFormsApplication1/Form1.cs#L20

richEditControl1.ReplaceService<ISyntaxHighlightService>(new HTMLSyntaxHighlightService(richEditControl1));
using(IRichEditDocumentServer server = richEditControl1.CreateDocumentServer()) {
    server.Text = "some HTML text";

winforms-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L280

IRichEditDocumentServer documentServer = richEdit.CreateDocumentServer();
using(FileStream fs = new FileStream("Documents\\testDocumentDOCX.docx", FileMode.Open)) {

VB.NET

winforms-richedit-create-a-master-detail-report/VB/RichEditMasterDetailMailMerge/Form1.vb#L76

'Create a new RichEditDocumentServer for further processing:
Dim result As IRichEditDocumentServer = masterRichEdit.CreateDocumentServer()

winforms-richedit-syntax-highlighting-with-devexpress-codeparser-library/VB/WindowsFormsApplication1/Form1.vb#L19

richEditControl1.ReplaceService(Of ISyntaxHighlightService)(New HTMLSyntaxHighlightService(richEditControl1))
Using server As IRichEditDocumentServer = richEditControl1.CreateDocumentServer()
    server.Text = "some HTML text"

winforms-richeditcontrol-common-api/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L287

Dim documentServer As IRichEditDocumentServer = richEdit.CreateDocumentServer()
Using fs As New System.IO.FileStream("Documents\testDocumentDOCX.docx", System.IO.FileMode.Open)