Javascript: CheckFormField Object - TX Text Control DS Server

TX Text Control DS ServerReference GuideJavaScript APICheckFormField Object

The CheckFormField object represents a checkbox in a document. The checkbox can be checked or unchecked through the end-user.

Syntax

JavaScript

CheckFormField

Introduced: X18.

Methods

Method	Description
getBounds	Gets the bounding rectangle of a text field. (Inherited from FormField)
getChecked	Gets a value indicating whether the checkbox is in the checked state.
getCheckedCharacter	Gets the character which is used to display the checkbox in the checked state.
getContainsInputPosition	Returns true, if the Textfield contains the current text input position. (Inherited from FormField)
getDeleteable	Gets whether a text field can be deleted by the end-user while a TX Text Control document is being edited. (Inherited from FormField)
getDoubledInputPosition	Sets whether a text field has a doubled input position in front of its first character and behind its last character. (Inherited from FormField)
getEditable	Gets whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited. (Inherited from FormField)
getEnabled	Gets a value indicating whether the form field is enabled. (Inherited from FormField)
getFormattingBounds	Gets the formatting rectangle of a text field. (Inherited from FormField)
getHighlightColor	Gets the highlight color for the text field. (Inherited from FormField)
getHighlightMode	Gets a value indicating when the text field is highlighted. (Inherited from FormField)
getID	Gets an identifier for a text field. (Inherited from FormField)
getIsSpellCheckingEnabled	Gets whether a text field's text is checked on misspelled words. (Inherited from FormField)
getLength	Gets the number of characters in a text field. (Inherited from FormField)
getName	Relates a user-defined name to a text field. (Inherited from FormField)
getStart	Gets the first character position (one-based) of a text field. (Inherited from FormField)
getText	Gets the text which is contained within a text field. (Inherited from FormField)
getUncheckedCharacter	Gets the character which is used to display the checkbox in the unchecked state.
scrollTo	Sets the current input position to the beginning of a text field and scrolls it into the visible part of the document. (Inherited from FormField)
setChecked	Sets a value indicating whether the checkbox is in the checked state.
setCheckedCharacter	Sets the character which is used to display the checkbox in the checked state.
setDeleteable	Sets whether a text field can be deleted by the end-user while a TX Text Control document is being edited. (Inherited from FormField)
setDoubledInputPosition	Gets whether a text field has a doubled input position in front of its first character and behind its last character. (Inherited from FormField)
setEditable	Sets whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited. (Inherited from FormField)
setEnabled	Sets a value indicating whether the form field is enabled. (Inherited from FormField)
setHighlightColor	Sets the highlight color for the text field. (Inherited from FormField)
setHighlightMode	Sets a value indicating when the text field is highlighted. (Inherited from FormField)
setID	Sets an identifier for the text field. (Inherited from FormField)
setIsSpellCheckingEnabled	Gets whether a text field's text is checked on misspelled words. (Inherited from FormField)
setName	Sets the name of a text field. (Inherited from FormField)
setText	Sets the text which is contained within a text field. (Inherited from FormField)
setUncheckedCharacter	Sets the character which is used to display the checkbox in the unchecked state.