Skip to main content
All docs
V25.1
  • RichEditDocumentServer.LoadDocument(Byte[], DocumentFormat) Method

    Loads a document in the specified format from a byte array.

    Namespace: DevExpress.XtraRichEdit

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

    NuGet Package: DevExpress.RichEdit.Core

    Declaration

    public bool LoadDocument(
        byte[] buffer,
        DocumentFormat format
    )

    Parameters

    Name Type Description
    buffer Byte[]

    A byte array that contains document data.

    format DocumentFormat

    An enumeration member that specifies the format of the loaded document.

    Returns

    Type Description
    Boolean

    true if the document was successfully loaded; otherwise, false.

    Remarks

    If a document has a different format than the format parameter specifies, the RichEditDocumentServer.InvalidFormatException event fires.

    You can use this LoadDocument method overload to load a document stored in an external database.

    using DevExpress.XtraRichEdit;
    // ...
    
    RichEditDocumentServer wordProcessor = new RichEditDocumentServer()
    
    // Save a document to a byte array to store it in a database.
    byte[] docBytes = wordProcessor.SaveDocument(DocumentFormat.Docx);
    
    // ...
    
    // Load the saved document from a byte array.
    wordProcessor.LoadDocument(docBytes, DocumentFormat.Docx);
    

    Tip

    Use the RichEditDocumentServer.DocumentLoaded event to determine when you can safely modify the document model. Handle the DocumentLayout.DocumentFormatted event to check document layout-related data and objects.

    See Also