RibbonButtonItemBuilder.CommandName(String) Method

Sets the command name associated with the item.

Namespace: DevExpress.AspNetCore.Office

Assembly: DevExpress.AspNetCore.Common.v24.1.dll

NuGet Package: DevExpress.AspNetCore.Common

Declaration

public RibbonButtonItemBuilder CommandName(
    string value
)

Parameters

Name	Type	Description
value	String	The command name.

Returns

Type	Description
RibbonButtonItemBuilder	An object that can be used to further configure the ribbon item.

Remarks

For a full example, see Ribbon Customization demo.

Razor C#

@(Html.DevExpress().RichEdit("richEdit")
    .Ribbon(ribbon => ribbon
        .Visible(true)
        .ActiveTabIndex(1)
        .Tabs(tabs => {
            tabs.Clear();
            tabs.AddHomeTab()
            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")
)

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;
    }
}