GemBox.Pdf
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    GemBox.Pdf.Annotations Namespace

    Contains classes, structures, and enumerations that implement PDF annotations that associate an object, such as a note, sound, or movie, with a location on a page of a PDF document, or provide a way to interact with the user by means of the mouse and keyboard as specified in the PDF Specification ISO 32000-1:2008, section '12.5 Annotations'. The base class of all PDF annotations is PdfAnnotation which can be accessed via the Annotations property of the PdfPage class.

    The PDF annotation appearance is represented by the PdfAppearance class which can be accessed via the Appearance property of the PdfAnnotation class.

    Classes

    PdfAnnotation

    An annotation associates an object such as a note, link or rich media with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

    PdfAnnotationCollection

    Represents a collection of PdfAnnotations.

    PdfAppearance

    Represents an appearance settings for a PdfAnnotation.

    PdfCaretAnnotation

    A caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.

    PdfCaretAppearance

    Represents an appearance settings for a PdfCaretAnnotation.

    PdfFileAttachmentAnnotation

    A file attachment annotation (PDF 1.3) contains a reference to a file, which typically shall be embedded in the PDF file (see 7.11.4, "Embedded File Streams").

    PdfFileAttachmentAppearance

    Represents an appearance settings for a PdfFileAttachmentAnnotation.

    PdfFreeTextAnnotation

    A free text annotation (PDF 1.3) displays text directly on the page. Unlike an ordinary PdfStickyNoteAnnotation, a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text shall be always visible.

    PdfFreeTextAppearance

    Represents an appearance settings for a PdfFreeTextAnnotation.

    PdfLinkAnnotation

    A link annotation represents either a hypertext link to a destination elsewhere in the document (see 12.3.2, "Destinations") or an action to be performed (12.6, "Actions").

    PdfLinkAppearance

    Represents an appearance settings for a PdfLinkAnnotation.

    PdfMarkupAnnotation

    Represents a base class for markup annotations that used primarily to mark up PDF documents. These annotations have text that appears as part of the annotation and may be displayed in other ways by a conforming reader, such as in a Comments pane.

    PdfPencilMarkAnnotation

    An ink annotation (PDF 1.3) represents a freehand "scribble" composed of one or more disjoint paths.

    PdfPencilMarkAppearance

    Represents an appearance settings for a PdfPencilMarkAnnotation.

    PdfRedactionAnnotation

    A redaction annotation (PDF 1.7) identifies content that is intended to be removed from the document. The intent of redaction annotations is to enable the following process:

    1. Content identification. A user applies redact annotations that specify the pieces or regions of content that should be removed. Up until the next step is performed, the user can see, move and redefine these annotations.
    2. Content removal. The user instructs the viewer application to apply the redact annotations, after which the content in the area specified by the redact annotations is removed. In the removed content’s place, some marking appears to indicate the area has been redacted. Also, the redact annotations are removed from the PDF document.
    PdfRedactionAppearance

    Represents an appearance settings for a PdfRedactionAnnotation.

    PdfSquareCircleAnnotation

    Square and circle annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page. When opened, they shall display a pop-up window containing the text of the associated note. The rectangle or ellipse shall be inscribed within the annotation rectangle defined by the annotation Bounds (see (see Table 168).

    PdfSquareCircleAppearance

    Represents an appearance settings for a PdfSquareCircleAnnotation.

    PdfStampAnnotation

    A rubber stamp annotation (PDF 1.3) displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. When opened, it shall display a pop-up window containing the text of the associated note.

    PdfStampAppearance

    Represents an appearance settings for a PdfStampAnnotation.

    PdfStickyNoteAnnotation

    A text annotation represents a "sticky note" attached to a point in the PDF document. When closed, the annotation shall appear as an icon; when open, it shall display a pop-up window containing the text of the note in a font and size chosen by the conforming reader.

    PdfStickyNoteAppearance

    Represents an appearance settings for a PdfStickyNoteAnnotation.

    PdfTextMarkupAnnotation

    Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document. When opened, they shall display a pop-up window containing the text of the associated note.

    PdfTextMarkupAppearance

    Represents an appearance settings for a PdfTextMarkupAnnotation.

    Structs

    PdfAppearanceState

    Represents an annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary (see Section 12.5.5, "Appearance Streams").

    Enums

    PdfAnnotationType

    Represents types of the PdfAnnotations.

    PdfAppearanceTrigger

    Represents an event that triggers the showing of a particular PdfAppearance.

    PdfBorderStyle

    Represents the style of the annotation's border.

    PdfFileAttachmentIcon

    The file attachment icon that shall be used in displaying the PdfFileAttachmentAnnotation.

    PdfHighlightMode

    The annotation's highlighting mode, the visual effect that shall be used when the mouse button is pressed or held down inside its active area.

    PdfMarkupAnnotationIntent

    An enumeration describing the intent of the PdfMarkupAnnotation.

    Intents allow conforming readers to distinguish between different uses and behaviors of a single markup annotation type.

    PdfReplyType

    An enumeration specifying the relationship (the "reply type") between the PdfMarkupAnnotation and the one specified by its InReplyTo property.

    PdfScaleCondition

    Represents a condition under which the content shall be scaled inside the available size.

    PdfStampIcon

    The stamp icon that shall be used in displaying the PdfStampAnnotation.

    PdfStickyNoteIcon

    The sticky note icon that shall be used in displaying the PdfStickyNoteAnnotation.

    PdfTextPlacement

    Represents a placement of the annotation appearance text relative to its icon.

    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.