TextBoxField

TextBoxField class

Class representing text box field.

The TextBoxField type exposes the following members:

Constructors

NameDescription
TextBoxField(doc)Initializes a new instance of the TextBoxField class
TextBoxField()Create instance of TextBoxField.
TextBoxField(page, rect)Initializes a new instance of the TextBoxField class
TextBoxField(doc, rect)Initializes a new instance of the TextBoxField class

Properties

NameDescription
vertical_alignmentNone
horizontal_alignmentNone
marginNone
is_first_paragraph_in_columnNone
is_kept_with_nextNone
is_in_new_pageNone
is_in_line_paragraphNone
hyperlinkNone
z_indexNone
update_appearance_on_convertNone
use_font_subsetNone
flagsNone
annotation_typeGets type of annotation.
widthNone
actionsGets the annotation actions.
heightNone
rectGets or sets the field rectangle.
contentsNone
nameNone
modifiedNone
colorNone
borderNone
active_stateNone
characteristicsNone
statesNone
alignmentNone
text_horizontal_alignmentNone
full_nameNone
appearanceNone
page_indexGets index of page which contains this field.
on_activatedAn action which shall be performed when the annotation is activated.
highlightingAnnotation highlighting mode.
parentGets annotation parent.
default_appearanceGets or sets default appearance of the field.
read_onlyGets or sets read only status of the field.
requiredGets or sets required status of the field.
exportableGets or sets exportable flag of the field.
partial_nameGets or sets partial name of the field.
alternate_nameGets or sets alternate name of the field (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).
Alternate name is used as field tooltip in Adobe Acrobat.
mapping_nameGets or sets mapping name of the field that shall be used when exporting interactive form field data from the document.
valueGets or sets value of the field.
is_synchronizedReturns true if dictionary is synchronized.
sync_rootSynchronization object.
is_groupGets or sets boolean value which indicates is this field non-terminal field i.e. group of fields.
annotation_indexGets or sets index of this anotation on the page.
is_shared_fieldProperty for Generator support. Used when field is added to header or footer. If true, this field will created once and it’s appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
fit_into_rectangleIf true then font size will reduced to fit text to specified rectangle.
max_font_sizeMaximail font size which can be used for field contents. -1 to don’t check size.
min_font_sizeMinimal font size which can be used for field contents. -1 to don’t check size.
tab_orderGets or sets tab order of the field.
multilineGets or sets multiline flag of the field. If Multiline is true field can contain multiple lines of text.
spell_checkGets or sets spellcheck flag for field. If true field shall be spell checked.
scrollableGets or sets scrollable flag of field. If true field can be scrolled.
force_combsGets or sets flag which indicates is field divided into spaced positions.
max_lenGets or sets maximum length of text in the field.
text_vertical_alignmentGets or sets text vertical alignment for annotation.

Indexer

NameDescription
[index]Gets subfield contained in this field by index.

Methods

NameDescription
clone()None
get_rectangle(consider_rotation)None
accept(visitor)Accepts visitor.
flatten()Removes this field and place its value directly on the page.
change_after_resize(transform)None
recalculate()Recaculates all calculated fields on the form.
copy_to(array, index)Copies subfields of this field into array starting from specified index.
set_position(point)Set position of the field.
add_image(image)Adds image into the field resources an draws it.
add_barcode(code)Adds barcode 128 into the field.
Field value will be changed onto the code and field become read only.

See Also