Namespaces

Class CKEDITOR.dialog.definition.file

Extends CKEDITOR.dialog.definition.labeledElement.
Defined in: plugins/dialog/dialogDefinition.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	CKEDITOR.dialog.definition.file() The definition of a file upload input.

Field Summary
Field Attributes	Field Name and Description
	action (Optional) The action attribute of the form element associated with this file upload input.
	size The size of the UI element.
	validate (Optional) The validation function.

Fields borrowed from class CKEDITOR.dialog.definition.labeledElement:: controlStyle, inputStyle, label, labelLayout, labelStyle, widths
Fields borrowed from class CKEDITOR.dialog.definition.uiElement:: align, className, commit, id, onHide, onLoad, onShow, setup, style, title, type

Class Detail

CKEDITOR.dialog.definition.file()

Since: 3.0

The definition of 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 file upload elements.

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

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

// There is no constructor for this class, the user just has to define an
// object with the appropriate properties.

// Example:
{
	type : 'file',
	id : 'upload',
	label : 'Select file from your computer',
	size : 38
},
{
	type : 'fileButton',
	id : 'fileId',
	label : 'Upload file',
	'for' : [ 'tab1', 'upload' ]
	filebrowser : {
		onSelect : function( fileUrl, data ) {
			alert( 'Successfully uploaded: ' + fileUrl );
		}
	}
}

Field Detail

{String} action

Since: 3.0

(Optional) The action attribute of the form element associated with this file upload input. If empty, CKEditor will use path to server connector for currently opened folder.

{Number} size

Since: 3.0

The size of the UI element.

{Function} validate

Since: 3.0

(Optional) The validation function.

CKEditor 3 JavaScript API Documentation

Namespaces

Classes

Class CKEDITOR.dialog.definition.file