PdfAnnotation Class

An annotation associates an object such as a note, link or rich media with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

Inheritance Hierarchy

SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.Pdf.AnnotationsPdfAnnotation
      SautinSoft.Pdf.AnnotationsPdfLinkAnnotation
      SautinSoft.Pdf.AnnotationsPdfMarkupAnnotation
      SautinSoft.Pdf.FormsPdfField

Namespace: SautinSoft.Pdf.Annotations
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.8.8

Syntax

Copy

public abstract class PdfAnnotation : PdfObject

Public MustInherit Class PdfAnnotation
	Inherits PdfObject

The PdfAnnotation type exposes the following members.

Properties

	Name	Description
	AnnotationType	Gets the type of the annotation.
	Appearance	Gets the appearance settings for this PdfAnnotation.
	AssociatedFiles	(Optional; PDF 2.0) An array of one or more PdfFileSpecifications which denote the associated files for this PdfAnnotation.
	Bounds	(Required) The annotation bounds, defining the location and the size of the annotation on the page in default user space units.
	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.
	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.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	SetBounds(Double, Double)	Sets the size of the Bounds.
	SetBounds(Double, Double, Double, Double)	Sets the Bounds.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetArray	Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)
	GetDictionary	Gets the PdfDictionary that serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)
	GetOrAddDictionary	Gets the PdfDictionary that serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)

Top

Reference

SautinSoft.Pdf.Annotations Namespace

PDF Specification ISO 32000-1:2008, section '12.5.6 Annotation Types'