Apitron.PDF.Kit library for .NET
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
Assembly: Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)
Top
Top
Top
This class represents a text field.
Inheritance Hierarchy
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
The TextField type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() ![]() | TextField |
Initializes a new instance of the Object class.
|
Properties
Name | Description | |
---|---|---|
![]() | AdditionalActions |
Gets the additional actions.
(Inherited from Field.) |
![]() | AlternateFieldName |
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.) |
![]() | BorderColor |
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.) |
![]() | BorderStyle |
Gets or sets the border style.
(Inherited from Field.) |
![]() | CanBeExported |
Gets a value indicating whether this instance can be exported.
(Inherited from Resource.) |
![]() | DefaultStyle |
Gets or sets the default style.
(Inherited from Field.) |
![]() | DefaultValue |
Gets or sets the default text.
|
![]() | DoNotScroll |
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.
|
![]() | DoNotSpellCheck |
Gets or sets a value indicating whether do not spell check.
If set, text entered in the field shall not be spell-checked.
|
![]() | FieldName |
Gets or sets the partial field name
(Inherited from Field.) |
![]() | FieldNames |
Gets the underlying field's names.
(Inherited from Field.) |
![]() | Flags |
Gets or sets a set of flags specifying various characteristics of the field.
(Inherited from Field.) |
![]() | FontResourceID |
Gets or sets the font resource ID.
(Inherited from Field.) |
![]() | FontSize |
Gets or sets the size of the font.
(Inherited from Field.) |
![]() | IsComb |
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.
|
![]() | IsFileSelect |
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.
|
![]() | IsMultiline |
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.
|
![]() | IsPassword |
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.
|
![]() | IsReadOnly |
Gets or sets a value indicating whether this instance is read only.
(Inherited from Field.) |
![]() | Item |
Gets the underlying Field with the specified field name.
(Inherited from Field.) |
![]() | MappingName |
Gets or sets the mapping name that shall be used when exporting interactive form field data from the document.
(Inherited from Field.) |
![]() | MaxLen |
Gets or sets the maximum length of the field’s text, in characters.
|
![]() | QuaddingJustification |
Gets or sets the quadding justification.
(Inherited from Field.) |
![]() | ResourceType |
Gets the resource type.
(Inherited from Resource.) |
![]() | RichTextString |
Gets or sets the rich text string.
(Inherited from Field.) |
![]() | Text |
Gets or sets the text of the field.
|
![]() | TextColor |
Gets or sets the color of the text.
(Inherited from Field.) |
![]() | ViewColor |
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.) |
![]() | Views |
Gets or sets the children.
(Inherited from TerminalField.) |
Methods
Name | Description | |
---|---|---|
![]() | Flatten |
Flattens this instance and removes from fields collection.
(Inherited from TerminalField.) |
See Also