LinkAnnotation Class Documentation
class LinkAnnotation : AnnotationNamespace:Datalogics::PDFL
- Inherits from:
Annotation
Detailed Description
A link annotation, which features an embedded hyperlink.
Referenced by
Constructor & Destructor Documentation
LinkAnnotation
Parameters
Create a new LinkAnnotation at the end of a page's annotation array. To create a LinkAnnotation and place it elsewhere in the page's annotation array, use the version of the constructor that takes an array position.
LinkAnnotation
Parameters
page: PageThe page to which the annotation is added.
initialRect: RectA rectangle specifying the annotation's bounds, specified in user space coordinates.
addAfter: intWhere 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 LinkAnnotation at a specific index in the page's annotation array.
Property Documentation
Action
Action Action[get, set]AnnotationFeatureLevel
double AnnotationFeatureLevel[get, set]BorderStyle
string BorderStyle[get, set]BorderStyleDashPattern
System.Collections.Generic.IList< System.Double > BorderStyleDashPattern[get, set]BorderStyleWidth
double BorderStyleWidth[get, set]Color
Color Color[get, set]Contents
string Contents[get, set]Destination
ViewDestination Destination[get, set]Flags
AnnotationFlags Flags[get, set]Highlight
HighlightStyle Highlight[get, set]InteriorColor
Color InteriorColor[get, set]NormalAppearance
Form NormalAppearance[get, set]Opacity
double Opacity[get, set]OptionalContentMembershipDict
OptionalContentMembershipDict OptionalContentMembershipDict[get, set]PDFDict
PDFDict PDFDict[get]Rect
Rect Rect[get, set]Subtype
string Subtype[get]Title
string Title[get, set]Member Function Documentation
CopyTo
LinkAnnotation CopyTo(Page destination)Parameters
destination: Pagethe page to copy the annotation to. The page may be in the same document as the source annotation or in a different document.
Returns:
LinkAnnotationthe annotation created on the destination page.
Copy a LinkAnnotation to the specified page. The annotation will be centered on the page. To center the annotation at a specific point, use the version of this method that accepts a Point.
This creates a copy of the original LinkAnnotation and puts the copy in the destination page's annotation dictionary. Structural content information associated with the source annotation will not be present in the copy. An exception will be thrown if the annotation cannot be copied to the specified page.
Note: If copying LinkAnnotations between pages in different documents, the source annotation may have a ViewDestination that's invalid in the destiantion document or an Action referring to a ViewDestination that's invalid in the destination document. In these cases, an exception will be thrown.
CopyTo
LinkAnnotation CopyTo(Page destination, Point centerPoint)Parameters
Returns:
LinkAnnotationthe annotation created on the destination page.
Copy a LinkAnnotation to the specified page and center the annotation on the specified point.
This creates a copy of the original LinkAnnotation and puts the copy in the destination page's annotation dictionary. Structural content information associated with the source annotation will not be present in the copy. An exception will be thrown if the annotation cannot be copied to the specified page.
Note: If copying LinkAnnotations between pages in different documents, the source annotation may have a ViewDestination that's invalid in the destiantion document or an Action referring to a ViewDestination that's invalid in the destination document. In these cases, an exception will be thrown.
Dispose
void Dispose()Returns:
voidEquals
override bool Equals(object obj)Parameters
obj: object
Returns:
override boolGenerateAppearance
override Form GenerateAppearance()Returns:
override FormA new Form containing the generated appearance, or null if the appearance could not be generated (for example, due to an invalid border style).
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
bool HasRichTextData()Returns:
booltrue 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.
IsCurrentlyVisible
bool IsCurrentlyVisible(OptionalContentContext occ)Parameters
occ: OptionalContentContextThe optional content context in which to check visibility.
Returns:
booltrue 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 string ToString()Returns:
override stringA string describing this annotation, including its type and rectangle.
Returns a string representation of this annotation.