Annotation Class

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

Page

Uses types

AnnotationFlags Color Form OptionalContentContext OptionalContentMembershipDict PDFDict Page Rect

Constructor & Destructor Documentation

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(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

double AnnotationFeatureLevel[get, set]

The minimum PDF version necessary to support the features used in this annotation.

Color Color[get, set]

The color of the annotation.

string Contents[get, set]

The text contents of the annotation.

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.

AnnotationFlags Flags[get, set]

The flags for the annotation.

Color InteriorColor[get, set]

The interior color with which to fill the annotation's rectangle or circle.

The color of the border itself can be retrieved from Annotation.Color.

Form NormalAppearance[get, set]

The normal appearance of the annotation, represented as a Form XObject.

double Opacity[get, set]

The constant opacity value used in painting a Markup annotation.

Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

OptionalContentMembershipDict OptionalContentMembershipDict[get, set]

The OptionalContentMembershipDict property for this Annotation.

Setting this property will attach the Annotation to an OptionalContentMembershipDict; it will then be associated with the OptionalContentGroups and be subject to the VisibilityPolicy and VisibilityExpression of that MembershipDict.

By setting this property to null, the Annotation is detached from any OptionalContentMembershipDict.

PDFDict PDFDict[get]

The underlying PDF dictionary for this annotation.

Retrieves the PDFDict representation of this annotation object.

Rect Rect[get, set]

The size and location of the annotation on its page.

string Subtype[get]

The annotation's subtype.

string Title[get, set]

The title of the annotation.

Member Function Documentation

void Dispose()

Returns:

void

override bool Equals(object obj)

Parameters

obj: object

Returns:

override bool

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.

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.

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.

override string ToString()

Returns:

override string

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

Returns a string representation of this annotation.