Click or drag to resize

Annot Class

Annot class
Inheritance Hierarchy
SystemObject
  pdftron.PDFAnnot

Namespace:  pdftron.PDF
Assembly:  pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax
public sealed class Annot : IClosable, 
	IAnnot

The Annot type exposes the following members.

Constructors
  NameDescription
Public methodAnnot(Annot)
Initializes a new instance of the Annot class
Public methodAnnot(Obj)
Initializes a new instance of the Annot class
Top
Methods
  NameDescription
Public methodClose
Public methodStatic memberCreate
Creates an annotation instance based on annotation type
Public methodDeleteCustomData
Deletes custom data associated with the given key.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFlatten
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.
Public methodGetAnnotType
Gets the type.
Public methodGetAppearance
Gets the annotation’s appearance for the given combination of annotation and appearance states.
Public methodGetAppearance(AnnotAnnotationState)
Gets the annotation’s appearance for the given combination of annotation and appearance states.
Public methodGetAppearance(AnnotAnnotationState, String)
Gets the annotation’s appearance for the given combination of annotation and appearance states.
Public methodGetBorderStyle
Gets the border style for the annotation. Typically used for Link annotations.
Public methodGetColorAsCMYK
Gets an annotation's color.
Public methodGetColorAsGray
Gets an annotation's color.
Public methodGetColorAsRGB
Gets the annotation’s active appearance state.
Public methodGetColorCompNum
Gets the color space the annotation's color is represented in.
Public methodGetContents
Gets the contents.
Public methodGetCustomData
Returns custom data associated with the given key.
Public methodGetDate
Gets an annotation's last modified date.
Public methodGetFlag
Gets the flag.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetOptionalContent
Gets optional content of an annotation.
Public methodGetPage
Gets the page the annotation is associated with.
Public methodGetRect
Gets the rect.
Public methodGetRotation
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.
Public methodGetSDFObj
Gets the SDFObj.
Public methodGetStructParent
Gets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
Public methodGetTriggerAction
Get the Action associated with the selected Annot Trigger event
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUniqueID
Gets the unique ID.
Public methodIsMarkup
Checks if is markup.
Public methodIsValid
Checks if is valid.
Public methodRefreshAppearance
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.
Public methodRefreshAppearance(RefreshOptions)
A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
Public methodRemoveAppearance
Removes the annotation's appearance
Public methodRemoveAppearance(AnnotAnnotationState)
Removes the annotation's appearance for the given combination of annotation and appearance states.
Public methodRemoveAppearance(AnnotAnnotationState, String)
Removes the annotation's appearance for the given combination of annotation and appearance states.
Public methodResize
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.
Public methodSetAppearance(Obj)
Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
Public methodSetAppearance(Obj, AnnotAnnotationState)
Removes the annotation's appearance for the given combination of annotation and appearance states.
Public methodSetAppearance(Obj, AnnotAnnotationState, String)
Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
Public methodSetBorderStyle
Sets the border style for the annotation. Typically used for Link annotations.
Public methodSetColor(ColorPt)
Sets an annotation's color. (Optional; PDF 1.1)
Public methodSetColor(ColorPt, Int32)
Sets an annotation's color. (Optional; PDF 1.1)
Public methodSetContents
Sets the content of this annotation. (Optional).
Public methodSetCustomData
Sets the custom data associated with the specified key.
Public methodSetDate
Sets an annotation's last modified date.
Public methodSetDateToNow
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)
Public methodSetFlag
Sets the value of given Flag.
Public methodSetOptionalContent
Sets optional content of an annotation. (Optional, PDF1.5).
Public methodSetPage
Sets the reference to a page the annotation is associated with. (Optional PDF 1.3; not used in FDF files)
Public methodSetRect
Sets the size and location of an annotation on its page.
Public methodSetRotation
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)
Public methodSetStructParent
Sets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
Public methodSetUniqueID
Sets the unique identifier for this annotation.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also