PdfSaveOptions Class

Namespace:
GemBox.Presentation
Assembly:
GemBox.Presentation.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 Permissionsremarks.

Constructors

PdfSaveOptions()

Initializes a new instance of the PdfSaveOptions class.

public PdfSaveOptions()
Public Sub New

Properties

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 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

Using this property you basically specify the DPI of the display device on which the file will be viewed and for which the images in the file should be optimized without losing any perceived quality because images go through the same resampling (reduction of pixel count) as they would in the viewer application if viewing the file using the default (100%) zoom factor on that display device.

For example, if an image whose pixel size is 600px × 400px is shown on page where it occupies a slot whose physical size is 150pt × 100pt, then if the display device DPI is 144px/inch, the viewer application will show the image in a display slot whose pixel size is 300px × 200px if the default (100%) zoom factor is used (Rationale: there are always 72 points per inch and for the DPI of 144, there are 144 pixels per inch, so 150[pt] = 150[pt] × 144[px/inch] / 72[pt/inch] = 300[px]).
So the viewer application has to fit an image into a smaller display slot and it will do so by resampling the image from 600px × 400px to 300px × 200px.
Reducing the total number of pixels 4 times (from 240000 to 60000) would also reduce the image file size, so GemBox component can do this instead of the viewer application, thus achieving the overall smaller file size without any perceived loss of quality since the same image resampling would have been done by the viewer application anyway if the default (100%) zoom factor is used.
Instructing the GemBox component to perform image resampling (by setting the ImageDpi property to the DPI of the display device on which the file is going to be viewed) has two effects:

  • Major benefit: output file size will be smaller if there are images whose pixel size is greater than their display size because those images are resampled to a smaller number of pixels without any perceived loss of quality since the same resampling would have been done by the viewer application anyway.
  • Minor benefit: viewer application will be able to present the image faster because it needs to decode a fewer number of pixels and because the display slot size will be exactly equal to the image pixel size so it doesn't have to perform any resampling if the default (100%) zoom factor is used.

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.

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 file has changed.

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

Inherited Properties

Image

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

(Inherited from SaveOptions)

Pdf

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

(Inherited from SaveOptions)

Pptx

Gets the default saving options for PowerPoint Presentation (PPTX) format.

(Inherited from SaveOptions)

Xps

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

(Inherited from SaveOptions)

Examples

See Also