Class Annotation

Namespace

UglyToad.PdfPig.Annotations

Assembly

UglyToad.PdfPig.dll

An annotation on a page in a PDF document.

public class Annotation

Inheritance

object

Annotation

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Annotation(DictionaryToken, AnnotationType, PdfRectangle, string, string, string, AnnotationFlags, AnnotationBorder, IReadOnlyList<QuadPointsQuadrilateral>, PdfAction, AppearanceStream, AppearanceStream, AppearanceStream, string, Annotation)

Create a new Annotation.

public Annotation(DictionaryToken annotationDictionary, AnnotationType type, PdfRectangle rectangle, string content, string name, string modifiedDate, AnnotationFlags flags, AnnotationBorder border, IReadOnlyList<QuadPointsQuadrilateral> quadPoints, PdfAction action, AppearanceStream normalAppearanceStream, AppearanceStream rollOverAppearanceStream, AppearanceStream downAppearanceStream, string appearanceState, Annotation inReplyTo)

Parameters

annotationDictionary DictionaryToken

type AnnotationType

rectangle PdfRectangle

content string

name string

modifiedDate string

flags AnnotationFlags

border AnnotationBorder

quadPoints IReadOnlyList<QuadPointsQuadrilateral>

action PdfAction

normalAppearanceStream AppearanceStream

rollOverAppearanceStream AppearanceStream

downAppearanceStream AppearanceStream

appearanceState string

inReplyTo Annotation

Properties

Action

Action for this annotation, if any (can be null)

public PdfAction Action { get; }

Property Value

PdfAction

AnnotationDictionary

The underlying PDF dictionary which this annotation was created from.

public DictionaryToken AnnotationDictionary { get; }

Property Value

DictionaryToken

Border

Defines the annotation's border.

public AnnotationBorder Border { get; }

Property Value

AnnotationBorder

Content

The annotation text, or if the annotation does not display text, a description of the annotation's contents. Optional.

public string Content { get; }

Property Value

string

Flags

Flags defining the appearance and behaviour of this annotation.

public AnnotationFlags Flags { get; }

Property Value

AnnotationFlags

HasDownAppearance

Indicates if a down appearance is present for this annotation (shown when you click on this annotation)

public bool HasDownAppearance { get; }

Property Value

bool

HasNormalAppearance

Indicates if a normal appearance is present for this annotation

public bool HasNormalAppearance { get; }

Property Value

bool

HasRollOverAppearance

Indicates if a roll over appearance is present for this annotation (shown when you hover over this annotation)

public bool HasRollOverAppearance { get; }

Property Value

bool

InReplyTo

The Annotation this annotation was in reply to. Can be null

public Annotation InReplyTo { get; }

Property Value

Annotation

ModifiedDate

The date and time the annotation was last modified, can be in any format. Optional.

public string ModifiedDate { get; }

Property Value

string

Name

The name of this annotation which should be unique per page. Optional.

public string Name { get; }

Property Value

string

QuadPoints

Rectangles defined using QuadPoints, for Link these are the regions used to activate the link, for text markup annotations these are the text regions to apply the markup to. See Points for more information regarding the order of the points.

public IReadOnlyList<QuadPointsQuadrilateral> QuadPoints { get; }

Property Value

IReadOnlyList<QuadPointsQuadrilateral>

Rectangle

The rectangle in user space units specifying the location to place this annotation on the page.

public PdfRectangle Rectangle { get; }

Property Value

PdfRectangle

Type

The type of this annotation.

public AnnotationType Type { get; }

Property Value

AnnotationType

Methods

ToString()

public override string ToString()

Returns

string