Namespace CKEDITOR
This is the API entry point. The entire CKEditor code runs under this object.
Defined in: ckeditor_base.js.
Constructor Attributes | Constructor Name and Description |
---|---|
This is the API entry point.
|
Field Attributes | Field Name and Description |
---|---|
<static> |
CKEDITOR.basePath
Contains the full URL for the CKEditor installation directory.
|
<static> |
CKEDITOR.replaceByClassEnabled
Indicates that CKEditor will attempty to replace all textareas with
class name matching CKEDITOR.replaceClass.
|
<static> |
CKEDITOR.replaceClass
The class name used to identify <textarea> elements to be replace
by CKEditor instances.
|
<static> |
CKEDITOR.status
Indicates the API loading status:
|
Method Attributes | Method Name and Description |
---|---|
<static> |
CKEDITOR.appendTo(element, config)
NO DOCUMENTATION AVAILABLE
|
<static> |
CKEDITOR.create(instanceName, config)
NO DOCUMENTATION AVAILABLE
|
<static> |
CKEDITOR.replace(elementOrIdOrName, config)
Replaces a specific <textarea> with a CKEditor instance.
|
<static> |
CKEDITOR.replaceAll()
Replace all <textarea> elements available in the document with
editor instances.
|
Namespace Detail
CKEDITOR
Since:
3.0
This is the API entry point. The entire CKEditor code runs under this object.
Field Detail
<static>
{string}
CKEDITOR.basePath
Contains the full URL for the CKEditor installation directory.
// Alerts "http://www.example.com/ckeditor/" (e.g.) alert( CKEDITOR.basePath );
- Since:
- 3.0
<static>
{Boolean}
CKEDITOR.replaceByClassEnabled
Indicates that CKEditor will attempty to replace all textareas with
class name matching CKEDITOR.replaceClass.
Defined in: ckeditor_basic.js.
Defined in: ckeditor_basic.js.
// Disable the auto-replace feature. CKEDITOR.replaceByClassEnabled = false;
- Since:
- 3.0
- Default Value:
- true
<static>
{string}
CKEDITOR.replaceClass
The class name used to identify <textarea> elements to be replace
by CKEditor instances.
Defined in: ckeditor_basic.js.
Defined in: ckeditor_basic.js.
CKEDITOR.replaceClass = 'rich_editor';
- Since:
- 3.0
- Default Value:
- 'ckeditor'
<static>
{string}
CKEDITOR.status
Indicates the API loading status:
- unloaded: the API is not yet loaded.
- basic_loaded: the basic API features are available.
- loading: the full API is being loaded.
- ready: the API can be fully used.
if ( CKEDITOR.status == 'ready' ) { // The API can now be fully used. }
- Since:
- 3.0
Method Detail
<static>
CKEDITOR.appendTo(element, config)
NO EXAMPLE AVAILABLE
- Parameters:
- element
- config
- Since:
- 3.0
<static>
CKEDITOR.create(instanceName, config)
NO EXAMPLE AVAILABLE
- Parameters:
- instanceName
- config
- Since:
- 3.0
<static>
{undefined}
CKEDITOR.replace(elementOrIdOrName, config)
Replaces a specific <textarea> with a CKEditor instance.
Defined in: ckeditor_basic.js.
Defined in: ckeditor_basic.js.
<textarea id="myfield" name="myfield"><:/textarea> ... CKEDITOR.replace( 'myfield' );
var textarea = document.body.appendChild( document.createElement( 'textarea' ) ); CKEDITOR.replace( textarea );
- Parameters:
- {object|string} elementOrIdOrName
- The DOM element (textarea), its ID or name.
- {Object} config Optional
- The specific configurations to apply to this editor instance. Configurations set here will override global CKEditor settings.
- Since:
- 3.0
<static>
{undefined}
CKEDITOR.replaceAll()
Replace all <textarea> elements available in the document with
editor instances.
Defined in: ckeditor_basic.js.
Defined in: ckeditor_basic.js.
// Replace all <textarea> elements in the page. CKEDITOR.replaceAll();
// Replace all <textarea class="myClassName"> elements in the page. CKEDITOR.replaceAll( 'myClassName' );
// Selectively replace <textarea> elements, based on custom assertions. CKEDITOR.replaceAll( function( textarea, config ) { // Custom code to evaluate the replace, returning false // if it must not be done. // It also passes the "config" parameter, so the // developer can customize the instance. } );
- Since:
- 3.0