PdfCaretAnnotation Class

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

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

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

Properties

AnnotationType

Gets the Caret value.

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

The Caret value.

Overrides

Appearance

Gets the appearance settings for this PdfCaretAnnotation.

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

The appearance settings for this PdfCaretAnnotation.

BoundsPadding

(Optional; PDF 1.5) A set of four numbers that shall describe the numerical differences between two rectangles: the Bounds of the annotation and the actual boundaries of the underlying caret. Such a difference can occur when a paragraph symbol specified by Sy is displayed along with the caret..

The four numbers correspond to the differences in default user space between the left, top, right, and bottom coordinates of Bounds and those of the caret, respectively. Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be less than the height of Bounds, and the sum of the left and right differences shall be less than the width of Bounds.

public PdfPadding BoundsPadding { get; set; }
Public Property BoundsPadding As PdfPadding
Property Value
PdfPadding

A set of four numbers that shall describe the numerical differences between two rectangles: the Bounds of the annotation and the actual boundaries of the underlying caret.

Exceptions
System.ArgumentException

All BoundsPadding padding values must be greater than or equal to 0, the sum of the Left and Right values must be less than the Width of the Bounds, and the sum of the Bottom and Top values must be less than the Height of the Bounds.

See Also

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 PdfCaretAnnotation.

The following values shall be valid: Caret and CaretReplace.

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

A name describing the intent of the PdfCaretAnnotation.

Exceptions
System.ArgumentException

Value is not Caret or CaretReplace.

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