CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.dialogCommand

class
See source

Generic dialog command. It opens a specific dialog when executed.

// Register the "link" command which opens the "link" dialog.
editor.addCommand( 'link', new CKEDITOR.dialogCommand( 'link' ) );

Filtering

Methods

  • constructor( dialogName, [ ext ] ) → dialogCommand

    Creates a dialogCommand class instance.

    See source

    Parameters

    dialogName : String

    The name of the dialog to open when executing this command.

    [ ext ] : Object

    Additional command definition's properties.

    Properties
    [ tabId ] : String

    You can provide additional property (tabId) if you wish to open the dialog on a specific tabId.

    // Open the dialog on the 'keystroke' tabId.
editor.addCommand( 'keystroke', new CKEDITOR.dialogCommand( 'a11yHelp', { tabId: 'keystroke' } ) );

    Returns

    dialogCommand