TextField Class

Apitron PDF Kit help
Apitron.PDF.Kit library for .NET
This class represents a text field.
Inheritance Hierarchy

SystemObject
  Apitron.PDF.Kit.FixedLayout.ResourcesResource
    Apitron.PDF.Kit.FixedLayout.ResourcesUndefinedResource
      Apitron.PDF.Kit.Interactive.FormsField
        Apitron.PDF.Kit.Interactive.FormsTerminalField
          Apitron.PDF.Kit.Interactive.FormsTextField

Namespace:  Apitron.PDF.Kit.Interactive.Forms
Assembly:  Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)
Syntax

public sealed class TextField : TerminalField

The TextField type exposes the following members.

Constructors

  NameDescription
Public methodCode exampleTextField
Initializes a new instance of the Object class.
Top
Properties

  NameDescription
Public propertyAdditionalActions
Gets the additional actions.
(Inherited from Field.)
Public propertyAlternateFieldName
Gets or sets an alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes
(Inherited from Field.)
Public propertyBorderColor
Gets or sets the color of the border. The color is an array of numbers that shall be in the range 0.0 to 1.0 specifying the colour of the widget annotation’s border. The number of array elements determines the colour space in which the colour shall bedefined: 0 No colour; transparent 1 DeviceGray 3 DeviceRGB 4 DeviceCMYK
(Inherited from Field.)
Public propertyBorderStyle
Gets or sets the border style.
(Inherited from Field.)
Public propertyCanBeExported
Gets a value indicating whether this instance can be exported.
(Inherited from Resource.)
Public propertyDefaultStyle
Gets or sets the default style.
(Inherited from Field.)
Public propertyDefaultValue
Gets or sets the default text.
Public propertyDoNotScroll
Gets or sets a value indicating whether [do not scroll]. If set, the field shall not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text shall be accepted for interactive form filling; for non-interactive form filling, the filler should take care not to add more character than will visibly fit in the defined area.
Public propertyDoNotSpellCheck
Gets or sets a value indicating whether do not spell check. If set, text entered in the field shall not be spell-checked.
Public propertyFieldName
Gets or sets the partial field name
(Inherited from Field.)
Public propertyFieldNames
Gets the underlying field's names.
(Inherited from Field.)
Public propertyFlags
Gets or sets a set of flags specifying various characteristics of the field.
(Inherited from Field.)
Public propertyFontResourceID
Gets or sets the font resource ID.
(Inherited from Field.)
Public propertyFontSize
Gets or sets the size of the font.
(Inherited from Field.)
Public propertyIsComb
Gets or sets a value indicating whether this instance is comb. May be set only if the MaxLen entry is present in the text field and if the Multiline, Password, and FileSelect flags are clear. If set, the field shall be automatically divided into as many equally spaced positions, or combs, as the value of MaxLen, and the text is laid out into those combs.
Public propertyIsFileSelect
Gets or sets a value indicating whether this instance is file select. If set, the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field.
Public propertyIsMultiline
Gets or sets a value indicating whether this instance is multiline. If set, the field may contain multiple lines of text; if clear, the field’s text shall be restricted to a single line.
Public propertyIsPassword
Gets or sets a value indicating whether this instance is password. If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard shall instead be echoed in some unreadable form, such as asterisks or bullet characters.
Public propertyIsReadOnly
Gets or sets a value indicating whether this instance is read only.
(Inherited from Field.)
Public propertyItem
Gets the underlying Field with the specified field name.
(Inherited from Field.)
Public propertyMappingName
Gets or sets the mapping name that shall be used when exporting interactive form field data from the document.
(Inherited from Field.)
Public propertyMaxLen
Gets or sets the maximum length of the field’s text, in characters.
Public propertyQuaddingJustification
Gets or sets the quadding justification.
(Inherited from Field.)
Public propertyResourceType
Gets the resource type.
(Inherited from Resource.)
Public propertyRichTextString
Gets or sets the rich text string.
(Inherited from Field.)
Public propertyText
Gets or sets the text of the field.
Public propertyTextColor
Gets or sets the color of the text.
(Inherited from Field.)
Public propertyViewColor
Gets or sets the color of the view. The color is an array of numbers that shall be in the range 0.0 to 1.0 specifying the colour of the widget annotation’s border. The number of array elements determines the colour space in which the colour shall bedefined: 0 No colour; transparent 1 DeviceGray 3 DeviceRGB 4 DeviceCMYK
(Inherited from Field.)
Public propertyViews
Gets or sets the children.
(Inherited from TerminalField.)
Top
Methods

  NameDescription
Public methodFlatten
Flattens this instance and removes from fields collection.
(Inherited from TerminalField.)
Top
See Also

Reference