SnapDocumentServer Class

A non-visual reporting engine providing all the functionality of Snap.

Namespace: DevExpress.Snap

Assembly: DevExpress.Docs.v21.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public class SnapDocumentServer :
    RichEditDocumentServer,
    ISnapDocumentServer,
    IRichEditDocumentServer,
    IBatchUpdateable,
    IServiceContainer,
    IServiceProvider,
    IDisposable,
    ISnapDriver

VB.NET

Public Class SnapDocumentServer
    Inherits RichEditDocumentServer
    Implements ISnapDocumentServer,
               IRichEditDocumentServer,
               IBatchUpdateable,
               IServiceContainer,
               IServiceProvider,
               IDisposable,
               ISnapDriver

Remarks

The following code uses the Snap Report API to generate a mail-merge report in the context of the DevExpress Office File API.

It is a console application that creates a document and then exports it to an RTF file.

To use the SnapDocumentServer, the project requires references to the following assemblies:

• DevExpress.Data.v21.2.dll
• DevExpress.Docs.v21.2.dll
• DevExpress.Office.v21.2.Core.dll
• DevExpress.RichEdit.v21.2.Core.dll
• DevExpress.Snap.v21.2.Core.dll

To perform mail merge, the application requires a template - a file in the native .SNX format which contains the document layout, specific fields and data source information. The template file must be created beforehand using the Snap Design Surface. For an example of template creation, review the Lesson 3 - Create a Mail Merge Report.

The code handles the SnapDocumentServer.SnapMailMergeRecordStarted and SnapDocumentServer.SnapMailMergeRecordFinished events to make adjustments to the merged document created for the particular data record.

The server loads a mail merge template using the RichEditDocumentServer.LoadDocument method. Subsequently, the code creates the SnapMailMergeExportOptions object and assigns the data source by specifying the IDataSourceContainerOptions.DataSource property. The mail merge operation is performed by calling the SnapDocumentServer.SnapMailMerge method.

C#

SnapDocumentServer server = new SnapDocumentServer();

server.SnapMailMergeRecordStarted += server_SnapMailMergeRecordStarted;
server.SnapMailMergeRecordFinished += server_SnapMailMergeRecordFinished;

server.LoadDocument(templateFileName);
object dataSource = CreateDataSource();

SnapMailMergeExportOptions options = server.Document.CreateSnapMailMergeExportOptions();
options.DataSource = dataSource;
Console.Write("Performing mail merge... ");
server.SnapMailMerge(options, outputFileName, DocumentFormat.Rtf);

VB.NET

Imports DevExpress.Snap
Imports DevExpress.Snap.Core.API
Imports DevExpress.XtraRichEdit
Imports DevExpress.Snap.Core.Options
Imports MailMergeServer.nwindDataSetTableAdapters
Imports System
Imports System.Data.OleDb
Imports System.IO
' ...

Dim server As New SnapDocumentServer()

AddHandler server.SnapMailMergeRecordStarted, AddressOf server_SnapMailMergeRecordStarted
AddHandler server.SnapMailMergeRecordFinished, AddressOf server_SnapMailMergeRecordFinished

server.LoadDocument(templateFileName)
Dim dataSource As Object = CreateDataSource()

Dim options As SnapMailMergeExportOptions = server.Document.CreateSnapMailMergeExportOptions()
options.DataSource = dataSource
Console.Write("Performing mail merge... ")
server.SnapMailMerge(options, outputFileName, DocumentFormat.Rtf)

Implements

IRichEditDocumentServer

Inheritance

Object

RichEditDocumentServer

SnapDocumentServer

Extension Methods

Show 54 items

LoadDocumentAsync(Stream)

LoadDocumentAsync(Stream, CancellationToken)

LoadDocumentAsync(Stream, DocumentFormat)

LoadDocumentAsync(Stream, DocumentFormat, CancellationToken)

LoadDocumentAsync(String)

LoadDocumentAsync(String, CancellationToken)

LoadDocumentAsync(String, DocumentFormat)

LoadDocumentAsync(String, DocumentFormat, CancellationToken)

LoadDocumentAsync(Stream, DocumentFormat, String)

LoadDocumentAsync(Stream, DocumentFormat, String, CancellationToken)

LoadDocumentAsync(String, DocumentFormat, String)

LoadDocumentAsync(String, DocumentFormat, String, CancellationToken)

LoadDocumentAsync(Byte[])

LoadDocumentAsync(Byte[], CancellationToken)

LoadDocumentAsync(Byte[], DocumentFormat)

LoadDocumentAsync(Byte[], DocumentFormat, CancellationToken)

LoadDocumentAsync(Byte[], DocumentFormat, String)

LoadDocumentAsync(Byte[], DocumentFormat, String, CancellationToken)

LoadDocumentTemplateAsync(Byte[])

LoadDocumentTemplateAsync(Byte[], CancellationToken)

LoadDocumentTemplateAsync(Byte[], DocumentFormat)

LoadDocumentTemplateAsync(Byte[], DocumentFormat, CancellationToken)

LoadDocumentTemplateAsync(String)

LoadDocumentTemplateAsync(String, CancellationToken)

LoadDocumentTemplateAsync(String, DocumentFormat)

LoadDocumentTemplateAsync(String, DocumentFormat, CancellationToken)

LoadDocumentTemplateAsync(Stream)

LoadDocumentTemplateAsync(Stream, CancellationToken)

LoadDocumentTemplateAsync(Stream, DocumentFormat)

LoadDocumentTemplateAsync(Stream, DocumentFormat, CancellationToken)

SaveDocumentAsync(String, DocumentFormat)

SaveDocumentAsync(String, DocumentFormat, CancellationToken)

SaveDocumentAsync(Stream, DocumentFormat)

SaveDocumentAsync(Stream, DocumentFormat, CancellationToken)

SaveDocumentAsync(Stream, DocumentFormat, EncryptionSettings)

SaveDocumentAsync(Stream, DocumentFormat, EncryptionSettings, CancellationToken)

SaveDocumentAsync(String, DocumentFormat, EncryptionSettings)

SaveDocumentAsync(String, DocumentFormat, EncryptionSettings, CancellationToken)

SaveDocumentAsync(DocumentFormat)

SaveDocumentAsync(DocumentFormat, CancellationToken)

SaveDocumentAsync(DocumentFormat, EncryptionSettings)

SaveDocumentAsync(DocumentFormat, EncryptionSettings, CancellationToken)

ExportToPdfAsync(Stream)

ExportToPdfAsync(Stream, CancellationToken)

ExportToPdfAsync(Stream, PdfExportOptions)

ExportToPdfAsync(Stream, PdfExportOptions, CancellationToken)

ExportToPdfAsync(String)

ExportToPdfAsync(String, CancellationToken)

ExportToPdfAsync(String, PdfExportOptions)

ExportToPdfAsync(String, PdfExportOptions, CancellationToken)

LoadDocumentProperties(String)

LoadDocumentProperties(String, DocumentFormat)

LoadDocumentProperties(Stream)

LoadDocumentProperties(Stream, DocumentFormat)