InkAnnotation Class

classInkAnnotation : Annotation

Namespace:Datalogics::PDFL

Inherits from:: Annotation

Detailed Description

A type of annotation allowing a user to edit a PDF document.

Ink annotations in a PDF file allow a user to work with a PDF document displayed on a screen just as if it were on paper, such as scribbling notes in the margins, or circling or underlining text. These types of annotations require a stylus or pen used on a tablet device.

Referenced by

InkAnnotation

Uses types

Annotation AnnotationFlags Color Form InkAnnotation OptionalContentContext OptionalContentMembershipDict PDFDict Page Point Rect

Constructor & Destructor Documentation

InkAnnotation(InkAnnotationrhs, InternalConstructsignifier)

Parameters

rhs: InkAnnotation
signifier: InternalConstruct

InkAnnotation(Pagepage, RectinitialRect)

Parameters

page: Page: The page to which the InkAnnotation is added.
initialRect: Rect: A rectangle specifying the annotation's bounds, specified in user space coordinates.

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

InkAnnotation(Pagepage, RectinitialRect, 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.
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 InkAnnotation at a specific index in the page's annotation array.

Property Documentation

doubleAnnotationFeatureLevel[get, set]

stringBorderStyle[get, set]

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

doubleBorderStyleWidth[get, set]

ColorColor[get, set]

stringContents[get, set]

AnnotationFlagsFlags[get, set]

ColorInteriorColor[get, set]

FormNormalAppearance[get, set]

intNumScribbles[get]

doubleOpacity[get, set]

OptionalContentMembershipDictOptionalContentMembershipDict[get, set]

PDFDictPDFDict[get]

RectRect[get, set]

stringSubtype[get]

stringTitle[get, set]

Member Function Documentation

voidAddScribble(System.Collections.Generic.IList< Point >scribble)

Parameters

scribble: System.Collections.Generic.IList< Point >: The array of points, in order, that define the vertices of the scribble in user space coordinates, to add to the ink annotation.

Returns:

void

The vertices that define one of many scribbles in an ink annotation, in user space.

static new static InkAnnotationConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static InkAnnotation

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.

System.Collections.Generic.IList< Point >GetScribble(intindex)

Parameters

index: int: The index of the scribble to get.

Returns:

An array of points, in order, that define the indexed scribble of the ink annotation, in user space coordinates.

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.

voidRemoveScribble(intindex)

Parameters

index: int: The array of points, in order, that define the vertices of the scribble in user space coordinates, to remove from the ink annotation.

Returns:

void

The vertices that define one of many scribbles in an ink annotation, in user space.

boolSameTypeEquals(Annotationarg0)

Parameters

arg0: Annotation

Returns:

bool

override stringToString()

Returns:

override string