PdfViewerExtensions.SaveDocument(IPdfViewer, String, PdfSaveOptions) Method

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

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public static bool SaveDocument(
    this IPdfViewer viewer,
    string path,
    PdfSaveOptions options
)

VB.NET

<ExtensionAttribute>
Public Shared Function SaveDocument(
    viewer As IPdfViewer,
    path As String,
    options As PdfSaveOptions
) As Boolean

Parameters

Name	Type	Description
viewer	IPdfViewer	A PdfViewer or PdfViewerControl object that implements the IPdfViewer interface.
path	String	A System.String, specifying the path to the directory to which the PDF document should be saved.
options	PdfSaveOptions	A PdfSaveOptions that contains the encryption and sign settings of a PDF document that should be saved.

Returns

Type	Description
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.

Note

The PDF Viewer locks a file while a document is saved (the PdfViewer.DetachStreamAfterLoadComplete or PdfViewerControl.DetachStreamOnLoadComplete property is set to false by default). To unlock the file, set the PdfViewer.DetachStreamAfterLoadComplete (PdfViewerControl.DetachStreamOnLoadComplete) property to true.