Apitron.PDF.Kit library for .NET
SystemObject
Apitron.PDF.Kit.FixedLayout.ResourcesResource
Apitron.PDF.Kit.FixedLayout.ResourcesUndefinedResource
Apitron.PDF.Kit.Interactive.AnnotationsAnnotation
Apitron.PDF.Kit.Interactive.AnnotationsLinkAnnotation
Apitron.PDF.Kit.Interactive.AnnotationsMarkupAnnotation
Apitron.PDF.Kit.Interactive.AnnotationsPopupAnnotation
Apitron.PDF.Kit.Interactive.AnnotationsWatermarkAnnotation
Apitron.PDF.Kit.Interactive.AnnotationsWidgetAnnotation
Assembly: Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)
Top
Top
This class represents an abstract annotation
Inheritance Hierarchy
Apitron.PDF.Kit.FixedLayout.ResourcesResource
Apitron.PDF.Kit.FixedLayout.ResourcesUndefinedResource
Apitron.PDF.Kit.Interactive.AnnotationsAnnotation
Apitron.PDF.Kit.Interactive.AnnotationsLinkAnnotation
Apitron.PDF.Kit.Interactive.AnnotationsMarkupAnnotation
Apitron.PDF.Kit.Interactive.AnnotationsPopupAnnotation
Apitron.PDF.Kit.Interactive.AnnotationsWatermarkAnnotation
Apitron.PDF.Kit.Interactive.AnnotationsWidgetAnnotation
Namespace: Apitron.PDF.Kit.Interactive.Annotations
Assembly: Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)
Syntax
The Annotation type exposes the following members.
Properties
Name | Description | |
---|---|---|
Appearance |
Gets the annotation's appearance.
| |
BlendMode |
The blend mode that shall be used when painting the annotation onto the page.
If this key is not present, blending shall take place using the Normal blend mode.
The value shall be a valur, designating one of the standard blend modes listed in BlendMode enum.
| |
BorderEffect |
Gets or sets a border effect that is used in conjunction with the border style specified by the BorderStyle entry.
| |
BorderStyle |
Gets the annotation's border style.
| |
Boundary |
Gets the annotation's boundary.
| |
CanBeExported |
Gets a value indicating whether this instance can be exported.
(Inherited from Resource.) | |
Color |
Gets or sets the color.
An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes:
The background of the annotation’s icon when closed
The title bar of the annotation’s pop-up window
The border of a link annotation
The number of array elements determines the colour space in which the colour shall be defined:
0 No colour; transparent
1 DeviceGray
3 DeviceRGB
4 DeviceCMYK
| |
Contents |
Gets or sets the contents.
Text that shall be displayed for the annotation or, if this type of annotation does not display text,
an alternate description of the annotation’s contents in human-readable form. In either case, this
text is useful when extracting the document’s contents in support of accessibility to users with
disabilities or for other purposes.
| |
Flags |
Gets the annotation's flags.
| |
FontResourceID |
Gets or sets the font resource ID.
| |
FontSize |
Gets or sets the size of the font.
| |
Identity |
Gets or sets the identity.
| |
InteriorColor |
Gets or sets the interior color.
An array of numbers in the range 0.0 to 1.0 specifying the interior color that shall be used to fill the annotation’s line endings.
The number of array elements shall determine the colour space in which the colour is defined:
0 No colour; transparent
1 DeviceGray
3 DeviceRGB
4 DeviceCMYK
| |
ModificationDate |
Gets the date and time when the annotation was most recently modified.
| |
NonStrokingOpacity |
When regenerating the annotation's appearance, this is the opacity value (the range is 0.0 - 1.0) that shall be used for all nonstroking operations on all visible elements of the annotation in its closed state (including its background and border) but not the popup window that appears when the annotation is opened.
Default value: 1.0
The specified value shall not be used if the annotation has an appearance; in that case, the appearance stream shall specify any transparency.
| |
PageNumber |
Gets or sets the ordinal page number on which this annotation shall appear, where page 0 is the first page.
Meaningful for FormsDataDocument only.
| |
RectDifferences |
Gets or sets a set of four numbers describing the numerical differences between two rectangles:
the Boundary entry of the annotation and a rectangle contained within that rectangle.
The inner rectangle is where the annotation’s text should be displayed. Any border styles and/or
border effects specified by BorderStyle and BorderEffect entries,
respectively, shall be applied to the border of the inner rectangle.
The four numbers correspond to the differences in default user space between the left, top, right,
and bottom coordinates of Boundary and those of the inner rectangle, respectively. Each value shall be greater
than or equal to 0. The sum of the top and bottom differences shall be less than the height of Boundary, and the sum of the left and right differences shall be less than the width of Boundary.
| |
ResourceType |
Gets the resource type.
(Inherited from Resource.) | |
StrokingOpacity |
When regenerating the annotation's appearance, this is the opacity value (the range is 0.0 - 1.0) that shall be used for stroking all visible elements of the annotation in its closed state, including its background and border, but not the popup window that appears when the annotation is opened.
If a NonStrokingOpacity property is not present in this annotation, then the value of this StrokingOpacity entry shall also be used for nonstroking operations as well.
Default Value: 1.0
The specified value shall not be used if the annotation has an appearance; in that case, the appearance stream shall specify any transparency.
| |
StructParent |
Gets or sets the parent's structure.
| |
Tag |
Gets or sets extra information about the annotation.
| |
Type |
Gets the type.
|
Methods
Name | Description | |
---|---|---|
Export |
Exports the specified annotation to the destination document.
| |
FindLocations |
Finds the pages where the annotation is located.
| |
Flatten |
Flattens this instance and removes from the parent collection.
|
See Also