Annotation Class Documentation

class Annotation : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable
Derived classes:
CircleAnnotation, FreeTextAnnotation, InkAnnotation, LineAnnotation, LinkAnnotation, PolyLineAnnotation, PolygonAnnotation, Redaction, SquareAnnotation, TextMarkupAnnotation

Detailed Description

Associates an object with its location on a page of a PDF document.

An annotation associates an object such as a note, sound, or movie 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.

Referenced by

AnnotationCircleAnnotationFreeTextAnnotationHighlightAnnotationInkAnnotationLineAnnotationLinkAnnotationPagePolyLineAnnotationPolygonAnnotationRedactionSquareAnnotationTextMarkupAnnotationUnderlineAnnotation

Constructor & Destructor Documentation

Annotation

Annotation(Page page, string subtype, Rect initialRect)

Parameters

page: Page

The page to which the annotation is added.

subtype: string

The type of the annotation.

initialRect: Rect

A rectangle specifying the annotation's bounds, specified in user space coordinates.

Create a new Annotation at the end of a page's annotation array. To create an annotation and place it elsewhere in the page's annotation array, use the version of the constructor that takes an array position.

Annotation

Annotation(Page page, string subtype, Rect initialRect, int addAfter)

Parameters

page: Page

The page to which the annotation is added.

subtype: string

The type of the annotation.

initialRect: Rect

A rectangle specifying the annotation's bounds, specified in user space coordinates.

addAfter: int

Where to add the annotation in the page's annotation array.

Create a new Annotation at a specific index in the page's annotation array.

Property Documentation

AnnotationFeatureLevel

double AnnotationFeatureLevel[get, set]

Color

Color Color[get, set]

Contents

string Contents[get, set]

Flags

AnnotationFlags Flags[get, set]

InteriorColor

Color InteriorColor[get, set]

NormalAppearance

Form NormalAppearance[get, set]

Opacity

double Opacity[get, set]

OptionalContentMembershipDict

OptionalContentMembershipDict OptionalContentMembershipDict[get, set]

PDFDict

PDFDict PDFDict[get]

Rect

Rect Rect[get, set]

Subtype

string Subtype[get]

Title

string Title[get, set]

Member Function Documentation

Dispose

void Dispose()

Returns:

void

Equals

override bool Equals(object obj)

Parameters

obj: object

Returns:

override bool

GenerateAppearance

Form GenerateAppearance()

Returns:

Form

A Form representing the visual appearance, or null if the appearance could not be generated.

Generate a new appearance stream with the current annotation properties.

The resulting Form can then be used to set the annotation's appearance, such as by calling SetNormalAppearance.

HasRichTextData

bool HasRichTextData()

Returns:

bool

true if the annotation contains Rich Text String content.

Checks the annotation for Rich Text String content (PDFReference 1.7 Section 8.6.2). Annotations that contain Rich Text String content and do not have a normal appearance set will not be visible when rendering the page.

IsCurrentlyVisible

bool IsCurrentlyVisible(OptionalContentContext occ)

Parameters

occ: OptionalContentContext

The optional content context in which to check visibility.

Returns:

bool

true if the annotation is currently visible.

Tests whether an annotation is visible in a given optional content context, considering the current ON-OFF states of the optional-content groups in the optional-content dictionary (OCMD) and the dictionary's visibility policy.

If the annotation occurs more than once within the content, this method only checks the visibility of the first occurrence of the annotation.

This method determines visibility without considering the visbility of the Content object that the annotation belongs to. To determine the visibility of an annotation while taking the Content's visibility into consideration, use the alternate version of this method.

ToString

override string ToString()

Returns:

override string

A string describing this annotation, including its type and rectangle.

Returns a string representation of this annotation.