Code Index | File Index



Class CKEDITOR.dialog.definition.html

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

Class Summary
Constructor Attributes Constructor Name and Description
The definition of a raw HTML element.
Field Summary
Field Attributes Field Name and Description
(Required) HTML code of this element.
Fields borrowed from class CKEDITOR.dialog.definition.uiElement:
align, className, commit, id, onHide, onLoad, onShow, setup, style, title, type
Class Detail
Since: 3.0
The definition of a raw HTML element.
This class is not really part of the API. It just illustrates the properties that developers can use to define and create elements made from raw HTML code.

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.html object and can be accessed with CKEDITOR.dialog#getContentElement.
For a complete example of dialog definition, please check CKEDITOR.dialog.add.
To access HTML elements use CKEDITOR.dom.document#getById
// There is no constructor for this class, the user just has to define an
// object with the appropriate properties.

// Example 1:
	type : 'html',
	html : '<h3>This is some sample HTML content.</h3>'
// Example 2:
// Complete sample with document.getById() call when the "Ok" button is clicked.
var dialogDefinition =
	title : 'Sample dialog',
	minWidth : 300,
	minHeight : 200,
	onOk : function() {
		// "this" is now a CKEDITOR.dialog object.
		var document = this.getElement().getDocument();
		// document = CKEDITOR.dom.document
		var element = document.getById( 'myDiv' );
		if ( element )
			alert( element.getHtml() );
	contents : [
			id : 'tab1',
			label : '',
			title : '',
			elements :
					type : 'html',
					html : '<div id="myDiv">Sample <b>text</b>.</div><div id="otherId">Another div.</div>'
	buttons : [ CKEDITOR.dialog.cancelButton, CKEDITOR.dialog.okButton ]
Field Detail
{String} html
Since: 3.0
(Required) HTML code of this element.

Copyright © 2003-2010, CKSource - Frederico Knabben. All rights reserved.