Skip to main content
BuyLog In
Office File API
Search in…
Docs > API Reference > DevExpress.Snap > SnapDocumentServer > Members
You are viewing help content for a version that is no longer maintained/updated.
All docs
V21.2
    • .NET Framework 4.5.2+
    • The page you are viewing does not exist in the .NET Standard 2.0+ platform documentation. This link will take you to the parent topic of the current section.
    Office File API
    Demo Application
    Install NuGet Packages
    Redistribution and Deployment (.NET Framework)
    .NET/.NET Core Support
    Sign Office Documents
    Load and Use Custom Fonts in Office File API
    Spreadsheet Document API
    Word Processing Document API
    PDF Document API
    Excel Export Library
    Snap Report API
    Zip Compression and Archive API
    Barcode Generation API
    Unit Conversion API
    API Reference
    DevExpress.BarCodes
    DevExpress.Compression
    DevExpress.Docs.Text
    DevExpress.Office
    DevExpress.Office.DigitalSignatures
    DevExpress.Office.Drawing
    DevExpress.Office.Export
    DevExpress.Office.Export.Html
    DevExpress.Office.Import
    DevExpress.Office.Localization
    DevExpress.Office.Options
    DevExpress.Office.Services
    DevExpress.Office.Tsp
    DevExpress.Office.Utils
    DevExpress.Pdf
    DevExpress.Pdf.Localization
    DevExpress.Pdf.Xmp
    DevExpress.Snap
    SnapDocumentServer
    Members
    Constructors
    Properties
    Methods
    Events
    DevExpress.Spreadsheet
    DevExpress.Spreadsheet.Charts
    DevExpress.Spreadsheet.Drawings
    DevExpress.Spreadsheet.Export
    DevExpress.Spreadsheet.Formulas
    DevExpress.Spreadsheet.Functions
    DevExpress.UnitConversion
    DevExpress.XtraPrinting
    DevExpress.XtraRichEdit
    DevExpress.XtraRichEdit.API.Layout
    DevExpress.XtraRichEdit.API.Native
    DevExpress.XtraRichEdit.API.Native.Implementation
    DevExpress.XtraRichEdit.Commands
    DevExpress.XtraRichEdit.Export
    DevExpress.XtraRichEdit.Export.Html
    DevExpress.XtraRichEdit.Export.PlainText
    DevExpress.XtraRichEdit.Export.Rtf
    DevExpress.XtraRichEdit.Forms
    DevExpress.XtraRichEdit.Import
    DevExpress.XtraRichEdit.Localization
    DevExpress.XtraRichEdit.Services
    DevExpress.XtraRichEdit.Utils
    DevExpress.XtraSpreadsheet
    DevExpress.XtraSpreadsheet.Export
    DevExpress.XtraSpreadsheet.Export.Html
    DevExpress.XtraSpreadsheet.Import
    DevExpress.XtraSpreadsheet.Localization
    DevExpress.XtraSpreadsheet.Services
    Download CHM

    SnapDocumentServer Members

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

    Constructors

    Name Description
    SnapDocumentServer() Initializes a new instance of the SnapDocumentServer class with default settings.

    Properties

    Name Description
    DocBytes Gets or sets the document content as an array of bytes in Microsoft Word 97-2003 format (Doc) format. Inherited from RichEditDocumentServer.
    DocmBytes Gets or sets the document content as an array of bytes in DOCM (Microsoft Office Open XML Macro-Enabled Document) format. Inherited from RichEditDocumentServer.
    Document Provides access to a Snap document stored on the SnapDocumentServer.
    DocumentLayout Provides access to the document layout. Inherited from RichEditDocumentServer.
    DotBytes Gets or sets the document content as an array of bytes in DOT (Microsoft Word 97-2007 Template) format. Inherited from RichEditDocumentServer.
    DotmBytes Gets or sets the document content as an array of bytes in DOTM (Microsoft Office Open XML Macro-Enabled Template) format. Inherited from RichEditDocumentServer.
    DotxBytes Gets or sets the document content as an array of bytes in DOTX (Microsoft Office Open XML macro-free template) format. Inherited from RichEditDocumentServer.
    DpiX Gets the current dpi value for the X-coordinate. Inherited from RichEditDocumentServer.
    DpiY Gets the current dpi value for the Y-coordinate. Inherited from RichEditDocumentServer.
    FlatOpcBytes Gets or sets the document content as an array of bytes in FlatOpc (Microsoft Word XML Document, .xml) format. Inherited from RichEditDocumentServer.
    FlatOpcMacroEnabledBytes Gets or sets the document content as an array of bytes in FlatOpcMacroEnabled (Microsoft Word XML Macro-Enabled Document, .xml) format. Inherited from RichEditDocumentServer.
    FlatOpcMacroEnabledTemplateBytes Gets or sets the document content as an array of bytes in FlatOpcMacroEnabledTemplate (Microsoft Word XML Macro-Enabled Template, .xml) format. Inherited from RichEditDocumentServer.
    FlatOpcTemplateBytes Gets or sets the document content as an array of bytes in FlatOpcTemplate (Microsoft Word XML Template, .xml) format. Inherited from RichEditDocumentServer.
    HtmlText Gets or sets the content as HTML text. Inherited from RichEditDocumentServer.
    HyphenationDictionaries Provides access to the collection of hyphenation dictionaries. Inherited from RichEditDocumentServer.
    IsPrintingAvailable Maintained for compatibility with the code written for the RichEditControl. Inherited from RichEditDocumentServer.
    IsUpdateLocked Returns a value indicating whether the RichEditDocumentServer object is locked for update. Inherited from RichEditDocumentServer.
    LayoutCalculationMode Gets or sets the mode for layout calculation. Inherited from RichEditDocumentServer.
    LayoutUnit Gets or sets a unit of measure used for a document model layout. Inherited from RichEditDocumentServer.
    MhtText Gets or sets the document content as MHT text. Inherited from RichEditDocumentServer.
    Model For internal use. Inherited from RichEditDocumentServer.
    Modified Gets or sets a value that indicates that the document contents is modified since it was last saved. Inherited from RichEditDocumentServer.
    OpenDocumentBytes Gets or sets the document content as an array of bytes in Open Office Text (.odt) format. Inherited from RichEditDocumentServer.
    OpenXmlBytes Gets or sets the document content as an array of bytes in Office Open XML (Docx) format. Inherited from RichEditDocumentServer.
    Options Provides access to the options that determine how a mail-merge document is displayed in a Snap application.
    RtfText Gets or sets the formatted text content of the document. Inherited from RichEditDocumentServer.
    SnxBytes Specifies a byte array that stores a Snap document in the native SNX format.
    Text Gets or sets the plain text content of the document. Inherited from RichEditDocumentServer.
    Unit Gets or sets a unit of measure used within the RichEditDocumentServer. Inherited from RichEditDocumentServer.
    WordMLText Gets or sets the document content as the text in WordProcessingML (Microsoft Office Word 2003 XML) format. Inherited from RichEditDocumentServer.

    Methods

    Name Description
    AddService(Type, ServiceCreatorCallback, Boolean) Adds the specified service to the service container. Inherited from RichEditDocumentServer.
    AddService(Type, ServiceCreatorCallback) Adds the specified service to the service container. Inherited from RichEditDocumentServer.
    AddService(Type, Object, Boolean) Adds the specified service to the service container. Inherited from RichEditDocumentServer.
    AddService(Type, Object) Adds the specified service to the service container. Inherited from RichEditDocumentServer.
    BeginInitialize() For internal use. Inherited from RichEditDocumentServer.
    BeginUpdate() Locks the RichEditDocumentServer object until the RichEditDocumentServer.EndUpdate method is called. Inherited from RichEditDocumentServer.
    CancelUpdate() For internal use. Use the RichEditDocumentServer.EndUpdate method instead. Inherited from RichEditDocumentServer.
    CreateMailMergeOptions() Obsolete. Obsolete. Use the SnapDocumentServer.CreateSnapMailMergeExportOptions property instead.
    CreateNewDocument(Boolean) Creates a new blank document. Inherited from RichEditDocumentServer.
    CreateSnapMailMergeExportOptions() Creates the options that determine how a document is rendered when finishing a mail-merge report.
    Dispose() Releases resources associated with a RichEditDocumentServer instance. Inherited from RichEditDocumentServer.
    EndUpdate() Unlocks the RichEditDocumentServer object. Inherited from RichEditDocumentServer.
    Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
    Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
    ExportDocument(Stream, DocumentFormat) Exports the document to a stream in the specified format.
    ExportDocument(String, DocumentFormat) Exports the document to a file in the specified format.
    ExportToPdf(Stream, PdfExportOptions) Exports the document to the specified stream in PDF format. Inherited from RichEditDocumentServer.
    ExportToPdf(Stream) Exports the document to the specified stream in PDF format. Inherited from RichEditDocumentServer.
    ExportToPdf(String, PdfExportOptions) Exports the content of the RichEditControl to the specified file path in PDF format, applying PDF-specific options. Inherited from RichEditDocumentServer.
    ExportToPdf(String) Exports the document content to the specified file path in PDF format. Inherited from RichEditDocumentServer.
    GetHashCode() Serves as the default hash function. Inherited from Object.
    GetService(Type) Gets the service object of the specified type. Inherited from RichEditDocumentServer.
    GetService<T>() Gets the specified service. Inherited from RichEditDocumentServer.
    GetType() Gets the Type of the current instance. Inherited from Object.
    LoadDocument(Byte[], DocumentFormat, String) Loads a document in the specified format from a byte array. You can use this method to load HTML documents with connected files. Inherited from RichEditDocumentServer.
    LoadDocument(Byte[], DocumentFormat) Loads a document in the specified format from a byte array. Inherited from RichEditDocumentServer.
    LoadDocument(Byte[]) Loads a document from a byte array. The file format is determined based on document content. Inherited from RichEditDocumentServer.
    LoadDocument(Stream, DocumentFormat, String) Loads a document from the stream in the specified format. External content for HTML format is retrieved using the specified source (base) URI. Inherited from RichEditDocumentServer.
    LoadDocument(Stream, DocumentFormat) Loads a document from a stream, specifying the document format. Inherited from RichEditDocumentServer.
    LoadDocument(Stream) Loads a document from the stream. Inherited from RichEditDocumentServer.
    LoadDocument(String, DocumentFormat, String) Loads a document from the file in the specified format. External content for HTML format is retrieved using the specified source (base) URI. Inherited from RichEditDocumentServer.
    LoadDocument(String, DocumentFormat) Loads a document from a file, specifying the document format. Inherited from RichEditDocumentServer.
    LoadDocument(String) Loads a document from the specified file. The file format is determined by its content. Inherited from RichEditDocumentServer.
    LoadDocumentTemplate(Byte[], DocumentFormat) Loads a document template in the specified format from a byte array. Inherited from RichEditDocumentServer.
    LoadDocumentTemplate(Byte[]) Loads a document template from a byte array. Inherited from RichEditDocumentServer.
    LoadDocumentTemplate(Stream, DocumentFormat) Loads a document template with specified format from a stream. Inherited from RichEditDocumentServer.
    LoadDocumentTemplate(Stream) Loads a document template from the stream. Inherited from RichEditDocumentServer.
    LoadDocumentTemplate(String, DocumentFormat) Loads a document template from the file in the specified format. Inherited from RichEditDocumentServer.
    LoadDocumentTemplate(String) Loads a document template from the specified file. Inherited from RichEditDocumentServer.
    MailMerge(Document) Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMerge method instead.
    MailMerge(MailMergeOptions, Document) Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMerge method instead.
    MailMerge(MailMergeOptions, IRichEditDocumentServer) Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMerge method instead.
    MailMerge(MailMergeOptions, Stream, DocumentFormat) Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMerge method instead.
    MailMerge(MailMergeOptions, String, DocumentFormat) Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMerge method instead.
    MailMerge(IRichEditDocumentServer) Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMerge method instead.
    MailMerge(Stream, DocumentFormat) Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMerge method instead.
    MailMerge(String, DocumentFormat) Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMerge method instead.
    MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
    Print() Prints the document to the default printer with the default settings. Inherited from RichEditDocumentServer.
    Print(PrinterSettings, String) Prints the document with the given printer settings and document name. Inherited from RichEditDocumentServer.
    Print(PrinterSettings) Prints the document with the given printer settings. Inherited from RichEditDocumentServer.
    ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
    RemoveService(Type, Boolean) Removes the service of the specified type from the service container. Inherited from RichEditDocumentServer.
    RemoveService(Type) Removes the service of the specified type from the service container. Inherited from RichEditDocumentServer.
    ReplaceService<T>(T) Performs a service substitution. Inherited from RichEditDocumentServer.
    SaveDocument(DocumentFormat, EncryptionSettings) Saves the document to a byte array in the specified file format and encrypts it with a password. Inherited from RichEditDocumentServer.
    SaveDocument(DocumentFormat) Saves the document to a byte array in the specified file format. Inherited from RichEditDocumentServer.
    SaveDocument(Stream, DocumentFormat, EncryptionSettings) Saves the document to a stream, specifying the document’s format and encryption options. Inherited from RichEditDocumentServer.
    SaveDocument(Stream, DocumentFormat) Obsolete. Saves the document to a stream in the specified format.
    SaveDocument(Stream) Saves the document to a stream in the Snap native document format (.SNX)
    SaveDocument(String, DocumentFormat, EncryptionSettings) Saves the document to a file, specifying the document’s format and encryption options. Inherited from RichEditDocumentServer.
    SaveDocument(String, DocumentFormat) Obsolete. Saves the document to a file in the specified format.
    SaveDocument(String) Saves the document to a file in the Snap native document format (.SNX)
    SnapMailMerge(SnapDocument) Starts rendering the specified mail-merge document.
    SnapMailMerge(ISnapDocumentServer) Obsolete. Obsolete. Starts rendering a mail-merge document and saving it to the specified Snap Report API.
    SnapMailMerge(SnapMailMergeExportOptions, SnapDocument) Starts rendering a mail-merge document based on the applied export options and saving it to the specified target document.
    SnapMailMerge(SnapMailMergeExportOptions, ISnapDocumentServer) Obsolete. Obsolete. Starts rendering a mail-merge document based on the applied export options and saving it to the specified Snap Report API.
    SnapMailMerge(SnapMailMergeExportOptions, Stream, DocumentFormat) Starts rendering a mail-merge document based on the applied export options and saving it to a stream in the specified format.
    SnapMailMerge(SnapMailMergeExportOptions, String, DocumentFormat) Starts rendering a mail-merge document based on the applied export options and saving it to a file in the specified format.
    SnapMailMerge(Stream, DocumentFormat) Starts rendering a mail-merge document and saving it to a stream in the specified format.
    SnapMailMerge(String, DocumentFormat) Starts rendering a mail-merge document and saving it to a file in the specified format.
    ToString() Returns a string that represents the current object. Inherited from Object.

    Events

    Name Description
    AfterDataSourceImport Occurs after importing a data source.
    AfterExport Occurs after the document is successfully exported. Inherited from RichEditDocumentServer.
    AsynchronousOperationFinished Occurs after finishing an asynchronous operation in a separate thread.
    AsynchronousOperationStarted Occurs after starting an asynchronous operation in a separate thread.
    BeforeConversion Occurs before a snap document is exported to format other than the native .SNX.
    BeforeDataSourceExport Occurs before exporting a data source.
    BeforeEncodingDetection Occurs before detection of the loaded plain text or HTML encoding. Inherited from RichEditDocumentServer.
    BeforeExport Occurs before the document is saved (exported to a certain format). Inherited from RichEditDocumentServer.
    BeforeImport Occurs before a document is loaded (imported from an external source). Inherited from RichEditDocumentServer.
    BeforeLoadCustomAssembly Occurs when the a report template (.snx file) is loaded which contains the Entity Framework data source originated from a compiled assembly.
    BeforePagePaint Enables you to specify a custom PagePainter descendant to alter the way the layout elements are drawn. Inherited from RichEditDocumentServer.
    CalculateDocumentVariable Fires when the DOCVARIABLE field is updated. Inherited from RichEditDocumentServer.
    CommentInserted Occurs after a new comment is created in the document. Inherited from RichEditDocumentServer.
    ContentChanged Occurs when the document content was changed. Inherited from RichEditDocumentServer.
    CustomAssemblyLoading Obsolete. For internal use.
    CustomPropertiesChanged Occurs when one of the DocumentCustomProperties has changed. Inherited from RichEditDocumentServer.
    DataSourceChanged Occurs when the data source has been changed.
    DecryptionFailed Occurs if the RichEditDocumentServer failed to open an encrypted file. Inherited from RichEditDocumentServer.
    DocBytesChanged For internal use. Inherited from RichEditDocumentServer.
    DocmBytesChanged For internal use Inherited from RichEditDocumentServer.
    DocumentClosing Occurs before closing a SnapDocument.
    DocumentEncryptionChanged Occurs after one of the DocumentEncryption properties has been changed. Inherited from RichEditDocumentServer.
    DocumentLoaded Occurs before loading a SnapDocument into a SnapDocumentServer.
    DocumentPropertiesChanged Occurs after one of the DocumentProperties has changed. Inherited from RichEditDocumentServer.
    DotBytesChanged For internal use. Inherited from RichEditDocumentServer.
    DotmBytesChanged For internal use. Inherited from RichEditDocumentServer.
    DotxBytesChanged For internal use. Inherited from RichEditDocumentServer.
    EmptyDocumentCreated Occurs before creating a new SnapDocument.
    EncryptedFileIntegrityCheckFailed Raises when the encrypted file did not pass the data integrity verification. Inherited from RichEditDocumentServer.
    EncryptedFilePasswordCheckFailed Occurs when the encryption password is empty or invalid. Inherited from RichEditDocumentServer.
    EncryptedFilePasswordRequested Raises when the RichEditDocumentImportOptions.EncryptionPassword property is not set or returns an invalid password. Inherited from RichEditDocumentServer.
    FlatOpcBytesChanged For internal use. Inherited from RichEditDocumentServer.
    FlatOpcMacroEnabledBytesChanged For internal use. Inherited from RichEditDocumentServer.
    FlatOpcMacroEnabledTemplateBytesChanged For internal use. Inherited from RichEditDocumentServer.
    FlatOpcTemplateBytesChanged For internal use. Inherited from RichEditDocumentServer.
    HtmlTextChanged For internal use. Inherited from RichEditDocumentServer.
    InitializeDocument Occurs before a document is loaded. Handle this event to set initial document settings. Inherited from RichEditDocumentServer.
    InvalidFormatException Fires when the supplied data could not be recognized as data in the assumed format for import. Inherited from RichEditDocumentServer.
    MailMergeFinished Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMergeFinished event instead.
    MailMergeRecordFinished Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMergeRecordFinished event instead.
    MailMergeRecordStarted Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMergeRecordStarted event instead.
    MailMergeStarted Obsolete. Obsolete. Use the SnapDocumentServer.SnapMailMergeStarted event instead.
    MhtTextChanged For internal use. Inherited from RichEditDocumentServer.
    ModifiedChanged Occurs when the value of the RichEditDocumentServer.Modified property is changed. Inherited from RichEditDocumentServer.
    OpenDocumentBytesChanged For internal use. Inherited from RichEditDocumentServer.
    OpenXmlBytesChanged For internal use. Inherited from RichEditDocumentServer.
    RtfTextChanged For internal use. Inherited from RichEditDocumentServer.
    SelectionChanged Fires in response to changing a selection in the document. Inherited from RichEditDocumentServer.
    SnapMailMergeFinished Occurs after document merging has finished.
    SnapMailMergeRecordFinished Occurs after data field merging has finished.
    SnapMailMergeRecordStarted Occurs after data field merging has started.
    SnapMailMergeStarted Occurs after document merging has started.
    TrackedMovesConflict Occurs when moved text has been changed since it was moved. Inherited from RichEditDocumentServer.
    UnhandledException This event is raised when an exception unhandled by the RichEditDocumentServer occurs. Inherited from RichEditDocumentServer.
    ValidateCustomSql Allows validation of the custom SQL query created using the Data Source Wizard or the Query Builder.
    WordMLTextChanged For internal use. Inherited from RichEditDocumentServer.
    See Also