PdfFigureAnnotation Class

Represents square or circle annotation

Inheritance Hierarchy

SystemObject
  Patagames.Pdf.Net.WrappersPdfWrapper
    Patagames.Pdf.Net.AnnotationsPdfAnnotation
      Patagames.Pdf.Net.AnnotationsPdfMarkupAnnotation
        Patagames.Pdf.Net.AnnotationsPdfFigureAnnotation
          Patagames.Pdf.Net.AnnotationsPdfCircleAnnotation
          Patagames.Pdf.Net.AnnotationsPdfSquareAnnotation

Namespace: Patagames.Pdf.Net.Annotations
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.94.2704

Syntax

C++

JavaScript

Copy

public abstract class PdfFigureAnnotation : PdfMarkupAnnotation

Public MustInherit Class PdfFigureAnnotation
	Inherits PdfMarkupAnnotation

public ref class PdfFigureAnnotation abstract : public PdfMarkupAnnotation

[<AbstractClassAttribute>]
type PdfFigureAnnotation = 
    class
        inherit PdfMarkupAnnotation
    end

public abstract class PdfFigureAnnotation extends PdfMarkupAnnotation

Patagames.Pdf.Net.Annotations.PdfFigureAnnotation = function();

Type.createClass(
	'Patagames.Pdf.Net.Annotations.PdfFigureAnnotation',
	Patagames.Pdf.Net.Annotations.PdfMarkupAnnotation);

The PdfFigureAnnotation type exposes the following members.

Constructors

	Name	Description
	PdfFigureAnnotation(PdfPage)	Creates a new PdfFigureAnnotation.
	PdfFigureAnnotation(PdfPage, PdfTypeBase)	Initializes a new instance of the PdfFigureAnnotation class based on the specified dictionary.

Top

Properties

	Name	Description
	BorderEffect	Gets or sets a PdfBorderEffect describing an effect applied to the border described by the BorderStyle property.
	BorderStyle	Gets or sets a border style (see PdfBorderStyle) specifying the line width and dash pattern to be used in drawing the rectangle or ellipse.
	InnerRectangle	Gets or sets an inner rectangle of the annotation.
	InteriorColor	Gets or sets the interior color with which to fill the annotation’s rectangle or ellipse.

Top

Methods

	Name	Description
	RegenerateAppearances	Re-creates the appearance of the annotation based on its properties (Overrides PdfMarkupAnnotationRegenerateAppearances)

Top

Remarks

Square and circle annotations (PDF 1.3) display, respectively, a rectangle or an ellipse on the page. When opened, they display a pop-up window containing the text of the associated note. The rectangle or ellipse is inscribed within the annotation rectangle defined by the Rectangle property. Figure 8.8 shows two annotations, each with a border width of 18 points.

Note
Despite the names square and circle, the width and height of the annotation rectangle need not be equal.

FIGURE 8.8 Square and circle annotations

Reference

Patagames.Pdf.Net.Annotations Namespace