Class PdfWidget

Namespace: BitMiracle.Docotic.Pdf

Assembly: BitMiracle.Docotic.Pdf.dll

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, PdfCustomAnnotation, PdfEllipseAnnotation, PdfFileAttachmentAnnotation, PdfFreeTextAnnotation, PdfHighlightAnnotation, PdfInkAnnotation, PdfJaggedUnderlineAnnotation, PdfLineAnnotation, PdfMovieAnnotation, PdfPolygonAnnotation, PdfPolylineAnnotation, PdfPopupAnnotation, PdfPrinterMarkAnnotation, PdfRectangleAnnotation, PdfRedactionAnnotation, PdfScreenAnnotation, PdfSoundAnnotation, PdfStampAnnotation, PdfStrikeoutAnnotation, PdfTrapNetworkAnnotation, PdfUnderlineAnnotation and PdfWatermarkAnnotation.

public abstract class PdfWidget

Inheritance: object

PdfWidget

Inherited Members: object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

The Docotic.Pdf Library Documentation page contains links to articles, guides, and sample code.

Properties

BoundingBox: Gets or sets the bounding box (rectangle that defines the location of the widget on the page).

Flags: Gets or sets the set of flags specifying various characteristics of the widget.

Height: Gets or sets the height of the bounding box (rectangle that defines the location of the widget on the page).

Hidden: Gets or sets a value indicating whether this PdfWidget is hidden.

Invisible: Gets or sets a value indicating whether this PdfWidget is invisible.

Layer: (PDF 1.5) Gets or sets the layer to which this widget belongs.

Left: 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).

Locked: (PDF 1.4) Gets or sets a value indicating whether this PdfWidget is locked.

LockedContents: (PDF 1.7) Gets or sets a value indicating whether to allow the contents of the widget to be modified by the user.

ModifiedDate: Gets or sets the date and time when the widget was last modified.

NoRotate: Gets or sets a value indicating whether to rotate the widget's appearance to match the rotation of the page.

NoView: Gets or sets a value indicating whether to display widget on screen and allow it to interact with the user.

NoZoom: Gets or sets a value indicating whether to scale widget's appearance to match the magnification of the page.

Owner: Gets the page with which this widget is associated.

Print: Gets or sets a value indicating whether this PdfWidget gets printed when the page is printed.

ReadOnly: Gets or sets a value indicating whether to allow widget to interact with the user.

ToggleNoView: (PDF 1.5) Gets or sets a value indicating whether to invert the interpretation of NoView property for certain events.

Top: 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).

Type: Gets the type of this PdfWidget.

Width: Gets or sets the width of the bounding box (rectangle that defines the location of the widget on the page).

Methods

Equals(object?): Determines whether the specified object is equal to the current PdfWidget object.

Flatten(): Flattens this widget to its parent page. In effect, replaces the control with its appearance.

GetHashCode(): Serves as a hash function for a PdfWidget instance.

ToString(): Returns a string that represents this PdfWidget instance.

Operators

operator ==(PdfWidget, PdfWidget): Determines whether the two specified objects are equal to each other.

operator !=(PdfWidget, PdfWidget): Determines whether the two specified objects are not equal to each other.