editor_paste_handler

Client side event handler for ClientSideOnPaste event.

Note: This is a prototype, not a function. You should provide a function that matches this prototype if you wish to handle the corresponding event on the client side. The prototype provides information about the arguments and return value of the function you provide.

Syntax
JavaScript
 editor_paste_handler(editor, text, arg)

Parameters

editor
The editor that triggers the event.
text
The HTML text to be pasted.
arg
Additional argument passed in when Editor.execCommand is called.
Remarks

Use this client side event to provide a JavaScript function to be called when the editor is about to paste text contents. The function can be used to alter the text before it is being pasted.

This function is usually used to perform custom processing on the pasted text. For example, to add a Paste Code button on the toolbar and automatically encloses the pasted text inside a DIV with the DIV's class set to code. This can be achieved by using the following JavaScript function:

JavaScript
function on_toolbar_click_handler(toolBar, toolBarItem)
{
    if (toolBarItem.getCommandName() == "PasteCode")
        Editor1.execCommand("Paste", null, "code");
}

function on_paste_handler(editor, text, arg)
{
    if (format == "code")
        return "<div class='code'>" + text + "</div>";
        
    return null;
}
See Also