API Reference

Class

PdfRewritePreservationOptions

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Configures the generic preservation checks used after PDF rewrite and manipulation operations.

Inheritance

  • Object
  • PdfRewritePreservationOptions

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

Methods

public PdfRewritePreservationOptions AllowMetadataChanges(params String[] fieldNames) #
Returns: PdfRewritePreservationOptions

Allows specific metadata fields to change and returns this options object for fluent setup.

Parameters

fieldNames System.String[] requiredposition: 0
public PdfRewritePreservationOptions RequireTextMarkers(params String[] markers) #
Returns: PdfRewritePreservationOptions

Adds required text markers and returns this options object for fluent setup.

Parameters

markers System.String[] requiredposition: 0

Properties

public PdfReadOptions OriginalReadOptions { get; set; } #

Read options used to inspect the original document, including its password when encrypted.

public PdfReadOptions RewrittenReadOptions { get; set; } #

Read options used to inspect the rewritten document, including its new password when encrypted.

public Boolean PreservePageCount { get; set; } #

True when the rewritten PDF must keep the original page count.

public Boolean PreservePageGeometry { get; set; } #

True when each unchanged page must keep width, height, and rotation.

public Boolean PreserveMetadata { get; set; } #

True when Info dictionary metadata fields must be preserved except for explicitly allowed fields.

public Boolean PreserveOutlines { get; set; } #

True when outline/bookmark count must not be lost.

public Boolean PreserveNamedDestinations { get; set; } #

True when named destination count must not be lost.

public Boolean PreservePageLabels { get; set; } #

True when page-label count and label ranges must not be lost.

public Boolean PreserveLinkAnnotations { get; set; } #

True when simple link annotation count must not be lost.

public Boolean PreserveAnnotations { get; set; } #

True when generic annotation count must not be lost.

public Boolean PreserveForms { get; set; } #

True when simple AcroForm field count and form markers must not be lost.

public Boolean PreserveEmbeddedFiles { get; set; } #

True when embedded file/associated file count must not be lost.

public Boolean PreserveXmpMetadata { get; set; } #

True when XMP metadata markers must not be lost.

public Boolean PreserveOutputIntents { get; set; } #

True when output intent count must not be lost.

public Boolean PreserveOptionalContent { get; set; } #

True when optional content/layer markers must not be lost.

public Boolean PreserveTaggedContent { get; set; } #

True when tagged PDF structure markers and readable structure metadata must not be lost.

public Boolean PreserveCatalogViewSettings { get; set; } #

True when catalog page mode, layout, language, and viewer preferences must not be lost.

public Boolean PreserveOpenAction { get; set; } #

True when document open-action destination metadata must not be changed.

public Boolean PreserveCatalogActions { get; set; } #

True when catalog-level active action metadata must not be changed.

public Boolean PreservePageActions { get; set; } #

True when page-level additional action metadata must not be changed.

public Boolean PreserveViewerPreferences { get; set; } #

True when viewer preference values must not be changed.

public Boolean PreserveDocumentVersionState { get; set; } #

True when header, catalog, and effective PDF version markers must not be changed.

public Boolean PreserveRevisionStructure { get; set; } #

True when xref-stream, object-stream, previous-revision, and incremental-update markers must not be lost.

public Boolean PreserveSecurityState { get; set; } #

True when security, signature, DSS/VRI, DocMDP, and usage-rights markers must not be lost or changed.

public IList<String> RequiredTextMarkers { get; } #

Text markers that must remain extractable from the rewritten PDF.

public ISet<String> AllowedMetadataChanges { get; } #

Metadata fields that the rewrite is allowed to change. Supported names: Title, Author, Subject, Keywords.