EditBox ClassByteScout PDF SDK
Represents a text box field in the PDF form.
Inheritance Hierarchy

SystemObject
  Bytescout.PDFAnnotation
    Bytescout.PDFWidget
      Bytescout.PDFField
        Bytescout.PDFEditBox

Namespace:  Bytescout.PDF
Assembly:  Bytescout.PDF (in Bytescout.PDF.dll) Version: 1.9.9.356-master
Syntax

public class EditBox : Field

The EditBox type exposes the following members.

Constructors

  NameDescription
Public methodEditBox(RectangleF, String)
Initializes a new instance of the Bytescout.PDF.EditBox class.
Public methodEditBox(Single, Single, Single, Single, String)
Initializes a new instance of the Bytescout.PDF.EditBox class.
Top
Properties

  NameDescription
Public propertyBackgroundColor
Gets or sets the color of the background.
(Inherited from Widget.)
Public propertyBorderColor
Gets or sets the color of the border.
(Inherited from Widget.)
Public propertyBorderStyle
Gets or sets the border style.
(Inherited from Widget.)
Public propertyBorderWidth
Gets or sets the width of the border.
(Inherited from Widget.)
Public propertyFileSelect
Gets or sets a value indicating whether the text entered in the field represents the pathname of a file whose contents are to be submitted as the value of the field.
Public propertyFont
Gets or sets the font used to display text in the control.
Public propertyFontColor
Gets or sets the color of the font used to display text in the control.
Public propertyHeight
Gets or sets the height of this annotation.
(Inherited from Widget.)
Public propertyHidden
Gets or sets a value indicating whether this annotation is hidden.
(Inherited from Annotation.)
Public propertyInsertSpaces
Gets or sets a value indicating whether the field is automatically divided into as many equally spaced positions, or combs, as the value of MaxLength, and the text is laid out into those combs.
Remarks

Meaningful only if the MaxLength property is set and the Multiline, Password properties are false.
Public propertyInvisible
Gets or sets a value indicating whether this annotation is invisible.
(Inherited from Annotation.)
Public propertyLeft
Gets or sets the x-coordinate of the left edge of this annotation.
(Inherited from Widget.)
Public propertyLocked
Gets or sets a value indicating whether this annotation is locked.
(Inherited from Annotation.)
Public propertyLockedContents
Gets or sets a value indicating whether to allow the contents of the annotation to be modified by the user.
(Inherited from Annotation.)
Public propertyMaxLength
Gets or sets the maximum number of characters that can be entered in the text box.
Public propertyMultiline
Gets or sets a value indicating whether this Bytescout.PDF.EditBox is multiline.
Public propertyName
Gets the partial field name.
(Inherited from Field.)
Public propertyNoExport
Gets or sets a value indicating whether this Bytescout.PDF.Field is not exportable.
(Inherited from Field.)
Public propertyNoRotate
Gets or sets a value indicating whether to rotate the annotation's appearance to match the rotation of the page.
(Inherited from Annotation.)
Public propertyNoView
Gets or sets a value indicating whether to display the annotation on the screen and allow it to interact with the user.
(Inherited from Annotation.)
Public propertyNoZoom
Gets or sets a value indicating whether to scale the annotations's appearance to match the magnification of the page.
(Inherited from Annotation.)
Public propertyOnActivated
Gets or sets the action to be performed when the annotation is activated.
(Inherited from Widget.)
Public propertyOnBeforeFormatting
Gets or sets the action to be performed before the field is formatted to display its current value.
(Inherited from Field.)
Public propertyOnChange
Gets or sets the action to be performed when the field’s value is changed.
(Inherited from Field.)
Public propertyOnKeyPressed
Gets or sets the action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box.
(Inherited from Field.)
Public propertyOnLoseFocus
Gets or sets the action to be performed when the annotation loses the input focus.
(Inherited from Widget.)
Public propertyOnMouseDown
Gets or sets the action to be performed when the mouse button is pressed inside the annotation’s active area.
(Inherited from Widget.)
Public propertyOnMouseEnter
Gets or sets the action to be performed when the cursor enters the annotation’s active area.
(Inherited from Widget.)
Public propertyOnMouseExit
Gets or sets the action to be performed when the cursor exits the annotation’s active area.
(Inherited from Widget.)
Public propertyOnMouseUp
Gets or sets the action to be performed when the mouse button is released inside the annotation’s active area.
(Inherited from Widget.)
Public propertyOnOtherFieldChanged
Gets or sets the action to be performed to recalculate the value of this field when that of another field changes.
(Inherited from Field.)
Public propertyOnPageClose
Gets or sets the action to be performed when the page containing the annotation is closed — for example, when the user navigates to the next or previous page, or follows a link annotation or outline item.
(Inherited from Widget.)
Public propertyOnPageInvisible
Gets or sets the action to be performed when the page containing the annotation is no longer visible in the viewer application’s user interface.
(Inherited from Widget.)
Public propertyOnPageOpen
Gets or sets the action to be performed when the page containing the annotation is opened — for example, when the user navigates to it from the next or previous page or by means of a link annotation or outline item.
(Inherited from Widget.)
Public propertyOnPageVisible
Gets or sets the action to be performed when the page containing the annotation becomes visible in the viewer application’s user interface.
(Inherited from Widget.)
Public propertyOnReceiveFocus
Gets or sets the action to be performed when the annotation receives the input focus.
(Inherited from Widget.)
Public propertyPassword
Gets or sets a value indicating whether this Bytescout.PDF.EditBox is a password field.
Public propertyPrint
Gets or sets a value indicating whether this annotation gets printed when the page is printed.
(Inherited from Annotation.)
Public propertyReadOnly
Gets or sets a value indicating whether to allow the user to change the value of the field.
(Inherited from Field.)
Public propertyRequired
Gets or sets a value indicating whether this Bytescout.PDF.Field is required.
(Inherited from Field.)
Public propertyRichText
Gets or sets a value indicating whether the value of this field should be represented as a rich text string.
Public propertyScrollable
Gets or sets a value indicating whether this Bytescout.PDF.EditBox is scrollable.
Public propertySpellCheck
Gets or sets a value indicating whether to check spelling.
Public propertyText
Gets or sets the text associated with the control.
Public propertyTextAlign
Gets or sets a value indicating how the text should be aligned within the edit box.
Public propertyTextRotationAngle
Gets or sets the text rotation angle.
Public propertyToggleNoView
Gets or sets a value indicating whether to invert the interpretation of the annotation property for certain events.
(Inherited from Annotation.)
Public propertyTop
Gets or sets the y-coordinate of the top edge of this annotation.
(Inherited from Widget.)
Public propertyType
Gets the Bytescout.PDF.AnnotationType value that specifies the type of this annotation.
(Overrides AnnotationType.)
Public propertyWidth
Gets or sets the width of this annotation.
(Inherited from Widget.)
Top
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 methodToString (Inherited from Object.)
Top
See Also

Reference