CKEditor 4 Documentation

CKEDITOR.dialog.definition.fileButton

Hierarchy

CKEDITOR.dialog.definition.uiElement
CKEDITOR.dialog.definition.fileButton

Files

The definition of a button for submitting the file in a file upload input.

This class is not really part of the API. It just illustrates the properties that developers can use to define and create a button for submitting the file in a file upload input.

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.fileButton object and can be accessed with CKEDITOR.dialog.getContentElement.

For a complete example of dialog definition, please check CKEDITOR.dialog.add.

Defined By

Properties

Horizontal alignment (in container) of the UI element.

Horizontal alignment (in container) of the UI element.

CSS class names to append to the UI element.

CSS class names to append to the UI element.

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.commitContent method is executed. ...

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.commitContent method is executed. It usually takes care of the respective UI element as a standalone element.

CKEDITOR.dialog.definition.fileButton
view source
: String
The instruction for CKEditor how to deal with file upload. ...

The instruction for CKEditor how to deal with file upload. By default, the file and fileButton elements will not work "as expected" if this attribute is not set.

// Update field with id 'txtUrl' in the 'tab1' tab when file is uploaded.
filebrowser: 'tab1:txtUrl'

// Call custom onSelect function when file is successfully uploaded.
filebrowser: {
    onSelect: function( fileUrl, data ) {
        alert( 'Successfully uploaded: ' + fileUrl );
    }
}/Object
CKEDITOR.dialog.definition.fileButton
view source
: String
An array that contains pageId and elementId of the file upload input element for which this button is created. ...

An array that contains pageId and elementId of the file upload input element for which this button is created.

[ pageId, elementId ]

The id of the UI element.

The id of the UI element.

CKEDITOR.dialog.definition.fileButton
view source
: String

The label of the UI element.

The label of the UI element.

Function to execute whenever the UI element's parent dialog is closed.

Function to execute whenever the UI element's parent dialog is closed.

Function to execute the first time the UI element is displayed.

Function to execute the first time the UI element is displayed.

Function to execute whenever the UI element's parent dialog is displayed.

Function to execute whenever the UI element's parent dialog is displayed.

The content that needs to be allowed to enable this UI element. ...

The content that needs to be allowed to enable this UI element. All formats accepted by CKEDITOR.filter.check may be used.

When all UI elements in a tab are disabled, this tab will be disabled automatically.

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.setupContent method is executed. ...

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.setupContent method is executed. It usually takes care of the respective UI element as a standalone element.

Inline CSS classes to append to the UI element.

Inline CSS classes to append to the UI element.

The popup label of the UI element.

The popup label of the UI element.

The type of the UI element. ...

The type of the UI element. Required.

CKEDITOR.dialog.definition.fileButton
view source
: Function

(Optional) The validation function.

(Optional) The validation function.