PdfTextMarkupAnnotation Class

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

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.

public sealed class PdfTextMarkupAnnotation : PdfMarkupAnnotation
Public NotInheritable Class PdfTextMarkupAnnotation
    Inherits PdfMarkupAnnotation
Inheritance:
System.Object
PdfTextMarkupAnnotation

Properties

AnnotationType

Gets the Highlight, Underline, Squiggly, or StrikeOut value.

public override PdfAnnotationType AnnotationType { get; }
Public Overrides ReadOnly Property AnnotationType As PdfAnnotationType
Property Value
PdfAnnotationType
Overrides

Appearance

Gets the appearance settings for this PdfTextMarkupAnnotation.

public PdfTextMarkupAppearance Appearance { get; }
Public ReadOnly Property Appearance As PdfTextMarkupAppearance
Property Value
PdfTextMarkupAppearance

The appearance settings for this PdfTextMarkupAnnotation.

Content

(Optional) Text that shall be displayed for the annotation.

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

Text that shall be displayed for the annotation.

See Also

Intent

>A name that shall describe the intent of the PdfTextMarkupAnnotation.

The following values shall be valid: Underline.

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

A name describing the intent of the PdfTextMarkupAnnotation.

Exceptions
System.ArgumentException

Value is not Underline when the AnnotationType is Underline or Squiggly, or value another PdfMarkupAnnotationIntent.

See Also

Quads

(Required) An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space encompassing a word or group of contiguous words in the text underlying the annotation.

public PdfCollection<PdfQuad> Quads { get; }
Public ReadOnly Property Quads As PdfCollection(Of PdfQuad)
Property Value
PdfCollection<PdfQuad>

An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space encompassing a word or group of contiguous words in the text underlying the annotation.

See Also

Inherited Properties

AssociatedFiles

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

(Inherited from PdfAnnotation)

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.

(Inherited from PdfMarkupAnnotation)

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)

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.

(Inherited from PdfMarkupAnnotation)

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)

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.

(Inherited from PdfMarkupAnnotation)

Subject

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

(Inherited from PdfMarkupAnnotation)

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