![]() |
PdfAnnotation Class |
The PdfAnnotation type exposes the following members.
Name | Description | |
---|---|---|
![]() |
PdfAnnotation |
Initializes a new instance of the PdfAnnotation class.
|
![]() |
PdfAnnotation(PdfDocument) |
Initializes a new instance of the PdfAnnotation class.
|
Name | Description | |
---|---|---|
![]() |
Clone |
Creates a copy of this dictionary. Direct values are deep copied. Indirect references are not modified.
(Inherited from PdfDictionary.)
|
![]() |
Copy |
This function is useful for importing objects from external documents. The returned object is not yet complete. irefs refer to external objects and directed objects are cloned but their document property is null. A cloned dictionary or array needs a 'fix-up' to be a valid object.
(Inherited from PdfDictionary.)
|
![]() |
CreateStream |
Creates the stream of this dictionary and initializes it with the specified byte array. The function must not be called if the dictionary already has a stream.
(Inherited from PdfDictionary.)
|
![]() |
Delete |
Obsolete.
Removes an annotation from the document
|
![]() |
Equals | (Inherited from Object.) |
![]() |
Finalize | (Inherited from Object.) |
![]() |
GetEnumerator |
Returns an enumerator that iterates through the dictionary elements.
(Inherited from PdfDictionary.)
|
![]() |
GetHashCode | (Inherited from Object.) |
![]() |
GetType | (Inherited from Object.) |
![]() |
MemberwiseClone | (Inherited from Object.) |
![]() |
ToString |
Returns a string with the content of this object in a readable form. Useful for debugging purposes only.
(Inherited from PdfDictionary.)
|
Name | Description | |
---|---|---|
![]() |
Get |
A helper for a PdfItem that will automatically lookup / fetch the corresponding PdfReference item if the item is a PdfReference. If the item is not a PdfItem, then the original item is returned.
(Defined by PdfItemExtensions.)
|
![]() |
IsArray |
Checks to see if the PdfItem can be represented as a PdfArray
(Defined by PdfItemExtensions.)
|
![]() |
IsBoolean |
Checks to see if the PdfItem can be represented as a PdfBoolean
(Defined by PdfItemExtensions.)
|
![]() |
IsDate |
Checks to see if the PdfItem can be represented as a PdfDate
(Defined by PdfItemExtensions.)
|
![]() |
IsImage |
Checks to see if the specified dictionary contains an image.
(Defined by PdfDictionaryExtensions.)
|
![]() |
IsLiteral |
Checks to see if the PdfItem can be represented as a PdfLiteral
(Defined by PdfItemExtensions.)
|
![]() |
IsName |
Checks to see if the PdfItem can be represented as a PdfName
(Defined by PdfItemExtensions.)
|
![]() |
IsNull |
Checks to see if the PdfItem can be represented as a PdfNull
(Defined by PdfItemExtensions.)
|
![]() |
IsNumber |
Checks to see if the PdfItem can be represented as a PdfNumber
(Defined by PdfItemExtensions.)
|
![]() |
IsObject |
Checks to see if the PdfItem can be represented as a PdfObject
(Defined by PdfItemExtensions.)
|
![]() |
IsRectangle |
Checks to see if the PdfItem can be represented as a PdfRectangle
(Defined by PdfItemExtensions.)
|
![]() |
IsReference |
Checks to see if the PdfItem can be represented as a PdfReference
(Defined by PdfItemExtensions.)
|
![]() |
IsString |
Checks to see if the PdfItem can be represented as a PdfString
(Defined by PdfItemExtensions.)
|
Name | Description | |
---|---|---|
![]() |
Color |
Gets or sets the color representing the components of the annotation. If the color has an alpha value other than 1, it is ignored. Use property Opacity to get or set the opacity of an annotation.
|
![]() |
Contents |
Gets or sets the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotationæ¯ contents in human-readable form.
|
![]() |
Elements |
Gets the dictionary containing the elements of this dictionary.
(Inherited from PdfDictionary.)
|
![]() |
Flags |
Gets or sets the annotation flags of this instance.
|
![]() |
Internals |
Gets the PdfInternals object of this document, that grants access to some internal structures which are not part of the public interface of PdfDocument.
(Inherited from PdfObject.)
|
![]() |
IsIndirect |
Indicates whether the object is an indirect object.
(Inherited from PdfObject.)
|
![]() |
Opacity |
Gets or sets the constant opacity value to be used in painting the annotation. This value applies to all visible elements of the annotation in its closed state (including its background and border) but not to the popup window that appears when the annotation is opened.
|
![]() |
Owner |
Gets the PdfDocument this object belongs to.
(Inherited from PdfObject.)
|
![]() |
Parent |
Gets or sets the PdfAnnotations object that this annotation belongs to.
|
![]() |
Rectangle |
Gets or sets the annotation rectangle, defining the location of the annotation on the page in default user space units.
|
![]() |
Reference |
Gets the indirect reference of this object. If the value is null, this object is a direct object.
(Inherited from PdfObject.)
|
![]() |
Stream |
Gets or sets the PDF stream belonging to this dictionary. Returns null if the dictionary has no stream. To create the stream, call the CreateStream function.
(Inherited from PdfDictionary.)
|
![]() |
Subject |
Gets or sets text representing a short description of the subject being addressed by the annotation.
|
![]() |
Title |
Gets or sets the text label to be displayed in the title bar of the annotationæ¯ pop-up window when open and active. By convention, this entry identifies the user who added the annotation.
|