PdfSnapshotSettings Class

Configures how a PDF document is converted to snapshot files: the rendering of its pages and the content of its metadata file.

public sealed class PdfSnapshotSettings

Constructors

NameDescription
PdfSnapshotSettings()

PdfSnapshotSettings()

PdfSnapshotSettings.cs
public PdfSnapshotSettings()

No documentation is available.

Properties

NameDescription
DpiGets or sets the resolution the pages are rendered at, in dots per inch. The default, 72, renders one pixel per point: an A4 page is 595×842 pixels.
MetadataGets or sets the optional parts of the JSON metadata file. The default is PdfSnapshotMetadata.Default.
PasswordGets or sets the password of an encrypted document: its user or owner password.
RenderAnnotationsGets or sets a value indicating whether the appearances of the annotations are drawn on the pages. The default is true.
UseSystemFontsGets or sets a value indicating whether the fonts of the system replace the fonts the document does not embed. The default, false, uses the fonts bundled with Meziantou.Framework.Pdf, so the pages render the same on every machine.

Gets or sets the resolution the pages are rendered at, in dots per inch. The default, 72, renders one pixel per point: an A4 page is 595×842 pixels.

public double Dpi { get; set; }

Property value

double

Exceptions

ArgumentOutOfRangeException
The value is not a finite positive number.

Gets or sets the optional parts of the JSON metadata file. The default is PdfSnapshotMetadata.Default.

public PdfSnapshotMetadata Metadata { get; set; }

Property value

PdfSnapshotMetadata

Gets or sets the password of an encrypted document: its user or owner password.

public string? Password { get; set; }

Property value

string?

RenderAnnotations

PdfSnapshotSettings.cs

Gets or sets a value indicating whether the appearances of the annotations are drawn on the pages. The default is true.

public bool RenderAnnotations { get; set; }

Property value

bool

Gets or sets a value indicating whether the fonts of the system replace the fonts the document does not embed. The default, false, uses the fonts bundled with Meziantou.Framework.Pdf, so the pages render the same on every machine.

public bool UseSystemFonts { get; set; }

Property value

bool