Javascript: TextFieldCollectionBase.getCanAdd Method
Description
Gets a value indicating whether a new text field can be inserted at the current input position.
Syntax
<void> TextFieldCollectionBase.getCanAdd(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])Parameters
| Parameter | Description |
|---|---|
| callback | The callback function that receives the requested value. |
| errorCallback | Optional. Is called when the operation failed with an error. |
Examples
The following example demonstrates TextFieldCollectionBase.getCanAdd in a practical document-editing workflow. It gets a value indicating whether a new text field can be inserted at the current input position.
function onTxError(error) {
console.error("TX Text Control error:", error.msg);
error.handled = true;
}
function inspectCanAdd(textFieldCollectionBase) {
textFieldCollectionBase.getCanAdd(
function(result) {
if (result) {
console.log("get can add is available.");
} else {
console.warn("get can add is not available in the current document state.");
}
},
onTxError
);
}