EditBox Class
Free Trial Web API version Licensing Request A Quote
HAVE QUESTIONS OR NEED HELP?SUBMIT THE SUPPORT REQUEST FORM or write email toSUPPORT@BYTESCOUT.COM
Represents a text box field in the PDF form.
Inheritance Hierarchy
Bytescout.PDFAnnotation
Bytescout.PDFWidget
Bytescout.PDFField
Bytescout.PDFEditBox
Namespace:Bytescout.PDF
Assembly: Bytescout.PDF (in Bytescout.PDF.dll) Version: 3.5.1.1204-master
Syntax
The EditBox type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | EditBox(RectangleF, String) | Initializes a new instance of the Bytescout.PDF.EditBox class. |
| EditBox(Single, Single, Single, Single, String) | Initializes a new instance of the Bytescout.PDF.EditBox class. |
Properties
| Name | Description | |
|---|---|---|
 | AltName | Gets the alternative field name. In some malformed PDF documents, the fields may have the same name or no name at all. This makes it problematic to find correct field for filling. The library automatically generates unique alternate names for such fields. These names can be used in 'Page.Annotations[string]' indexer to get field by name. (Inherited from Field.) |
| BackgroundColor | Gets or sets the color of the background. (Inherited from Widget.) |
| BorderColor | Gets or sets the color of the border. (Inherited from Widget.) |
| BorderStyle | Gets or sets the border style. (Inherited from Widget.) |
| BorderWidth | Gets or sets the width of the border. (Inherited from Widget.) |
| FileSelect | 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. |
| Font | Gets or sets the font used to display text in the control. |
| FontColor | Gets or sets the color of the font used to display text in the control. |
| FullName | Gets the fully qualified field name. (Inherited from Field.) |
| Height | Gets or sets the height of this annotation. (Inherited from Widget.) |
| Hidden | Gets or sets a value indicating whether this annotation is hidden. (Inherited from Annotation.) |
| InsertSpaces | 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 |
| Invisible | Gets or sets a value indicating whether this annotation is invisible. (Inherited from Annotation.) |
| Left | Gets or sets the x-coordinate of the left edge of this annotation. (Inherited from Widget.) |
| Locked | Gets or sets a value indicating whether this annotation is locked. (Inherited from Annotation.) |
| LockedContents | Gets or sets a value indicating whether to allow the contents of the annotation to be modified by the user. (Inherited from Annotation.) |
| MaxLength | Gets or sets the maximum number of characters that can be entered in the text box. |
| Multiline | Gets or sets a value indicating whether this Bytescout.PDF.EditBox is multiline. |
| Name | Gets the partial field name. (Inherited from Field.) |
| NoExport | Gets or sets a value indicating whether this Bytescout.PDF.Field is not exportable. (Inherited from Field.) |
| NoRotate | Gets or sets a value indicating whether to rotate the annotation's appearance to match the rotation of the page. (Inherited from Annotation.) |
| NoView | 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.) |
| NoZoom | Gets or sets a value indicating whether to scale the annotations's appearance to match the magnification of the page. (Inherited from Annotation.) |
| OnActivated | Gets or sets the action to be performed when the annotation is activated. (Inherited from Widget.) |
| OnBeforeFormatting | Gets or sets the action to be performed before the field is formatted to display its current value. (Inherited from Field.) |
| OnChange | Gets or sets the action to be performed when the field’s value is changed. (Inherited from Field.) |
| OnKeyPressed | 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.) |
| OnLoseFocus | Gets or sets the action to be performed when the annotation loses the input focus. (Inherited from Widget.) |
| OnMouseDown | Gets or sets the action to be performed when the mouse button is pressed inside the annotation’s active area. (Inherited from Widget.) |
| OnMouseEnter | Gets or sets the action to be performed when the cursor enters the annotation’s active area. (Inherited from Widget.) |
| OnMouseExit | Gets or sets the action to be performed when the cursor exits the annotation’s active area. (Inherited from Widget.) |
| OnMouseUp | Gets or sets the action to be performed when the mouse button is released inside the annotation’s active area. (Inherited from Widget.) |
| OnOtherFieldChanged | Gets or sets the action to be performed to recalculate the value of this field when that of another field changes. (Inherited from Field.) |
| OnPageClose | 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.) |
| OnPageInvisible | 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.) |
| OnPageOpen | 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.) |
| OnPageVisible | 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.) |
| OnReceiveFocus | Gets or sets the action to be performed when the annotation receives the input focus. (Inherited from Widget.) |
| Password | Gets or sets a value indicating whether this Bytescout.PDF.EditBox is a password field. |
| Gets or sets a value indicating whether this annotation gets printed when the page is printed. (Inherited from Annotation.) | |
| ReadOnly | Gets or sets a value indicating whether to allow the user to change the value of the field. (Inherited from Field.) |
| Required | Gets or sets a value indicating whether this Bytescout.PDF.Field is required. (Inherited from Field.) |
| RichText | Gets or sets a value indicating whether the value of this field should be represented as a rich text string. |
| Scrollable | Gets or sets a value indicating whether this Bytescout.PDF.EditBox is scrollable. |
| SpellCheck | Gets or sets a value indicating whether to check spelling. |
| Text | Gets or sets the text associated with the control. |
| TextAlign | Gets or sets a value indicating how the text should be aligned within the edit box. |
| TextRotationAngle | Gets or sets the text rotation angle. |
| ToggleNoView | Gets or sets a value indicating whether to invert the interpretation of the annotation property for certain events. (Inherited from Annotation.) |
| Top | Gets or sets the y-coordinate of the top edge of this annotation. (Inherited from Widget.) |
| Type | Gets the Bytescout.PDF.AnnotationType value that specifies the type of this annotation. (Overrides AnnotationType.) |
| Width | Gets or sets the width of this annotation. (Inherited from Widget.) |
Methods
| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| ToString | (Inherited from Object.) |
See Also