FreeTextAnnotation Class Documentation

classFreeTextAnnotation : Annotation

Namespace:Datalogics::PDFL

Inherits from:
Annotation

Detailed Description

The free text annotation allows a user to place text directly on a PDF page.

An ordinary text annotation appears in a pop up window, and is attached to an icon; it represents a note added to a PDF file, and can be opened for viewing, or closed. But a free text annotation always appears open on the page. A free text annotation can be included anywhere in a PDF file by specifying the location and the CallOutLine points.

Referenced by

FreeTextAnnotation

Constructor & Destructor Documentation

FreeTextAnnotation

FreeTextAnnotation(Pagepage, RectinitialRect, stringdefaultAppearance)

Parameters

page: Page

The page to which the FreeTextAnnotation is added.

initialRect: Rect

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

defaultAppearance: string

The default appearance string to be used in formatting the text.

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

FreeTextAnnotation

FreeTextAnnotation(Pagepage, RectinitialRect, stringdefaultAppearance, intaddAfter)

Parameters

page: Page

The page to which the annotation is added.

initialRect: Rect

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

defaultAppearance: string

The default appearance string to be used in formatting the text.

addAfter: int

Where to add the annotation in the page's annotation array. To add the annotation to the end of the array, pass a value of -2 or use the alternate version of this constructor that does not take an index (this is generally what you should do unless you have a need to place the annotation at a special location in the array). Passing a value of -1 adds the annotation to the beginning of the array. Passing other negative values produces undefined results.

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

Property Documentation

AnnotationFeatureLevel

doubleAnnotationFeatureLevel[get, set]

BorderStyle

stringBorderStyle[get, set]

BorderStyleDashPattern

System.Collections.Generic.IList< System.Double >BorderStyleDashPattern[get, set]

BorderStyleWidth

doubleBorderStyleWidth[get, set]

Color

ColorColor[get, set]

Contents

stringContents[get, set]

DefaultAppearance

stringDefaultAppearance[get, set]

Flags

AnnotationFlagsFlags[get, set]

FontFace

stringFontFace[get, set]

FontSize

doubleFontSize[get, set]

InteriorColor

ColorInteriorColor[get, set]

NormalAppearance

FormNormalAppearance[get, set]

Opacity

doubleOpacity[get, set]

OptionalContentMembershipDict

OptionalContentMembershipDictOptionalContentMembershipDict[get, set]

PDFDict

PDFDictPDFDict[get]

Quadding

HorizontalAlignmentQuadding[get, set]

Rect

RectRect[get, set]

Subtype

stringSubtype[get]

TextColor

ColorTextColor[get, set]

Title

stringTitle[get, set]

Member Function Documentation

ConstructorRetrieve

static new static FreeTextAnnotationConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static FreeTextAnnotation

Dispose

voidDispose()

Returns:

void

DisposeChildren

voidDisposeChildren()

Returns:

void

Equals

override boolEquals(objectobj)

Parameters

obj: object

Returns:

override bool

GenerateAppearance

override FormGenerateAppearance()

Returns:

override Form

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

boolHasRichTextData()

Returns:

bool

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

boolIsCurrentlyVisible(OptionalContentContextocc)

Parameters

occ: OptionalContentContext

Returns:

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

Returns:

override string