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

CKEDITOR.dialog.definitionObject

classprivate
See source

This class is not really part of the API. It is the definition property value passed to dialogDefinition event handlers.

CKEDITOR.on( 'dialogDefinition', function( evt ) {
    var definition = evt.data.definition;
    var content = definition.getContents( 'page1' );
        // ...
} );

Filtering

Properties

  • buttons : Array

    See source

    The buttons in the dialog, defined as an array of CKEDITOR.dialog.definition.button objects.

    Defaults to [ CKEDITOR.dialog.okButton, CKEDITOR.dialog.cancelButton ]

  • contents : Array

    See source

    The contents in the dialog, defined as an array of CKEDITOR.dialog.definition.content objects. Required.

  • since 3.5.3

    height : Number

    See source

    The initial height of the dialog, in pixels.

    Defaults to CKEDITOR.dialog.definition.minHeight

  • minHeight : Number

    See source

    The minimum height of the dialog, in pixels.

    Defaults to 400

  • minWidth : Number

    See source

    The minimum width of the dialog, in pixels.

    Defaults to 600

  • onCancel : Function

    See source

    The function to execute when the "Cancel" button is pressed.

  • onHide : Function

    See source

    The function executed every time the dialog is closed.

  • onLoad : Function

    See source

    The function to execute when the dialog is displayed for the first time.

  • onOk : Function

    See source

    The function to execute when the "OK" button is pressed.

  • onShow : Function

    See source

    The function to execute when the dialog is loaded (executed every time the dialog is opened).

  • resizable : Number

    See source

    How the dialog can be resized, must be one of the four contents defined below.

    Defaults to CKEDITOR.DIALOG_RESIZE_NONE

  • title : String

    See source

    The dialog title, displayed in the dialog's header. Required.

  • since 3.5.3

    width : Number

    See source

    The initial width of the dialog, in pixels.

    Defaults to CKEDITOR.dialog.definition#minWidth

Methods