Javascript: TXTextControl.getTextFields Method
Description
Obsolete. This method will be removed in one of the next versions. Requests a collection of either all text fields the current text part contains or only the text field containing the input position from the server and returns the collection by calling a callback function which has to be provided as a parameter to the function.
Syntax
<void> TXTextControl.getTextFields(<RequestTextFieldsCallback> callback, [<boolean> atInputPosition])Parameters
| Parameter | Description |
|---|---|
| callback | A function with one parameter. Is called with an array of text fields as a parameter containing the requested text fields as soon as the information has been retrieved from the server. |
| atInputPosition | Optional. A boolean value indicating that only the text field containing the input position should be retrieved. If there is no text field at the input position, an empty array is received. |
Examples
The following example demonstrates TXTextControl.getTextFields in a practical document-editing workflow. Obsolete. This method will be removed in one of the next versions. Requests a collection of either all text fields the current text part contains or only the text field containing the input position from the server and returns the collection by calling a callback function which has to be provided as a parameter to the function.
TXTextControl.getTextFields(
function(result) {
if (!result) {
console.warn("No text field was returned.");
return;
}
console.log("get text fields result:", result);
},
true
);