PdfAnnotation Class

Abstract class representing entries that are common to all annotations.

Inheritance Hierarchy

SystemObject
  Patagames.Pdf.Net.WrappersPdfWrapper
    Patagames.Pdf.Net.AnnotationsPdfAnnotation
      More...

Namespace: Patagames.Pdf.Net.Annotations
Assemblies: Patagames.Pdf.Xamarin.iOS (in Patagames.Pdf.Xamarin.iOS.dll) Version: 4.55.2704
Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.55.2704

Syntax

C++

JavaScript

Copy

public abstract class PdfAnnotation : PdfWrapper

Public MustInherit Class PdfAnnotation
	Inherits PdfWrapper

public ref class PdfAnnotation abstract : public PdfWrapper

[<AbstractClassAttribute>]
type PdfAnnotation =  
    class
        inherit PdfWrapper
    end

public abstract class PdfAnnotation extends PdfWrapper

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

Type.createClass(
	'Patagames.Pdf.Net.Annotations.PdfAnnotation',
	Patagames.Pdf.Net.Wrappers.PdfWrapper);

The PdfAnnotation type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Color	Gets or sets the color of annotation.Please see remarks section for more details
	Contents	Gets or sets the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.
	DownAppearance	The annotation’s down appearance.
	Flags	Gets or sets a set of flags specifying various characteristics of the annotation AnnotationFlags.
	ListOfIndirectObjects	Gets list of indirect objects
	ModificationDate	Gets or sets the date and time when the annotation was most recently modified. The preferred format is a date string as described in remarks, but viewer applications should be prepared to accept and display a string in any format.
	Name	Gets or sets the annotation name, a text string uniquely identifying it among all the annotations on its page.
	NormalAppearance	The annotation’s normal appearance.
	Page	Gets PDF page associated with this annotation.
	Rectangle	Gets or sets the annotation rectangle, defining the location of the annotation on the page in default user space units.
	RolloverAppearance	The annotation’s rollover appearance.

Top

Methods

	Name	Description
	Create	Creates a new annotation based on its type in the specified dictionary.
	CreateEmptyAppearance	Creates empty appearance stream
	Dispose	Releases the unmanaged resources used by the Annotation class and optionally releases the managed resources. (Overrides PdfWrapperDispose(Boolean).)
	GenerateAppearance	Generate content of specified appearance stream.

Top

Remarks

The annotation may contain additional entries specific to a particular annotation type; see the descriptions of individual annotation type.

Note
A annotation may be referenced from the PdfAnnotationCollection that assigned with one page only. Attempting to share an annotation among multiple pages produces unpredictable behavior.This requirement applies only to the annotation itself, not to subsidiary objects, which can be shared among multiple annotations without causing any difficulty

Reference

Patagames.Pdf.Net.Annotations Namespace

Inheritance Hierarchy