TextMarkupAnnotation Class Documentation

class TextMarkupAnnotation : Annotation

Namespace:Datalogics::PDFL

Inherits from:
Annotation
Derived classes:
HighlightAnnotation, UnderlineAnnotation

Detailed Description

Annotations that appears as highlighted content when added to a PDF file.

Text markup annotations appear as highlights, underlines, or strikeouts when added to a PDF document in a PDF Viewer. When the edited PDF file is opened the markups appear in a pop-up window containing the text of the associated note.

Referenced by

TextMarkupAnnotation

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]

Quads

System.Collections.Generic.IList< Quad > Quads[get, set]

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.

GetAnnotatedText

string GetAnnotatedText(bool splitLines)

Parameters

splitLines: bool

If true, text corresponding to each quadrilateral will be separated by CRLF characters. If false, text corresponding to each quadrilateral will be separated by spaces.

Returns:

string

The text marked by the annotation.

The text that is marked by the annotation. Marked text is defined as text which falls within one or more of the quadrilaterals specified by the annotation's QuadPoints entry. If the annotation marks partial words, only those portions of the word that are bounded within the QuadPoints array will be returned. If the annotation marks partial characters, the characters that fall partially within the annotation bounds may not be returned.

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.