SquareAnnotation Class Documentation

classSquareAnnotation : Annotation

Namespace:Datalogics::PDFL

Inherits from:
Annotation

Detailed Description

The square annotation allows a user to display a rectangle on a PDF page.

Text associated with the Square Annotation appears in a pop-up window. The size and shape of the rectangle is defined within the Rect entry.

Referenced by

SquareAnnotation

Constructor & Destructor Documentation

SquareAnnotation

SquareAnnotation(SquareAnnotationrhs, InternalConstructsignifier)

Parameters

rhs: SquareAnnotation
signifier: InternalConstruct

SquareAnnotation

SquareAnnotation(Pagepage, RectinitialRect)

Parameters

page: Page

The page to which the SquareAnnotation is added.

initialRect: Rect

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

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

SquareAnnotation

SquareAnnotation(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 SquareAnnotation 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]

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]

Subtype

stringSubtype[get]

Title

stringTitle[get, set]

Member Function Documentation

ConstructorRetrieve

static new static SquareAnnotationConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static SquareAnnotation

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