PdfMarkupAnnotation Class

Namespace:
GemBox.Pdf.Annotations
Assembly:
GemBox.Pdf.dll

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.

public abstract class PdfMarkupAnnotation : PdfAnnotation
Public MustInherit Class PdfMarkupAnnotation
    Inherits PdfAnnotation
Inheritance:
System.Object
PdfMarkupAnnotation
Derived
PdfCaretAnnotation
PdfFileAttachmentAnnotation
PdfFreeTextAnnotation
PdfPencilMarkAnnotation
PdfRedactionAnnotation
PdfSquareCircleAnnotation
PdfStampAnnotation
PdfStickyNoteAnnotation
PdfTextMarkupAnnotation

Properties

Author

(Optional; PDF 1.1) The text label that shall be displayed in the title bar of the annotation's pop-up window when open and active. This entry shall identify the user who added the annotation.

public string Author { get; set; }
Public Property Author As String
Property Value
System.String

The text label that shall be displayed in the title bar of the annotation's pop-up window when open and active.

See Also

InReplyTo

(Required if a ReplyType entry is present, otherwise optional; PDF 1.5) A reference to the PdfMarkupAnnotation that this PdfMarkupAnnotation is "in reply to". Both PdfMarkupAnnotations shall be on the same page of the document. The relationship between the two PdfMarkupAnnotations shall be specified by the ReplyType entry.

public PdfMarkupAnnotation InReplyTo { get; set; }
Public Property InReplyTo As PdfMarkupAnnotation
Property Value
PdfMarkupAnnotation

A reference to the PdfMarkupAnnotation that this PdfMarkupAnnotation is "in reply to".

Exceptions
System.ArgumentException

The PdfMarkupAnnotation is not on the same page of the document as this PdfMarkupAnnotation.

See Also

Intent

(Optional; PDF 1.6) A name describing the intent of the markup annotation. Intents allow conforming readers to distinguish between different uses and behaviors of a single markup annotation type.

PdfFreeTextAnnotations (Table 174), line annotations (Table 175), polygon annotations (Table 178), and (PDF 1.7) polyline annotations (Table 178) have defined intents.

public PdfMarkupAnnotationIntent Intent { get; }
Public ReadOnly Property Intent As PdfMarkupAnnotationIntent
Property Value
PdfMarkupAnnotationIntent

A name describing the intent of the markup annotation.

See Also

ReplyType

(Optional; meaningful only if InReplyTo is present; PDF 1.6) A name specifying the relationship (the "reply type") between this PdfMarkupAnnotation and the one specified by the InReplyTo property.

Default value: Reply.

public PdfReplyType ReplyType { get; set; }
Public Property ReplyType As PdfReplyType
Property Value
PdfReplyType

A name specifying the relationship (the "reply type") between this PdfMarkupAnnotation and the one specified by the InReplyTo property.

See Also

Subject

(Optional; PDF 1.5) Text representing a short description of the subject being addressed by the annotation.

public string Subject { get; set; }
Public Property Subject As String
Property Value
System.String

Text representing a short description of the subject being addressed by the annotation.

See Also

Inherited Properties

AnnotationType

Gets the type of the annotation.

(Inherited from PdfAnnotation)

Appearance

Gets the appearance settings for this PdfAnnotation.

(Inherited from PdfAnnotation)

AssociatedFiles

(Optional; PDF 2.0) An array of one or more PdfFileSpecifications which denote the associated files for this PdfAnnotation.

(Inherited from PdfAnnotation)

Bounds

(Required) The annotation bounds, defining the location and the size of the annotation on the page in default user space units.

(Inherited from PdfAnnotation)

Locked

(PDF 1.4) If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.

(Inherited from PdfAnnotation)

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Page

Gets the page with which this annotation is associated.

(Inherited from PdfAnnotation)

Inherited Methods

SetBounds(System.Double, System.Double)

Sets the size of the Bounds.

(Inherited from PdfAnnotation)

SetBounds(System.Double, System.Double, System.Double, System.Double)

Sets the Bounds.

(Inherited from PdfAnnotation)

Extension Methods

See Also