Back to Devexpress

PdfViewerExtensions.SaveDocument(IPdfViewer, Stream, PdfSaveOptions) Method

officefileapi-devexpress-dot-pdf-dot-pdfviewerextensions-dot-savedocument-x28-devexpress-dot-pdf-dot-ipdfviewer-system-dot-io-dot-stream-devexpress-dot-pdf-dot-pdfsaveoptions-x29.md

latest3.3 KB
Original Source

PdfViewerExtensions.SaveDocument(IPdfViewer, Stream, PdfSaveOptions) Method

Saves the document to the specified stream with encryption settings and document signature. This is an extension method.

Namespace : DevExpress.Pdf

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

Declaration

csharp
public static bool SaveDocument(
    this IPdfViewer viewer,
    Stream stream,
    PdfSaveOptions options
)
vb
<ExtensionAttribute>
Public Shared Function SaveDocument(
    viewer As IPdfViewer,
    stream As Stream,
    options As PdfSaveOptions
) As Boolean

Parameters

NameTypeDescription
viewerIPdfViewer

A PdfViewer or PdfViewerControl object that implements the IPdfViewer interface.

| | stream | Stream |

A System.IO.Stream value specifying the location of the saved document.

| | options | PdfSaveOptions |

A PdfSaveOptions that contains the encryption and sign settings of a PDF document that should be saved.

|

Returns

TypeDescription
Boolean

true , if the document is saved successfully; false , if the document saving operation is cancelled by the user.

|

Remarks

See the Document Protection and Signing Document topics to learn more.

The SaveDocument method expects the input stream will not be closed or modified while a PDF document is saved (the PdfViewer.DetachStreamAfterLoadComplete or PdfViewerControl.DetachStreamOnLoadComplete property is set to false by default). Be aware that disposing of an output stream that has not been detached may cause errors on an attempt to apply further changes to a document. If you want to close the stream when a document is saved, set the PdfViewer.DetachStreamAfterLoadComplete (PdfViewerControl.DetachStreamOnLoadComplete) property to true.

See Also

PdfViewerExtensions Class

PdfViewerExtensions Members

DevExpress.Pdf Namespace