PdfWidget Class

Class for a widget (annotation). Widget is an object such as a note, sound, or movie with a location on a page of a PDF document, or an interactive control that provides a way to interact with the user by means of the mouse and keyboard. This class is a base class for PdfControl, PdfActionArea, PdfTextAnnotation, Pdf3dAnnotation, PdfEllipseAnnotation, PdfFileAttachmentAnnotation, PdfFreeTextAnnotation, PdfHighlightAnnotation, PdfInkAnnotation, PdfJaggedUnderlineAnnotation, PdfLineAnnotation, PdfMovieAnnotation, PdfPolygonAnnotation, PdfPolylineAnnotation, PdfPopupAnnotation, PdfPrinterMarkAnnotation, PdfRectangleAnnotation, PdfScreenAnnotation, PdfSoundAnnotation, PdfStampAnnotation, PdfStrikeoutAnnotation, PdfTrapNetworkAnnotation, PdfUnderlineAnnotation and PdfWatermarkAnnotation.

Inheritance Hierarchy

System.Object
  BitMiracle.Docotic.Pdf.PdfWidget
    

Namespace:  BitMiracle.Docotic.Pdf
Assembly:  BitMiracle.Docotic.Pdf (in BitMiracle.Docotic.Pdf.dll)

Syntax

C#
public abstract class PdfWidget
VB
Public MustInherit Class PdfWidget

The PdfWidget type exposes the following members.

Properties

  NameDescription
Public propertyBoundingBox
Gets or sets the bounding box (rectangle that defines the location of the widget on the page).
Public propertyFlags
Gets or sets the set of flags specifying various characteristics of the widget.
Public propertyHeight
Gets or sets the height of the bounding box (rectangle that defines the location of the widget on the page).
Public propertyHidden
Gets or sets a value indicating whether this PdfWidget is hidden.
Public propertyInvisible
Gets or sets a value indicating whether this PdfWidget is invisible.
Public propertyLayer
(PDF 1.5) Gets or sets the layer to which this widget belongs.
Public propertyLeft
Gets or sets the x-coordinate of the left edge of the bounding box (rectangle that defines the location of the widget on the page).
Public propertyLocked
(PDF 1.4) Gets or sets a value indicating whether this PdfWidget is locked.
Public propertyLockedContents
(PDF 1.7) Gets or sets a value indicating whether to allow the contents of the widget to be modified by the user.
Public propertyModifiedDate
Gets or sets the date and time when the widget was last modified.
Public propertyNoRotate
Gets or sets a value indicating whether to rotate the widget's appearance to match the rotation of the page.
Public propertyNoView
Gets or sets a value indicating whether to display widget on screen and allow it to interact with the user.
Public propertyNoZoom
Gets or sets a value indicating whether to scale widget's appearance to match the magnification of the page.
Public propertyOwner
Gets the page with which this widget is associated.
Public propertyPrint
Gets or sets a value indicating whether this PdfWidget gets printed when the page is printed.
Public propertyReadOnly
Gets or sets a value indicating whether to allow widget to interact with the user.
Public propertyToggleNoView
(PDF 1.5) Gets or sets a value indicating whether to invert the interpretation of NoView property for certain events.
Public propertyTop
Gets or sets the y-coordinate of the top edge of the bounding box (rectangle that defines the location of the widget on the page).
Public propertyType
Gets the type of this PdfWidget.
Public propertyWidth
Gets or sets the width of the bounding box (rectangle that defines the location of the widget on the page).

Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Overrides Object.Equals(Object).)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a this type.
(Overrides Object.GetHashCode().)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString
Returns a String that represents this instance.
(Overrides Object.ToString().)

Operators

  NameDescription
Public operatorStatic memberEquality
Determines whether the two specified objects are equal to each other.
Public operatorStatic memberInequality
Determines whether the two specified objects are not equal to each other.

See Also

Inheritance Hierarchy