SquareAnnotation Class

class SquareAnnotation : 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

Uses types

Annotation AnnotationFlags Color Form OptionalContentContext OptionalContentMembershipDict PDFDict Page Rect SquareAnnotation

Constructor & Destructor Documentation

SquareAnnotation(Page page, Rect initialRect)

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(Page page, Rect initialRect, int addAfter)

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

double AnnotationFeatureLevel[get, set]

string BorderStyle[get, set]

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

double BorderStyleWidth[get, set]

Color Color[get, set]

string Contents[get, set]

AnnotationFlags Flags[get, set]

Color InteriorColor[get, set]

Form NormalAppearance[get, set]

double Opacity[get, set]

OptionalContentMembershipDict OptionalContentMembershipDict[get, set]

PDFDict PDFDict[get]

Rect Rect[get, set]

string Subtype[get]

string Title[get, set]

Member Function Documentation

void Dispose()

Returns:

void

override bool Equals(object obj)

Parameters

obj: object

Returns:

override bool

override Form GenerateAppearance()

Returns:

override Form

A Form representing the visual appearance of this annotation, or null if the appearance could not be generated (e.g. due to an invalid border style).

Generate a new appearance stream for this square annotation.

Creates an appearance based on the current annotation properties, including color, interior color, border style, and bounding rectangle. The rectangle is drawn within the annotation rectangle.

bool HasRichTextData()

Returns:

bool

true if the annotation contains Rich Text String content.

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.

bool IsCurrentlyVisible(OptionalContentContext occ)

Parameters

occ: OptionalContentContext: The optional content context in which to check visibility.

Returns:

bool

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.

override string ToString()

Returns:

override string

A string describing this annotation, including its type and rectangle.

Returns a string representation of this annotation.