Click or drag to resize
Pdftools logo

RemovalOptions Class

The parameters defining the optional data to remove or flatten

Removal options specify the PDF data structures to copy or remove, e.g. article threads, metadata, or alternate images.

In addition, the visual appearances of signatures, annotations, form fields, and links can be flattened.

Flattening means, that the appearance of such a data structure is drawn as non-editable graphic onto the page; for visual appearances of signatures, flattening has a slightly different meaning (see property RemoveSignatureAppearances).

Inheritance Hierarchy
SystemObject
  PdfTools.InternalNativeBase
    PdfTools.InternalNativeObject
      PdfTools.OptimizationRemovalOptions

Namespace: PdfTools.Optimization
Assembly: PdfTools (in PdfTools.dll) Version: 1.4.0+fc8bb87ea2616e7f35d94e0588d333abae862a7a
Syntax
C#
public class RemovalOptions : NativeObject

The RemovalOptions type exposes the following members.

Properties
 NameDescription
Public propertyAnnotations

The conversion strategy for annotations

The conversion strategy for annotations.

Annotations in PDF are interactive elements on the pages, such as:

  • Sticky notes
  • Free text annotations
  • Line, square, circle, and polygon annotations
  • Highlight, underline and strikeout annotations
  • Stamp annotations
  • Ink annotations
  • File attachment annotation
  • Sound and movie annotations
  • 3D annotations

Note that this does not include form fields (see FormFields) and links (see Links).

Default: Copy in all profiles.

Public propertyFormFields

The conversion strategy for interactive forms

Default: Copy in all profiles.
Public propertyLinks

The conversion strategy for links

Default: Copy in all profiles.
Public propertyRemoveAlternateImages

Whether to remove additional or alternative versions of images

Default: except in the profile Print.
Public propertyRemoveArticleThreads

Whether to remove the sequential flows (threads) of articles

Default: except in the profile Archive.
Public propertyRemoveMetadata

Whether to remove document's XMP metadata

Default:
Public propertyRemoveOutputIntents

Whether to remove all output intents

Output intents provide a means for matching the color characteristics of PDF page content with those of a target output device or production environment in which the document will be printed.

Default: except in the profile MinimalFileSize.

Public propertyRemovePieceInfo

Whether to remove the piece-info dictionary (private PDF processor data)

The removal of this proprietary application data has no effect on the document's visual appearance.

Default: except in the profile Archive.

Public propertyRemoveSignatureAppearances

Whether to remove or flatten signature appearances

A signature in a PDF consist of two parts:

  • (a) The invisible digital signature in the PDF.
  • (b) The visual appearance that was attributed to the signature.

Part (a) can be used by a viewing application, to verify that the PDF has not changed since it has been signed and report this to the user.

During optimizing, the PDF is altered and hence its digital signature (a) is broken and must be removed.

  • Flatten: (a) is removed and (b) is drawn as non-editable graphic onto the page. Within the context of signatures this is called "flattening".
  • Remove: (a) and (b) are removed.

Default: Flatten in all profiles.

Public propertyRemoveStructureTree

Whether to remove the data describing the logical structure of a PDF

The logical structure of the document is a description of the content of its pages. It consists of a fine granular hierarchical tagging that distinguishes between the actual content and artifacts (such as page numbers, layout artifacts, etc.). The tagging provides a meaningful description, for example "This is a header", "This color image shows a small sailing boat at sunset", etc. This information can be used e.g. to read the document to the visually impaired.

Default: except in the profile Archive.

Public propertyRemoveThumbnails

Whether to remove thumbnail images which represent the PDF pages in miniature form

Default: in all profiles.
Top
Methods
 NameDescription
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Top
See Also