RichEditBuilder.OnCustomCommandExecuted(String) Method

Assigns an event handler to a client event that occurs after a custom command has been executed on the client side.

Namespace: DevExpress.AspNetCore.RichEdit

Assembly: DevExpress.AspNetCore.RichEdit.v19.2.dll

Declaration

public RichEditBuilder OnCustomCommandExecuted(
    string callback
)

Parameters

Name	Type	Description
callback	String	The name of a JavaScript function or the entire JavaScript function code used to handle an event.

Returns

Type	Description
RichEditBuilder	An object that can be used to further configure the Rich Text Editor.

Remarks

The event handler receives an argument of the CustomCommandExecutedEventArgs type. The argument’s properties provide information specific to this event.

JS

function onCustomCommandExecuted(s, e) {
    switch (e.commandName) {
        case 'insertEmailSignature':
            s.document.insertParagraph(s.document.length);
            s.document.insertText(s.document.length, '_________');
            s.document.insertParagraph(s.document.length);
            s.document.insertText(s.document.length, 'Best regards,');
            s.document.insertParagraph(s.document.length);
            s.document.insertText(s.document.length, 'John Smith');
            s.document.insertParagraph(s.document.length);
            s.document.insertText(s.document.length, '[e-mail]');
            s.document.insertParagraph(s.document.length);
            s.document.insertText(s.document.length, '[phone]');
            break;
        case 'sendEmail':
            var text = s.document.getText();
            var mailto_link = 'mailto:[e-mail]?subject=Test&body=' + encodeURIComponent(text);
            window = window.open(mailto_link, 'emailWindow');
            if(window && window.open && !window.closed)
                window.close();
            break;
    }
}

Razor C#

@(Html.DevExpress().RichEdit("DemoRichEdit")
   .Ribbon(ribbon => ribbon
       .Visible(true)
       .ActiveTabIndex(1)
       .Tabs(tabs => {
           tabs.Clear();            
           tabs.Add()
               .Title("Email")
               .Items(items => {
                   items.AddButton()
                       .Text("Insert Email Signature")
                       .CommandName("insertEmailSignature")
                       .ShowText(true)
                       .Icon("user");
                   items.AddButton()
                       .Text("Send Email")
                       .CommandName("sendEmail")
                       .ShowText(true)
                       .Icon("email");
                   items.AddPrintDocumentItem().BeginGroup(true);
                   items.AddDownloadDocumentItem();
               });
       })
   )
   .OnCustomCommandExecuted("onCustomCommandExecuted")
)

For a full example, see Ribbon Customization demo.