Annot Class |
Namespace: pdftron.PDF
public sealed class Annot : IClosable, IAnnot
The Annot type exposes the following members.
Name | Description | |
---|---|---|
Annot(Annot) | Initializes a new instance of the Annot class | |
Annot(Obj) | Initializes a new instance of the Annot class |
Name | Description | |
---|---|---|
Close | ||
Create |
Creates an annotation instance based on annotation type
| |
DeleteCustomData | Deletes custom data associated with the given key.
| |
Equals | (Inherited from Object.) | |
Flatten | Flatten/Merge the existing annotation appearances with the page content and
delete this annotation from a given page.
Annotation 'flattening' refers to the operation that changes active annotations
(such as markup, widgets, 3D models, etc.) into a static area that is part of the
PDF document, just like the other text and images in the document.
| |
GetAnnotType | Gets the type.
| |
GetAppearance | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
| |
GetAppearance(AnnotAnnotationState) | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
| |
GetAppearance(AnnotAnnotationState, String) | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
| |
GetBorderStyle | Gets the border style for the annotation. Typically used for Link annotations.
| |
GetColorAsCMYK | Gets an annotation's color.
| |
GetColorAsGray | Gets an annotation's color.
| |
GetColorAsRGB | Gets the annotation’s active appearance state.
| |
GetColorCompNum | Gets the color space the annotation's color is represented in.
| |
GetContents |
Gets the contents.
| |
GetCustomData | Returns custom data associated with the given key.
| |
GetDate | Gets an annotation's last modified date.
| |
GetFlag | Gets the flag.
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetOptionalContent | Gets optional content of an annotation.
| |
GetPage | Gets the page the annotation is associated with.
| |
GetRect | Gets the rect.
| |
GetRotation | Gets the rotation value of the annotation. The Rotation specifies the number of degrees by which the
annotation shall be rotated counterclockwise relative to the page.
The value shall be a multiple of 90.
| |
GetSDFObj | Gets the SDFObj.
| |
GetStructParent | Gets the struct parent of an annotation.
(Required if the annotation is a structural content item; PDF 1.3)
| |
GetTriggerAction | Get the Action associated with the selected Annot Trigger event
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUniqueID | Gets the unique ID.
| |
IsMarkup | Checks if is markup.
| |
IsValid | Checks if is valid.
| |
RefreshAppearance | Regenerates the appearance stream for the annotation.
This method can be used to auto-generate the annotation appearance after creating
or modifying the annotation without providing an explicit appearance or
setting the "NeedAppearances" flag in the AcroForm dictionary.
| |
RefreshAppearance(RefreshOptions) | A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
| |
RemoveAppearance | Removes the annotation's appearance
| |
RemoveAppearance(AnnotAnnotationState) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
| |
RemoveAppearance(AnnotAnnotationState, String) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
| |
Resize |
Scales the geometry of the annotation so that its appearance would now fit a new
rectangle on the page, in user units.
Users still have to call RefreshAppearance() later if they want a corresponding
appearance stream to be generated for the new rectangle.
The main reason for not combining the two operations together is to be able to resize
annotations that do not have an appearance stream.
| |
SetAppearance(Obj) | Sets the annotation’s appearance for the given combination of annotation
and appearance states.
(Optional; PDF 1.2)
| |
SetAppearance(Obj, AnnotAnnotationState) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
| |
SetAppearance(Obj, AnnotAnnotationState, String) | Sets the annotation’s appearance for the given combination of annotation
and appearance states.
(Optional; PDF 1.2)
| |
SetBorderStyle | Sets the border style for the annotation. Typically used for Link annotations.
| |
SetColor(ColorPt) | Sets an annotation's color.
(Optional; PDF 1.1)
| |
SetColor(ColorPt, Int32) | Sets an annotation's color.
(Optional; PDF 1.1)
| |
SetContents | Sets the content of this annotation. (Optional).
| |
SetCustomData | Sets the custom data associated with the specified key.
| |
SetDate | Sets an annotation's last modified date.
| |
SetDateToNow |
Sets an annotation's modification date and time to the current time.
This corresponds to the value of the "M" field of annotation dictionary(PDF 1.1)
| |
SetFlag | Sets the value of given Flag.
| |
SetOptionalContent | Sets optional content of an annotation.
(Optional, PDF1.5).
| |
SetPage | Sets the reference to a page the annotation is associated with.
(Optional PDF 1.3; not used in FDF files)
| |
SetRect | Sets the size and location of an annotation on its page.
| |
SetRotation | Sets the rotation value of the annotation. The Rotation specifies the number of degrees by which the
annotation shall be rotated counterclockwise relative to the page.
The value shall be a multiple of 90.
(Optional)
| |
SetStructParent | Sets the struct parent of an annotation.
(Required if the annotation is a structural content item; PDF 1.3)
| |
SetUniqueID | Sets the unique identifier for this annotation.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |