Represents a text annotation.
Inheritance Hierarchy
PdfEdit.PdfPdfItem
PdfEdit.PdfPdfObject
PdfEdit.PdfPdfDictionary
PdfEdit.Pdf.AnnotationsPdfAnnotation
PdfEdit.Pdf.AnnotationsPdfWidgetAnnotation
Namespace: PdfEdit.Pdf.Annotations
Assembly: PdfPrintingNet (in PdfPrintingNet.dll) Version: 5.2.1.0 (5.2.1.0)
Syntax
The PdfWidgetAnnotation type exposes the following members.
Constructors
Name | Description | |
---|---|---|
PdfWidgetAnnotation | Initializes a new instance of the PdfWidgetAnnotation class | |
PdfWidgetAnnotation(PdfDictionary) |
Initializes a new instance of the PdfWidgetAnnotation with the specified dictionary.
| |
PdfWidgetAnnotation(PdfDocument) | Initializes a new instance of the PdfWidgetAnnotation class |
Methods
Name | Description | |
---|---|---|
Clone |
Creates a copy of this dictionary. Direct values are deep copied. Indirect references are not
modified.
(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
(Inherited from PdfAnnotation.) | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
GetEnumerator |
Returns an enumerator that iterates through the dictionary elements.
(Inherited from PdfDictionary.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (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.) |
Fields
Name | Description | |
---|---|---|
ForceFilters |
List of filters which will be applied on the PdfDictionary stream.
(Inherited from PdfDictionary.) |
Properties
Name | Description | |
---|---|---|
BackColor |
Gets or sets the background color of the widget.
| |
BorderColor |
Gets or sets the border color of the widget.
| |
BorderWidth |
Gets or sets the border-width of this widget.
| |
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.
(Inherited from PdfAnnotation.) | |
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’s
contents in human-readable form.
(Inherited from PdfAnnotation.) | |
Elements |
Gets the dictionary containing the elements of this dictionary.
(Inherited from PdfDictionary.) | |
Flags |
Gets or sets the annotation flags of this instance.
(Inherited from PdfAnnotation.) | |
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.
(Inherited from PdfAnnotation.) | |
Owner |
Gets the PdfDocument this object belongs to.
(Inherited from PdfObject.) | |
Page |
Gets or sets the page for this Annotation
(Inherited from PdfAnnotation.) | |
Parent |
Gets or sets the PdfAnnotations object that this annotation belongs to.
(Inherited from PdfAnnotation.) | |
ParentField |
Get the parent-field of this Widget, if it is the child of a PdfAcroField>.
| |
Rectangle |
Gets or sets the annotation rectangle, defining the location of the annotation
on the page in default user space units.
(Inherited from PdfAnnotation.) | |
Reference |
Gets the indirect reference of this object. If the value is null, this object is a direct object.
(Inherited from PdfObject.) | |
Rotation |
The number of degrees by which the widget annotation shall be rotated counterclockwise relative to the page.
The value shall be a multiple of 90. Default value: 0
| |
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.
(Inherited from PdfAnnotation.) | |
Title |
Gets or sets the text label to be displayed in the title bar of the annotation’s
pop-up window when open and active. By convention, this entry identifies
the user who added the annotation.
(Inherited from PdfAnnotation.) |
See Also