ApplicationField Object
Description
The ApplicationField object supports text field formats of applications such as Microsoft Word. The object only provides an interface to retrieve and change the data and parameters of such fields. The field logic itself is not implemented. Currently supported applications and components are Microsoft Word and Heiler HeighEdit.
Syntax
ApplicationFieldExamples
The following example demonstrates ApplicationField in a practical document-editing workflow. The ApplicationField object supports text field formats of applications such as Microsoft Word. The object only provides an interface to retrieve and change the data and parameters of such fields. The field logic itself is not implemented. Currently supported applications and components are Microsoft Word and Heiler HeighEdit.
function onTxError(error) {
console.error("TX Text Control error:", error.msg);
error.handled = true;
}
TXTextControl.textParts.getMainText(function(mainText) {
const applicationFields = mainText.applicationFields;
applicationFields.getItem(function(applicationField) {
if (!applicationField) {
console.warn("No application field is available at the current input position.");
return;
}
applicationField.getFormat(
function(result) {
console.log("get format result:", result);
},
onTxError
);
}, onTxError);
}, onTxError);Members
Methods
| Method | Description |
|---|---|
| getBounds | Gets the bounding rectangle of a text field. (Inherited from TextField.) |
| getContainsInputPosition | Returns true, if the Textfield contains the current text input position. (Inherited from TextField.) |
| getDeleteable | Gets whether a text field can be deleted by the end-user while a TX Text Control document is being edited. (Inherited from TextField.) |
| getDoubledInputPosition | Sets whether a text field has a doubled input position in front of its first character and behind its last character. (Inherited from TextField.) |
| 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 TextField.) |
| getFormat | Gets the field's format. |
| getFormattingBounds | Gets the formatting rectangle of a text field. (Inherited from TextField.) |
| getHighlightColor | Gets the highlight color for the text field. (Inherited from TextField.) |
| getHighlightMode | Gets a value indicating when the text field is highlighted. (Inherited from TextField.) |
| getID | Gets an identifier for a text field. (Inherited from TextField.) |
| getIsSpellCheckingEnabled | Gets whether a text field's text is checked on misspelled words. (Inherited from TextField.) |
| getLength | Gets the number of characters in a text field. (Inherited from TextField.) |
| getName | Relates a user-defined name to a text field. (Inherited from TextField.) |
| getParameters | Gets the field' parameters. The order and format of the strings depend on the field's format. For example a Microsoft Word MergeField has the following format: MERGEFIELD FieldName [switches]. In this case the first string of the array is the FieldName and the following strings are possible switches. The string MERGEFIELD is the type name of the field and can be obtained through getTypeName. If a field has no parameters, this array is null. |
| getStart | Gets the first character position (one-based) of a text field. (Inherited from TextField.) |
| getText | Gets the text which is contained within a text field. (Inherited from TextField.) |
| getTypeName | Gets the field's type name. The type name of a Microsoft Word MergeField is MERGEFIELD, for example. If the type name of the field is changed, its parameters must also be changed. |
| 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 TextField.) |
| setDeleteable | Sets whether a text field can be deleted by the end-user while a TX Text Control document is being edited. (Inherited from TextField.) |
| setDoubledInputPosition | Gets whether a text field has a doubled input position in front of its first character and behind its last character. (Inherited from TextField.) |
| 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 TextField.) |
| setFormat | Sets the field's format. |
| setHighlightColor | Sets the highlight color for the text field. (Inherited from TextField.) |
| setHighlightMode | Sets a value indicating when the text field is highlighted. (Inherited from TextField.) |
| setID | Sets an identifier for the text field. (Inherited from TextField.) |
| setIsSpellCheckingEnabled | Gets whether a text field's text is checked on misspelled words. (Inherited from TextField.) |
| setName | Sets the name of a text field. (Inherited from TextField.) |
| setParameters | Sets the field's parameters. |
| setText | Sets the text which is contained within a text field. (Inherited from TextField.) |
| setTypeName | Sets the field's type name. The type name of a Microsoft Word MergeField is MERGEFIELD, for example. If the type name of the field is changed, its parameters must also be changed. |