• DR-IT Software
  • Products
  • Documentation
  • Product page
  • Examples
  • API reference
  • Support
Show / Hide Table of Contents

Namespace DRIT.Pdf.Annotations

Classes

Annotation

Abstract base class for all PDF annotations (spec §12.5.1). Every annotation is associated with a page and has a rectangular active area (the /Rect entry) plus optional common entries: /Contents, /Name, /M, /F (flags), /C (color), /BS (border style), /A (action), and /AP (appearance).

AnnotationCollection

Collection of annotations attached to a PDF page (spec §12.5). Use the various Add* factory methods to create annotations. The collection serializes all annotations into the page's /Annots array during Save(Stream).

BorderStyle

Border style for annotations (PDF spec §12.5.4 — /BS dictionary). Controls the width, dash pattern, and style of the annotation border.

CaretAnnotation

A caret annotation (PDF spec §12.5.11). A symbol indicating that text should be inserted at the point indicated by the annotation's rectangle.

CircleAnnotation

A circle (ellipse) annotation (PDF spec §12.5.7.2). Displays an ellipse inscribed in the /Rect bounding box, with optional border and interior fill.

FileAttachmentAnnotation

A file-attachment annotation (PDF spec §12.5.6.15). Provides a reference to an embedded file, displayed as an icon on the page. When activated, the viewer opens the embedded file.

FileAttachmentAppearance

Appearance settings for FileAttachmentAnnotation.

FreeTextAnnotation

A free-text annotation (PDF spec §12.5.6.6). Displays text directly on the page, optionally with a callout line. Unlike a sticky-note, the text is always visible — not hidden behind a popup.

InkAnnotation

An ink (freehand / pencil-mark) annotation (PDF spec §12.5.8). Represents one or more stroked paths drawn freehand by the user. Each ink path is a list of points; multiple paths are stored in the /InkList array.

LineAnnotation

A line annotation (PDF spec §12.5.6.7). Draws a straight line between two points on the page, with optional measurement metadata.

LinkAnnotation

A link annotation (PDF spec §12.5.6.19). Represents a hyperlink or internal navigation target that the user can activate by clicking within the annotation's rectangle. The action is set via the Actions property.

MarkupAnnotation

Abstract base class for markup annotations (PDF spec §12.5.6). Markup annotations carry additional metadata for review workflows: title (author), subject, creation date, rich text, reply threading, and an optional popup annotation.

Measurement

Measurement metadata for annotation dictionaries (PDF /Measure dictionary). Used by line, polyline, and polygon annotations to specify scale and units.

PolygonAnnotation

A polygon annotation (PDF spec §12.5.6.9). Draws a closed polygon shape on the page. The vertices are stored in the /Vertices array and the shape is implicitly closed.

PolylineAnnotation

A polyline annotation (PDF spec §12.5.6.8). Draws an open sequence of connected line segments. The vertices are stored in the /Vertices array.

PopupAnnotation

A popup annotation (PDF spec §12.5.7) displays a pop-up window containing text. Typically associated with a markup annotation via the markup's /Popup entry.

RedactionAnnotation

A redaction annotation (PDF spec §12.5.13). Marks regions of the page for permanent removal. When ApplyRedactions() is called, the content within each redaction region is permanently removed and filled with the specified overlay color.

SquareAnnotation

A square (rectangle) annotation (PDF spec §12.5.7.1). Displays a rectangle on the page defined by /Rect, with optional border and interior fill.

StampAnnotation

A rubber-stamp annotation (PDF spec §12.5.12). Displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. The standard stamp name is set via Icon.

StickyNoteAnnotation

A sticky-note (text) annotation (PDF spec §12.5.6.4). Displays a small icon on the page; when activated, a popup window shows the note text. The icon is selected via Icon.

TextMarkupAnnotation

A text-markup annotation (PDF spec §12.5.10). Highlights, underlines, squiggly-underlines, or strikes through text on the page. The affected regions are specified as a list of Quad values stored in the /QuadPoints entry.

Structs

Quad

A quadrilateral defined by four corner points in PDF user-space units. Used by text-markup annotations (/QuadPoints entry, spec §8.4.4). The points are ordered: P1 (bottom-left), P2 (bottom-right), P3 (top-left), P4 (top-right).

Enums

AnnotationFlags

Annotation flags (PDF spec §12.5.3, Table 170 — /F entry). Controls visibility, printing, and interaction behaviour.

BorderStyleType

Border style for annotations (PDF spec §12.5.4, /BS dictionary).

FileAttachmentIcon

Icon names for file-attachment annotations (spec §12.5.6.15, Table 175).

FreeTextIntent

Intent for free-text annotations (PDF spec §12.5.6.6, /IT entry). Controls the visual presentation of the free-text annotation.

HighlightMode

Highlight mode for link annotations (PDF spec §12.5.6.19, /H entry). Determines the visual effect when the user clicks or holds down inside the active area.

ReplyType

Reply type for markup annotations (PDF spec §12.5.6.2, /RT entry). Controls how an annotation in a reply thread relates to its parent.

StampIcon

Standard stamp annotation icons (PDF spec §12.5.12.4, Table 176 — /Name entry).

StickyNoteIcon

Sticky-note (text annotation) icon (PDF spec §12.5.6.4, Table 169 — /Name entry).

TextMarkupType

Text-markup annotation subtype (PDF spec §12.5.10, /Subtype entry).

Back to top

DR-IT Software documentation

DR-IT Software · Products · Documentation index · Product page · Downloads · Support · Licensing

Generated by DocFX