Report an issue
Class

CKEDITOR.dialog.definition.fileButton

class

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.

Filtering

Properties

  • align : String

    Horizontal alignment (in the container) of the UI element.

  • className : String

    CSS class names to append to the UI element.

  • commit : Function

    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.

  • filebrowser : String

    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
    
  • for : String

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

    [ pageId, elementId ]
    
  • id : String

    The ID of the UI element.

  • label : String

    The label of the UI element.

  • onHide : Function

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

  • onLoad : Function

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

  • onShow : Function

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

  • requiredContent : String | Object | style

    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.

  • setup : Function

    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.

  • style : String

    Inline CSS classes to append to the UI element.

  • title : String

    The popup label of the UI element.

  • type : String

    The type of the UI element. Required.

  • validate : Function

    (Optional) The validation function.