Javascript: FrameBase.setName Method — TX Text Control .NET Server

Description

Sets a name for the frame. An empty string indicates that the frame has no name. An empty string can also be used to delete a previously set name.

Syntax

<void> FrameBase.setName(<string> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
value	The new property value.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates FrameBase.setName in a practical document-editing workflow. It sets a name for the frame. An empty string indicates that the frame has no name. An empty string can also be used to delete a previously set name.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

function configureName(frameBase) {
    frameBase.setName(
        "Quarterly report",
        function() {
            console.log("set name completed.");
        },
        onTxError
    );
}