Click or drag to resize
Pdftools logo

GeneralTextField Class

A general text field

Inheritance Hierarchy
SystemObject
  PdfTools.Toolbox.InternalNativeBase
    PdfTools.Toolbox.InternalNativeObject
      PdfTools.Toolbox.Pdf.FormsFieldNode
        PdfTools.Toolbox.Pdf.FormsField
          PdfTools.Toolbox.Pdf.FormsTextField
            PdfTools.Toolbox.Pdf.FormsGeneralTextField

Namespace: PdfTools.Toolbox.Pdf.Forms
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.1.0+5820e9ca9ca173983539ffc40abc227fb62e6928
Syntax
C#
public class GeneralTextField : TextField

The GeneralTextField type exposes the following members.

Properties
 NameDescription
Public propertyAlignment

The text alignment


(Inherited from TextField)
Public propertyDisplayName

User interface name

The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.
(Inherited from FieldNode)
Public propertyDoNotExport

Tells whether this field is exported


(Inherited from Field)
Public propertyDoNotScroll

Flags this text field non scrollable

Public propertyDoNotSpellCheck

Flags this text field for prevention from spell checking

Public propertyExportName

The name used when exporting


(Inherited from FieldNode)
Public propertyFontSize

The font size

If then the font size is chosen automatically by the PDF viewer.
(Inherited from TextField)
Public propertyMaxLength

The maximal text length

When setting this property to a non-null value, the length of this field's text is truncated.
Public propertyMultiline

Flags this text field as multi-line

Public propertyPassword

Flags this text field as a password entry field

Public propertyReadOnly

Flags this field as read-only


(Inherited from Field)
Public propertyRequired

Flags this field as mandatory


(Inherited from Field)
Public propertyText

This field's text


(Inherited from TextField)
Public propertyWidgets

This form field's widget annotations


(Inherited from Field)
Top
Methods
 NameDescription
Public methodAddNewWidget

Create a new widget and add to the form field

This method creates a widget for the form field. The widget is automatically added to the field's widgets, but not to any page. This method does not work for radio button form fields; Use AddNewWidget(Rectangle).
(Inherited from Field)
Public methodStatic memberCreate

Create a general text form field

The returned form field object is not yet used, but it is associated with the given target document.
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Top
See Also