HighlightAnnotation Class

classHighlightAnnotation : TextMarkupAnnotation

Namespace:Datalogics::PDFL

Inherits from:: TextMarkupAnnotation

Detailed Description

Allows the user to highlight text appearing on a PDF page.

The annotated text is still readable on the PDF, but highlighted in yellow.

Referenced by

HighlightAnnotation

Uses types

Annotation AnnotationFlags Color Form HighlightAnnotation OptionalContentContext OptionalContentMembershipDict PDFDict Page Quad Rect

Constructor & Destructor Documentation

HighlightAnnotation(HighlightAnnotationrhs, InternalConstructsignifier)

Parameters

rhs: HighlightAnnotation
signifier: InternalConstruct

HighlightAnnotation(Pagepage, intaddAfter, System.Collections.Generic.IList< Quad >quadList)

Parameters

page: Page: The page to which the HighlightAnnotation is added.
addAfter: int: Where to add the annotation in the page's annotation array.
quadList: System.Collections.Generic.IList< Quad >: A list of quads to highlight. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.

Create a new HighlightAnnotation at a specific index 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.

HighlightAnnotation(Pagepage, System.Collections.Generic.IList< Quad >quadList)

Parameters

page: Page: The page to which the HighlightAnnotation is added.
quadList: System.Collections.Generic.IList< Quad >: A list of quads to highlight. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.

Create a new HighlightAnnotation 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.

Property Documentation

doubleAnnotationFeatureLevel[get, set]

ColorColor[get, set]

stringContents[get, set]

AnnotationFlagsFlags[get, set]

ColorInteriorColor[get, set]

FormNormalAppearance[get, set]

doubleOpacity[get, set]

OptionalContentMembershipDictOptionalContentMembershipDict[get, set]

PDFDictPDFDict[get]

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

RectRect[get, set]

stringSubtype[get]

stringTitle[get, set]

Member Function Documentation

static new static HighlightAnnotationConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static HighlightAnnotation

voidDispose()

Returns:

void

voidDisposeChildren()

Returns:

void

override boolEquals(objectobj)

Parameters

obj: object

Returns:

override bool

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.

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.

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.

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.

boolSameTypeEquals(Annotationarg0)

Parameters

arg0: Annotation

Returns:

bool

override stringToString()

Returns:

override string