Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfAnnotationUpdateOptions

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision c8404474f9f2 with working tree changes
Modifiers sealed

Updates for a single indirect PDF annotation during a safe full rewrite.

Inheritance

  • Object
  • PdfAnnotationUpdateOptions

Usage

Explore 1 API references to this type

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

Accepted by parameters 1

Constructors

public PdfAnnotationUpdateOptions() #

Properties

public PdfMutationExecutionPreference ExecutionPreference { get; set; } #

Preferred mutation mode. Automatic uses a full rewrite when safe and append-only when required.

public String? Contents { get; set; } #

Replacement /Contents text. Null leaves the value unchanged.

public String? Title { get; set; } #

Replacement /T title text. Null leaves the value unchanged.

public String? Name { get; set; } #

Replacement /NM annotation name. Null leaves the value unchanged.

public Int32? Flags { get; set; } #

Replacement /F annotation flags. Null leaves the value unchanged.

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

Replacement RGB /C color values in the 0..1 range. Null leaves the value unchanged.

public IReadOnlyList<Double>? InteriorColor { get; set; } #

Replacement gray, RGB, or CMYK /IC interior color values in the 0..1 range. Null leaves the value unchanged.

public Double? Opacity { get; set; } #

Replacement /CA annotation opacity in the 0..1 range. Null leaves the value unchanged.

public Double? BorderWidth { get; set; } #

Replacement /BS border width. Null leaves the value unchanged.

public PdfAnnotationBorderStyle? BorderStyle { get; set; } #

Replacement /BS border style. Null leaves the value unchanged.

public IReadOnlyList<Double>? BorderDashPattern { get; set; } #

Replacement /BS dash pattern. Null leaves the value unchanged.

public Boolean RemoveActions { get; set; } #

Remove /A and /AA action dictionaries from the annotation.

public IReadOnlyList<Double>? Rectangle { get; set; } #

Replacement annotation rectangle as left, bottom, right, top coordinates.

public IReadOnlyList<Double>? QuadPoints { get; set; } #

Replacement text-markup quadrilaterals as groups of eight coordinates.

public IReadOnlyList<Double>? Vertices { get; set; } #

Replacement polygon or polyline vertices as x/y coordinate pairs.

public IReadOnlyList<Double>? Line { get; set; } #

Replacement line endpoints as x1, y1, x2, y2.

public IReadOnlyList<IReadOnlyList<Double>>? InkPaths { get; set; } #

Replacement ink paths; every path is an x/y coordinate sequence.

public String? LineStartEnding { get; set; } #

Replacement line-start ending name, for example None, OpenArrow, or ClosedArrow.

public String? LineEndEnding { get; set; } #

Replacement line-end ending name.

public Int32? InReplyToObjectNumber { get; set; } #

Replacement indirect annotation object used as /IRT reply parent.

public String? ReplyType { get; set; } #

Replacement reply type stored in /RT, normally R or Group.

public PdfAnnotationReviewState? ReviewState { get; set; } #

Replacement standard annotation state and matching state model.

public String? Subject { get; set; } #

Replacement /Subj subject text. Null leaves the value unchanged.

public String? Intent { get; set; } #

Replacement /IT intent name. Null leaves the value unchanged.

public Boolean? PopupOpen { get; set; } #

Replacement popup open state for a popup annotation or linked /Popup dictionary.

public IReadOnlyList<Double>? PopupRectangle { get; set; } #

Replacement linked popup rectangle as left, bottom, right, top coordinates.

public Boolean RegenerateAppearance { get; set; } #

Regenerates a supported normal appearance stream after applying the update.

public Boolean AllowResidualDataInAppendOnly { get; set; } #

Allows append-only updates even though prior revisions retain replaced annotation data. Disabled by default because append-only output is not a sanitization boundary.