Class PdfSettings

Namespace

PDiffy

Assembly

PDiffy.dll

Document-wide settings that change how a viewer opens, shows or restricts the file.

public sealed record PdfSettings : IEquatable<PdfSettings>

Inheritance

object

PdfSettings

Implements

IEquatable<PdfSettings>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CatalogVersion

The catalog's /Version, which a writer can set to upgrade the file. A viewer uses whichever is later.

public string? CatalogVersion { get; init; }

Property Value

string

EmbeddedFiles

The files embedded in the document: those in its list of attachments, in their order, then those attached through comments (FileAttachment annotations), page by page; empty when none.

public IReadOnlyList<PdfEmbeddedFile> EmbeddedFiles { get; init; }

Property Value

IReadOnlyList<PdfEmbeddedFile>

HasAdditionalActions

Whether the document runs actions on events such as closing, saving or printing.

public bool HasAdditionalActions { get; init; }

Property Value

bool

HasJavaScript

Whether the document has JavaScript in its document-level scripts, open action, document actions, form fields, links and other annotations, page actions or bookmarks.

public bool HasJavaScript { get; init; }

Property Value

bool

IsEncrypted

Whether the file is encrypted. Permissions says what it allows.

public bool IsEncrypted { get; init; }

Property Value

bool

LayerConfigurations

The optional-content configurations: the default one, then the others a viewer can switch to; empty when the document has no layers.

public IReadOnlyList<PdfLayerConfiguration> LayerConfigurations { get; init; }

Property Value

IReadOnlyList<PdfLayerConfiguration>

Layers

The optional-content layers a viewer can show or hide, in order; empty when there are none.

public IReadOnlyList<PdfLayer> Layers { get; init; }

Property Value

IReadOnlyList<PdfLayer>

OpenActions

The actions the file runs when it opens, such as going to page 1, in the order they run: the open action, then any chained after it. Empty when there are none.

public IReadOnlyList<PdfAction> OpenActions { get; init; }

Property Value

IReadOnlyList<PdfAction>

PageLayout

How pages are arranged: one at a time, a continuous column, two side by side. One of PdfPageLayouts.

public string? PageLayout { get; init; }

Property Value

string

PageMode

How the file opens: thumbnails, bookmarks, full screen and so on. One of PdfPageModes.

public string? PageMode { get; init; }

Property Value

string

PdfVersion

The version in the file header.

public string? PdfVersion { get; init; }

Property Value

string

Permissions

What an encrypted document allows. Null when the document isn't encrypted.

public PdfPermissions? Permissions { get; init; }

Property Value

PdfPermissions?

ReferenceXObjects

How many reference XObjects (form XObjects that show a page of another file, /Ref) are in the pages' resources, their annotations' appearances and the resources of the forms in them, whether or not the pages draw them.

public int ReferenceXObjects { get; init; }

Property Value

int

ViewerPreferences

Viewer preferences other than DisplayDocTitle, which PdfDocumentInfo holds.

public IReadOnlyList<PdfProperty> ViewerPreferences { get; init; }

Property Value

IReadOnlyList<PdfProperty>