CKEditor 4
Report an issue
Class

CKEDITOR.dialogCommand

class

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

Properties

  • value : Object

    It's important for validate functions to be able to accept the value as argument in addition to this.getValue(), so that it is possible to combine validate functions together to make more sophisticated validators.

Methods

  • constructor( dialogName, [ ext ] ) → dialogCommand

    Creates a dialogCommand class instance.

    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