Skip to content

# PDFVisualTextBoxWidget

Namespace: O2S.Components.PDF4NET.View.Forms

Defines a textbox widget that is displayed in a PDFDocumentView control.

    public class PDFVisualTextBoxWidget : PDFVisualFieldWidget

Inheritance Object → PDFVisualAnnotation → PDFVisualFieldWidget → PDFVisualTextBoxWidget

## Constructors

### PDFVisualTextBoxWidget(PDFTextBoxWidget)

Initializes a new PDFVisualTextBoxWidget object.

    public PDFVisualTextBoxWidget(PDFTextBoxWidget fieldWidget)

Parameters

`fieldWidget` PDFTextBoxWidget
The underlying field widget.

## Properties

### Align

Gets or sets the field text alignment.

    public PDFStringHorizontalAlign Align { get; set; }

Property Value

PDFStringHorizontalAlign
A that specifies how the text is aligned on horizontal in the field.

### Annotation

Gets the underlying PDF annotation.

    public PDFAnnotation Annotation { get; }

Property Value

PDFAnnotation
A PDF annotation.

### BackgroundColor

Gets or sets the widget background color.

    public PDFColor BackgroundColor { get; set; }

Property Value

PDFColor
A specifying the widget's background color.

Exceptions

ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.

### BorderColor

Gets or sets the widget border color.

    public PDFColor BorderColor { get; set; }

Property Value

PDFColor
A specifying the widget's border color.

Exceptions

ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.

### BorderDashPattern

Gets or sets the array that represents the dash pattern when the PDFVisualFieldWidget.BorderStyle property is set to .

    public Double[] BorderDashPattern { get; set; }

Property Value

Double[]
An array of double values specifying the style of the dashed line.

### BorderStyle

Gets or sets the widget border style.

    public PDFAnnotationBorderStyle BorderStyle { get; set; }

Property Value

PDFAnnotationBorderStyle
A enum specifying the style of the widget border.

### BorderWidth

Gets or sets the widget border width.

    public double BorderWidth { get; set; }

Property Value

Double
A specifying the widget's border width.

### DisplayRectangle

Gets or sets the visual rectangle of this annotation.

    public PDFDisplayRectangle DisplayRectangle { get; set; }

Property Value

PDFDisplayRectangle
A that represents the position and size of the annotation on the page.

Remarks

The visual rectangle is relative to the top left corner of the page.

### NormalAppearance

Gets or sets the annotation normal appearance.

    public PDFAnnotationAppearance NormalAppearance { get; set; }

Property Value

PDFAnnotationAppearance
A specifying how the annotation is presented visually on the page.

### Tag

Gets or sets an object that contains user-defined data associated with the annotation.

    public object Tag { get; set; }

Property Value

Object

Remarks

This property can be used to store any custom information relevant to the annotation at runtime. The value is not used by the annotation itself and is intended solely for application-specific data.
NOTE: The value of this property is not persisted in the PDF file.

### TextBoxWidget

Gets the underlying textbox widget.

    public PDFTextBoxWidget TextBoxWidget { get; }

Property Value

PDFTextBoxWidget
A object representing the non-visual textbox widget.

### VisualField

Gets the visual field that owns this widget.

    public PDFVisualField VisualField { get; internal set; }

Property Value

PDFVisualField
A PDFVisualField descendant that represents a field in the PDF document.

### VisualPage

Gets the page that owns the anotation.

    public PDFVisualPage VisualPage { get; internal set; }

Property Value

PDFVisualPage
The PDFVisualPage that owns the annotation.

### Widget

Gets the underlying field widget.

    public PDFFieldWidget Widget { get; }

Property Value

PDFFieldWidget
A object representing the non-visual field widget.