API Reference

Class

PdfRedactionAnnotationOptions

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Options for a standard PDF /Redact review annotation.

Inheritance

  • Object
  • PdfRedactionAnnotationOptions

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

public PdfRedactionAnnotationOptions(PdfRedactionRegion region) #

Creates options for a required review region.

Parameters

region OfficeIMO.Pdf.PdfRedactionRegion requiredposition: 0

Properties

public PdfRedactionRegion Region { get; } #

Region recorded by the annotation.

public String Contents { get; set; } #

Optional review note stored in /Contents.

public String Author { get; set; } #

Optional author stored in /T.

public String Name { get; set; } #

Optional stable annotation name stored in /NM.

public IReadOnlyList<Double> Color { get; set; } #

Annotation color. Defaults to red.

public Int32 MaximumAnnotations { get; set; } #

Maximum canonical areas authored from the region, from 1 through 64. Defaults to 16 while annotation creation performs one bounded rewrite per area.

public CancellationToken CancellationToken { get; set; } #

Cooperatively cancels between annotation rewrites.