Class for an interactive control on the screen that the user can manipulate with the mouse. This class is a base class for PdfCheckBox, PdfComboBox, PdfTextBox, PdfButton, PdfRadioButton and PdfSignatureField.

Inheritance Hierarchy

System.Object
  BitMiracle.Docotic.Pdf.PdfWidget
    BitMiracle.Docotic.Pdf.PdfControl
      

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

Syntax

C#
public abstract class PdfControl : PdfWidget
VB
Public MustInherit Class PdfControl
	Inherits PdfWidget

The PdfControl type exposes the following members.

Properties

  NameDescription
Public propertyBackgroundColor
Gets or sets the color of the control background.
Public propertyBorderColor
Gets or sets the color of the control border.
Public propertyBoundingBox
Gets or sets the bounding box (rectangle that defines the location of the control on the page).
(Overrides PdfWidget.BoundingBox.)
Public propertyFlags
Gets or sets the set of flags specifying various characteristics of the widget.
(Inherited from PdfWidget.)
Public propertyFullName
Gets the fully qualified name of the control.
Public propertyHasBorder
Gets or sets a value indicating whether this widget has border.
(Inherited from PdfWidget.)
Public propertyHeight
Gets or sets the height of the bounding box (rectangle that defines the location of the widget on the page).
(Inherited from PdfWidget.)
Public propertyHidden
Gets or sets a value indicating whether this PdfWidget is hidden.
(Inherited from PdfWidget.)
Public propertyHint
Gets or sets the text displayed when the mouse hovers over the control.
Public propertyInvisible
Gets or sets a value indicating whether this PdfWidget is invisible.
(Inherited from PdfWidget.)
Public propertyLayer
Gets or sets the layer to which this widget belongs.
(Inherited from PdfWidget.)
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).
(Inherited from PdfWidget.)
Public propertyLocked
(PDF 1.4) Gets or sets a value indicating whether this PdfWidget is locked.
(Inherited from PdfWidget.)
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.
(Inherited from PdfWidget.)
Public propertyName
Gets or sets the control name.
Public propertyNoRotate
Gets or sets a value indicating whether to rotate the widget's appearance to match the rotation of the page.
(Inherited from PdfWidget.)
Public propertyNoView
Gets or sets a value indicating whether to display widget on screen and allow it to interact with the user.
(Inherited from PdfWidget.)
Public propertyNoZoom
Gets or sets a value indicating whether to scale widget's appearance to match the magnification of the page.
(Inherited from PdfWidget.)
Public propertyOnActivation
Gets or sets the action to be performed when the control is activated.
Public propertyOnBeforeFormatting
Gets or sets the PdfJavaScriptAction action to be performed before the control is formatted to display its current value.
Public propertyOnChange
Gets or sets the PdfJavaScriptAction action to be performed when the control's value is changed.
Public propertyOnKeyPress
Gets or sets the PdfJavaScriptAction action to be performed when the user types a keystroke into PdfTextBox or PdfComboBox or modifies the selection in a scrollable list box.
Public propertyOnLostFocus
Gets or sets the action to be performed when the control loses the input focus.
Public propertyOnMouseDown
Gets or sets the action to be performed when the mouse button is pressed inside the control's active area.
Public propertyOnMouseEnter
Gets or sets the action to be performed when the cursor enters the control's active area.
Public propertyOnMouseExit
Gets or sets the action to be performed when the cursor exits the controls' active area.
Public propertyOnMouseUp
Gets or sets the action to be performed when the mouse button is released inside the control's active area.
Public propertyOnOtherControlChanged
Gets or sets the PdfJavaScriptAction action to be performed to recalculate the value of this control when that of another control changes.
Public propertyOnSetFocus
Gets or sets the action to be performed when the control receives the input focus.
Public propertyOwner
Gets the page with which this widget is associated.
(Inherited from PdfWidget.)
Public propertyPrint
Gets or sets a value indicating whether this PdfWidget gets printed when the page is printed.
(Inherited from PdfWidget.)
Public propertyReadOnly
Gets or sets a value indicating whether to allow widget to interact with the user.
(Inherited from PdfWidget.)
Public propertyRotation
Gets the PdfRotation value specifying the rotation of the control counterclockwise relative to the page.
Public propertyToggleNoView
(PDF 1.5) Gets or sets a value indicating whether to invert the interpretation of NoView property for certain events.
(Inherited from PdfWidget.)
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).
(Inherited from PdfWidget.)
Public propertyType
Gets the type of this PdfWidget.
(Inherited from PdfWidget.)
Public propertyValueIsRequired
Gets or sets a value indicating whether this control must have a value at the time it is exported by a PdfSubmitFormAction.
Public propertyWidth
Gets or sets the width of the bounding box (rectangle that defines the location of the widget on the page).
(Inherited from PdfWidget.)

Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRotate
Rotates control around top-left control's corner, counter-clockwise, relative to the page. Useful when PdfPage is rotated.
Public methodToString
Returns a String that represents this instance.
(Overrides PdfWidget.ToString().)

See Also

Inheritance Hierarchy