TextMarkupAnnotation Class Documentation

classTextMarkupAnnotation : 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

Constructor & Destructor Documentation

Property Documentation

AnnotationFeatureLevel

doubleAnnotationFeatureLevel[get, set]

Color

ColorColor[get, set]

Contents

stringContents[get, set]

Flags

AnnotationFlagsFlags[get, set]

InteriorColor

ColorInteriorColor[get, set]

NormalAppearance

FormNormalAppearance[get, set]

Opacity

doubleOpacity[get, set]

OptionalContentMembershipDict

OptionalContentMembershipDictOptionalContentMembershipDict[get, set]

PDFDict

PDFDictPDFDict[get]

Quads

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

Rect

RectRect[get, set]

Subtype

stringSubtype[get]

Title

stringTitle[get, set]

Member Function Documentation

ConstructorRetrieve

static new static TextMarkupAnnotationConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static TextMarkupAnnotation

Dispose

voidDispose()

Returns:

void

DisposeChildren

voidDisposeChildren()

Returns:

void

Equals

override boolEquals(objectobj)

Parameters

obj: object

Returns:

override bool

GenerateAppearance

FormGenerateAppearance()

Returns:

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.

GetAnnotatedText

stringGetAnnotatedText(boolsplitLines)

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:

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

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