PdfSquareCircleAnnotation Class

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

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

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

Properties

AnnotationType

Gets the Square or Circle value.

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

The Square or Circle value.

Overrides

Appearance

Gets the appearance settings for this PdfSquareCircleAnnotation.

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

The appearance settings for this PdfSquareCircleAnnotation.

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 square or circle. Such a difference may occur in situations where a border effect causes the size of the Bounds to increase beyond that of the square or circle.

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 square or circle, 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 square or circle.

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

Description

Gets or sets the description.

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

The description.

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)

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.

(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