PdfSaveOptions Class

Namespace:
GemBox.Document
Assembly:
GemBox.Document.dll

Represents a class that stores saving options for Portable Document Format (PDF) file.

public sealed class PdfSaveOptions : SaveOptions
Public NotInheritable Class PdfSaveOptions
    Inherits SaveOptions
Inheritance:
System.Object
PdfSaveOptions
Remarks

For more information about a level of support for PDF format, see supported file formats.

For more information about PDF encryption, see Permissions remarks.

Constructors

PdfSaveOptions()

Initializes a new instance of the PdfSaveOptions class.

public PdfSaveOptions()
Public Sub New

Properties

BookmarksCreateOptions

Gets or sets a value indicating whether to create PDF bookmarks (outlines).

Default value: UsingHeadings (for backward compatibility).

public PdfBookmarksCreateOptions BookmarksCreateOptions { get; set; }
Public Property BookmarksCreateOptions As PdfBookmarksCreateOptions
Property Value
PdfBookmarksCreateOptions

A value indicating whether to create PDF bookmarks (outlines).

ConformanceLevel

Gets or sets the level of conformance for PDF document.

public PdfConformanceLevel ConformanceLevel { get; set; }
Public Property ConformanceLevel As PdfConformanceLevel
Property Value
PdfConformanceLevel

The level of conformance for PDF document.

ContentType

Gets the content-type for PDF file format: application/pdf.

public override string ContentType { get; }
Public Overrides ReadOnly Property ContentType As String
Property Value
System.String

The content-type for PDF file format.

Overrides

DigitalSignature

Gets or sets the digital signature options.

public PdfDigitalSignatureSaveOptions DigitalSignature { get; set; }
Public Property DigitalSignature As PdfDigitalSignatureSaveOptions
Property Value
PdfDigitalSignatureSaveOptions

The digital signature options.

DocumentOpenPassword

Specifies the password required for opening the encrypted PDF document.

public string DocumentOpenPassword { get; set; }
Public Property DocumentOpenPassword As String
Property Value
System.String

The password required for opening the encrypted PDF document.

Remarks

Generated PDF document will be encrypted if any of the following conditions are satisfied:

Both PermissionsPassword and DocumentOpenPassword are optional but with the following consequences:

DocumentOpenPassword and PermissionsPassword cannot be equal, otherwise exception is thrown.

For more information, see PDF Encryption example.

ImageDpi

Gets or sets the saved images DPI.

public int ImageDpi { get; set; }
Public Property ImageDpi As Integer
Property Value
System.Int32

The saved images DPI.

Remarks

This property controls the image quality for all images in the file. Larger value results in better-quality images but increases the file size. Setting this property to 0 will disable image optimization. Standard DPI values are:

  • 330 - Good quality for HD displays
  • 220 - Good quality for most printers and displays
  • 150 - Good quality for web pages and projectors
  • 96 - Good quality for smaller file sizes

MetafileScaleFactor

Gets or sets the scaling factor for rendering metafile (WMF and EMF) images. Greater scaling factor improves quality but also increases file size. Default value is 1.

public double MetafileScaleFactor { get; set; }
Public Property MetafileScaleFactor As Double
Property Value
System.Double

The metafile scale factor for rendering metafile (WMF and EMF) images.

Remarks

Windows Metafile Format (WMF) and Enhanced Metafile Format (EMF) are vector image formats which contain a series of graphics drawing commands usually executed in Windows GDI layer.

Metafile drawing commands could also be executed in PDF (or XPS) file which is also vector format, but for that Metafile drawing commands would have to be converted to PDF drawing commands.

GemBox.Document currently doesn't perform this conversion of drawing commands, instead it uses Windows GDI to execute Metafile drawing commands into bitmap which is then encoded to PNG format and embedded into PDF file.

MetafileScaleFactor specifies the size of the bitmap surface, based from the original Metafile surface size, into which Metafile should be drawn / rasterized.

PDF viewer will still scale the bitmap to the original Metafile size, but if the page is zoomed or viewed on a larger surface, quality of the image will be better since it contains more pixels / dots which will become visible while PDF viewer scales down the image.

MetafileScaleFactor increases the quality of the Metafile image in PDF file, but it also increases the size of the PDF file because greater MetafileScaleFactor means greater bitmap surface and more space to store bitmap pixel / color data. PNG encoding / compression helps in reducing the space requirement and for complex Metafiles (with a lot of drawing instructions), MetafileScaleFactor of 5 or even greater, might not incur any space overhead relative to the original (complex) Metafile.

Default value for MetafileScaleFactor is 1.

Permissions

Gets or sets the operations that are allowed to a user on an encrypted PDF document.

public PdfPermissions Permissions { get; set; }
Public Property Permissions As PdfPermissions
Property Value
PdfPermissions

The operations that are allowed to a user on an encrypted PDF document.

Remarks

Generated PDF document will be encrypted if any of the following conditions are satisfied:

Both PermissionsPassword and DocumentOpenPassword are optional but with the following consequences:

DocumentOpenPassword and PermissionsPassword cannot be equal, otherwise exception is thrown.

For more information, see PDF Encryption example.

PermissionsPassword

Specifies the password for opening the encrypted PDF document without any access restrictions.

public string PermissionsPassword { get; set; }
Public Property PermissionsPassword As String
Property Value
System.String

The password for opening the encrypted PDF document without any access restrictions.

Remarks

Generated PDF document will be encrypted if any of the following conditions are satisfied:

Both PermissionsPassword and DocumentOpenPassword are optional but with the following consequences:

DocumentOpenPassword and PermissionsPassword cannot be equal, otherwise exception is thrown.

For more information, see PDF Encryption example.

RasterizeVectorPictures

Gets or sets a value indicating whether to rasterize vector pictures.

public bool RasterizeVectorPictures { get; set; }
Public Property RasterizeVectorPictures As Boolean
Property Value
System.Boolean

The value indicating whether to rasterize vector pictures.

Version

Gets or sets the version of the PDF specification to which the PDF document conforms specified in the PDF file's header (see 7.5.2, "File Header").

Note that the PDF file's header version might be coerced to a value higher than the one specified in Version if the PDF file uses features that are not supported by the version specified in Version.

If the value is null then PDF file's header version will be automatically set to a specific value depending on the features used in the PDF file.

Default value: null.

public PdfVersion? Version { get; set; }
Public Property Version As PdfVersion?
Property Value
System.Nullable<PdfVersion>

The version of the PDF specification to which the PDF document conforms specified in the PDF file's header.

Events

ProgressChanged

Occurs when saving progress of a document has changed.

public event EventHandler<OperationProgressChangedEventArgs> ProgressChanged
Public Event ProgressChanged As EventHandler(Of OperationProgressChangedEventArgs)
Event Type
System.EventHandler<OperationProgressChangedEventArgs>

Inherited Properties

DocxDefault

Gets the default saving options for Microsoft Word file format. Word file will be saved in Docx format.

(Inherited from SaveOptions)

HtmlDefault

Gets the default saving options for HyperText Markup Language (HTML) format.

(Inherited from SaveOptions)

ImageDefault

Gets the default saving options for image file format. Image will be saved in Bmp format.

(Inherited from SaveOptions)

OdtDefault

Gets the default saving options for Open Document file format.

(Inherited from SaveOptions)

PageCount

Gets or sets the number of pages which should be saved.

(Inherited from SaveOptions)

PageNumber

Gets or sets the zero-based page number of the document's page which should be saved.

(Inherited from SaveOptions)

PdfDefault

Gets the default saving options for Portable Document Format (PDF).

(Inherited from SaveOptions)

RtfDefault

Gets the default saving options for Rich Text (RTF) format.

(Inherited from SaveOptions)

TxtDefault

Gets the default saving options for Plain Text (TXT) format.

(Inherited from SaveOptions)

XmlDefault

Gets the default saving options for XML file format.

(Inherited from SaveOptions)

XpsDefault

Gets the default saving options for XML Paper Specification (XPS) format.

(Inherited from SaveOptions)

Examples

See Also