Broadside.Annotations Namespace

Classes (40)

Pdf3DAnnotationA 3D annotation: 3D artwork on the page.

PdfAnnotationAn annotation: an object on a page, such as a note, a link or a form field's widget. A live view over the annotation dictionary.

PdfAnnotationBorderThe border of an annotation: its width, style, dash pattern and corner radii, from the border style dictionary (BS) when there is one, else from the Border array, else the default (solid, 1 point wide, square corners).

PdfAnnotationOptionsOptions for a new annotation: its colours, border, opacity, flags and the markup texts. The defaults draw a one-point border in the subtype's usual colour (yellow highlights and notes, red shapes, markups and stamps, a borderless free text in black 12-point Helvetica), printed, with no title or subject.

PdfAppearanceCharacteristicsAn appearance characteristics dictionary: what a processor needs to construct a widget's or screen's appearance. A live view over MK.

PdfAppearanceDictionaryAn annotation's appearance dictionary: its normal, rollover and down appearances. A live view over the AP dictionary.

PdfAppearanceEntryOne entry of an appearance dictionary: a single appearance stream, or a subdictionary of streams keyed by appearance state.

PdfBorderEffectA border effect: how the border of a square, circle, polygon or free text annotation is drawn (plain or cloudy).

PdfCaretAnnotationA caret annotation: a symbol marking where text is to be inserted.

PdfCircleAnnotationA circle annotation: an ellipse inscribed in the annotation rectangle (inset by RectangleDifferences).

PdfDeviceColorA colour given as an array of 0, 1, 3 or 4 numbers whose count selects the device colour space, as annotation entries such as C and IC and appearance characteristics such as BC and BG give it.

PdfFileAttachmentAnnotationA file attachment annotation: a file embedded in or referred to by the page, shown as an icon.

PdfFixedPrintA fixed print dictionary: how a watermark annotation is placed relative to the target media. A live view.

PdfFreeTextAnnotationA free text annotation: text displayed directly on the page, without a pop-up window.

PdfHighlightAnnotationA Highlight text markup annotation (PDF 1.3).

PdfInkAnnotationAn ink annotation: one or more freehand paths.

PdfLineAnnotationA line annotation: a single straight line, optionally a dimension line with leader lines and a caption.

PdfLinkAnnotationA link annotation: a hypertext link to a destination or an action.

PdfMarkupAnnotationA markup annotation: one that marks up the document and can carry an author, a pop-up window, replies and a review state.

PdfMovieAnnotationA movie annotation: a movie to be played. Deprecated in PDF 2.0.

PdfPolygonAnnotationA polygon annotation: a closed polygon.

PdfPolyLineAnnotationA polyline annotation: an open polygon.

PdfPopupAnnotationA pop-up annotation: the window that displays the text of its parent markup annotation.

PdfPrinterMarkAnnotationA printer's mark annotation: a production symbol such as a registration target, colour bar or cut mark.

PdfProjectionAnnotationA projection annotation: a markup annotation that projects, for example, a measurement onto 3D or geospatial content.

PdfRedactAnnotationA redaction annotation: content marked for removal, and how the removed region looks afterwards.

PdfRichMediaAnnotationA rich media annotation: video, audio or interactive content.

PdfScreenAnnotationA screen annotation: a region of the page where media clips may be played.

PdfSoundAnnotationA sound annotation: a sound recorded or attached at a point on the page. Deprecated in PDF 2.0.

PdfSquareAnnotationA square annotation: a rectangle inscribed in the annotation rectangle (inset by RectangleDifferences).

PdfSquigglyAnnotationA Squiggly text markup annotation (PDF 1.4).

PdfStampAnnotationA rubber stamp annotation: text or graphics that look as if stamped on the page.

PdfStrikeOutAnnotationA StrikeOut text markup annotation (PDF 1.3).

PdfTextAnnotationA text annotation: a sticky note attached to a point on the page, shown as an icon.

PdfTextMarkupAnnotationA text markup annotation: highlighted, underlined, squiggly-underlined or struck-out text.

PdfTrapNetAnnotationA trap network annotation: the trapping of a page. Deprecated in PDF 2.0.

PdfUnderlineAnnotationA Underline text markup annotation (PDF 1.3).

PdfUnknownAnnotationAn annotation of a type Table 171 does not list, or without a subtype: its common entries only.

PdfWatermarkAnnotationA watermark annotation: graphics printed at a fixed size and position relative to the media.

PdfWidgetAnnotationA widget annotation: the appearance of an interactive form field on a page.

Structs (2)

PdfQuadrilateralA quadrilateral of a QuadPoints array: four points in default user space, as the file gives them.

PdfRectangleDifferencesThe RD entry of a free text, square, circle or caret annotation: the distances from each edge of the annotation rectangle inward to the rectangle where the annotation is drawn.

Enums (13)

PdfAnnotationFlagsThe annotation flags, the bits of an annotation dictionary's F entry.

PdfAnnotationKindThe standard annotation types, the values of an annotation dictionary's Subtype entry.

PdfAppearanceModeWhich of an annotation's appearances to use: normal, rollover or down.

PdfBorderEffectStyleThe style of a border effect, the S entry of a border effect dictionary.

PdfBorderSourceWhere an annotation's border was read from.

PdfBorderStyleThe style of an annotation's border, the S entry of a border style dictionary.

PdfCaretSymbolThe symbol associated with a caret annotation, its Sy entry.

PdfDeviceColorSpaceThe device colour space of a PdfDeviceColor, selected by its number of components.

PdfHighlightModeThe visual effect when a link or widget annotation is activated, its H entry.

PdfLineCaptionPositionWhere the caption of a line annotation is drawn, its CP entry.

PdfLineEndingA line ending style, as the LE entry of line, polyline and free text annotations names it.

PdfReplyTypeThe relationship between a markup annotation and the one it is in reply to, its RT entry.

PdfTextJustificationThe justification of the text of a free text or redaction annotation, its Q entry.