FreeTextAnnotation Class

class FreeTextAnnotation : 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.

Uses types

AnnotationFlags Color Form HorizontalAlignment OptionalContentContext OptionalContentMembershipDict PDFDict Page Rect

Constructor & Destructor Documentation

FreeTextAnnotation(Page page, Rect initialRect, string defaultAppearance)

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(Page page, Rect initialRect, string defaultAppearance, int addAfter)

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

double AnnotationFeatureLevel[get, set]

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

string BorderStyle[get, set]

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

double BorderStyleWidth[get, set]

Color Color[get, set]

(Deprecated, function may be removed in future, use GetInteriorColor instead) The color of the annotation. This method the same to the GetInteriorColor method.

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.

string DefaultAppearance[get, set]

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

AnnotationFlags Flags[get, set]

The flags for the annotation.

string FontFace[get, set]

Get Font face for the text

double FontSize[get, set]

Get font size for the text;

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.

HorizontalAlignment Quadding[get, set]

A code specifiying the form of quadding (justification) to be used in displaying the annotation's text.

Rect Rect[get, set]

The size and location of the annotation on its page.

string Subtype[get]

The annotation's subtype.

Color TextColor[get, set]

The text color which used for drawing text

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

override Form GenerateAppearance()

Returns:

override Form

A new Form containing the generated appearance, or null if the appearance could not be generated (for example, due to an invalid border style).

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.