LineAnnotation Class Documentation

classLineAnnotation : Annotation

Namespace:Datalogics::PDFL

Inherits from:
Annotation

Detailed Description

The line annotation displays a single straight line on a PDF page.

When opened it displays a pop-up window containing the text of an associated note, placed at specific x/y coordinates for starting and ending points of the line.

Referenced by

LineAnnotation

Constructor & Destructor Documentation

LineAnnotation

LineAnnotation(LineAnnotationrhs, InternalConstructsignifier)

Parameters

rhs: LineAnnotation
signifier: InternalConstruct

LineAnnotation

LineAnnotation(Pagepage, RectinitialRect, PointstartPoint, PointendPoint)

Parameters

page: Page

The page to which the LineAnnotation is added.

initialRect: Rect

A rectangle specifying the annotation's bounds, specified in user space coordinates.

startPoint: Point

The starting coordinate of the line, in user space.

endPoint: Point

The ending coordinate of the line, in user space.

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

LineAnnotation

LineAnnotation(Pagepage, RectinitialRect, PointstartPoint, PointendPoint, 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.

startPoint: Point

The starting coordinate of the line, in user space.

endPoint: Point

The ending coordinate of the line, in user space.

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 LineAnnotation at a specific index in the page's annotation array.

Property Documentation

AnnotationFeatureLevel

doubleAnnotationFeatureLevel[get, set]

BorderStyle

stringBorderStyle[get, set]

BorderStyleDashPattern

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

BorderStyleWidth

doubleBorderStyleWidth[get, set]

Color

ColorColor[get, set]

Contents

stringContents[get, set]

EndPoint

PointEndPoint[get, set]

EndPointEndingStyle

LineEndingStyleEndPointEndingStyle[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]

Rect

RectRect[get, set]

StartPoint

PointStartPoint[get, set]

StartPointEndingStyle

LineEndingStyleStartPointEndingStyle[get, set]

Subtype

stringSubtype[get]

Title

stringTitle[get, set]

Member Function Documentation

ConstructorRetrieve

static new static LineAnnotationConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static LineAnnotation

Dispose

voidDispose()

Returns:

void

DisposeChildren

voidDisposeChildren()

Returns:

void

Equals

override boolEquals(objectobj)

Parameters

obj: object

Returns:

override bool

GenerateAppearance

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.

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