Javascript: TXTextControl.addEventListener Method

Description

The addEventListener function registers event listener functions on the TXTextControl object.

Syntax

<void> TXTextControl.addEventListener(<string> eventName, <function> callback)

Parameters

Examples

The following example shows how to attach an event handler to the "textFieldClicked" event:

function fieldClickedHandler(e) {
    console.log("Field type: " + e.fieldType);
    console.log("Field name: " + e.fieldName);
    console.log("Merge field type: " + e.typeName);
}

TXTextControl.addEventListener("textFieldClicked", fieldClickedHandler);


Possible console output after clicking into a merge field:

> Field type: APPLICATIONFIELD
> Field name: SalesOrderID
> Merge field type: MERGEFIELD

The following example demonstrates TXTextControl.addEventListener in a practical document-editing workflow. The addEventListener function registers event listener functions on the TXTextControl object.

TXTextControl.addEventListener(
    "textControlLoaded",
    function() {
        console.log("add event listener completed.");
    }
);

Further Reading

• TextControl.Web: Adding Custom Ribbon Tabs – May 29, 2015
• Web.TextControl: JQueryUI Alert Boxes and Javascript Events – April 20, 2015