Namespace CKEDITOR.config

Defined in: core/config.js.

Namespace Summary
Constructor Attributes	Constructor Name and Description
	CKEDITOR.config Holds the default configuration settings.

Field Summary
Field Attributes	Field Name and Description
<static>	CKEDITOR.config.autoGrow_maxHeight The maximum height to which the editor can reach using AutoGrow.
<static>	CKEDITOR.config.autoGrow_minHeight The minimum height to which the editor can reach using AutoGrow.
<static>	CKEDITOR.config.autoUpdateElement Whether the replaced element (usually a textarea) is to be updated automatically when posting the form containing the editor.
<static>	CKEDITOR.config.baseFloatZIndex The base Z-index for floating dialogs and popups.
<static>	CKEDITOR.config.baseHref The base href URL used to resolve relative and absolute URLs in the editor content.
<static>	CKEDITOR.config.blockedKeystrokes A list of keystrokes to be blocked if not defined in the CKEDITOR.config.keystrokes setting.
<static>	CKEDITOR.config.bodyClass Sets the "class" attribute to be used on the body element of the editing area.
<static>	CKEDITOR.config.bodyId Sets the "id" attribute to be used on the body element of the editing area.
<static>	CKEDITOR.config.browserContextMenuOnCtrl Whether to show the browser native context menu when the CTRL or the META (Mac) key is pressed while opening the context menu.
<static>	CKEDITOR.config.colorButton_backStyle Holds the style definition to be used to apply the text background color.
<static>	CKEDITOR.config.colorButton_colors Defines the colors to be displayed in the color selectors.
<static>	CKEDITOR.config.colorButton_enableMore Whether to enable the "More Colors.
<static>	CKEDITOR.config.colorButton_foreStyle Holds the style definition to be used to apply the text foreground color.
<static>	CKEDITOR.config.contentsCss The CSS file(s) to be used to apply style to the contents.
<static>	CKEDITOR.config.contentsLangDirection The writting direction of the language used to write the editor contents.
<static>	CKEDITOR.config.contentsLanguage Language code of the writting language which is used to author the editor contents.
<static>	CKEDITOR.config.corePlugins A comma separated list of plugins that are not related to editor instances.
<static>	CKEDITOR.config.coreStyles_bold The style definition to be used to apply the bold style in the text.
<static>	CKEDITOR.config.coreStyles_italic The style definition to be used to apply the italic style in the text.
<static>	CKEDITOR.config.coreStyles_strike The style definition to be used to apply the strike style in the text.
<static>	CKEDITOR.config.coreStyles_subscript The style definition to be used to apply the subscript style in the text.
<static>	CKEDITOR.config.coreStyles_superscript The style definition to be used to apply the superscript style in the text.
<static>	CKEDITOR.config.coreStyles_underline The style definition to be used to apply the underline style in the text.
<static>	CKEDITOR.config.customConfig The URL path for the custom configuration file to be loaded.
<static>	CKEDITOR.config.defaultLanguage The language to be used if CKEDITOR.config.language is left empty and it's not possible to localize the editor to the user language.
<static>	CKEDITOR.config.dialog_backgroundCoverColor The color of the dialog background cover.
<static>	CKEDITOR.config.dialog_backgroundCoverOpacity The opacity of the dialog background cover.
<static>	CKEDITOR.config.dialog_magnetDistance The distance of magnetic borders used in moving and resizing dialogs, measured in pixels.
<static>	CKEDITOR.config.dialog_startupFocusTab If the dialog has more than one tab, put focus into the first tab as soon as dialog is opened.
<static>	CKEDITOR.config.disableNativeSpellChecker Disables the built-in spell checker while typing natively available in the browser (currently Firefox and Safari only).
<static>	CKEDITOR.config.disableNativeTableHandles Disables the "table tools" offered natively by the browser (currently Firefox only) to make quick table editing operations, like adding or deleting rows and columns.
<static>	CKEDITOR.config.disableObjectResizing Disables the ability of resize objects (image and tables) in the editing area.
<static>	CKEDITOR.config.docType Sets the doctype to be used when loading the editor content as HTML.
<static>	CKEDITOR.config.editingBlock Whether to render or not the editing block area in the editor interface.
<static>	CKEDITOR.config.emailProtection The e-mail address anti-spam protection option.
<static>	CKEDITOR.config.enableTabKeyTools Allow context-sensitive tab key behaviors, including the following scenarios: When selection is anchored inside table cells: If TAB is pressed, select the contents of the "next" cell.
<static>	CKEDITOR.config.enterMode Sets the behavior for the ENTER key.
<static>	CKEDITOR.config.entities Whether to use HTML entities in the output.
<static>	CKEDITOR.config.entities_additional An additional list of entities to be used.
<static>	CKEDITOR.config.entities_greek Whether to convert some symbols, mathematical symbols, and Greek letters to HTML entities.
<static>	CKEDITOR.config.entities_latin Whether to convert some Latin characters (Latin alphabet No. 1, ISO 8859-1) to HTML entities.
<static>	CKEDITOR.config.entities_processNumerical Whether to convert all remaining characters, not comprised in the ASCII character table, to their relative decimal numeric representation of HTML entity.
<static>	CKEDITOR.config.extraPlugins List of additional plugins to be loaded.
<static>	CKEDITOR.config.filebrowserBrowseUrl The location of an external file browser, that should be launched when "Browse Server" button is pressed.
<static>	CKEDITOR.config.filebrowserFlashBrowseUrl The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Flash dialog.
<static>	CKEDITOR.config.filebrowserFlashUploadUrl The location of a script that handles file uploads in the Flash dialog.
<static>	CKEDITOR.config.filebrowserImageBrowseLinkUrl The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Link tab of Image dialog.
<static>	CKEDITOR.config.filebrowserImageBrowseUrl The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Image dialog.
<static>	CKEDITOR.config.filebrowserImageUploadUrl The location of a script that handles file uploads in the Image dialog.
<static>	CKEDITOR.config.filebrowserUploadUrl The location of a script that handles file uploads.
<static>	CKEDITOR.config.filebrowserWindowFeatures The "features" to use in the file browser popup window.
<static>	CKEDITOR.config.find_highlight Defines the style to be used to highlight results with the find dialog.
<static>	CKEDITOR.config.font_defaultLabel The text to be displayed in the Font combo is none of the available values matches the current cursor position or text selection.
<static>	CKEDITOR.config.font_names The list of fonts names to be displayed in the Font combo in the toolbar.
<static>	CKEDITOR.config.font_style The style definition to be used to apply the font in the text.
<static>	CKEDITOR.config.fontSize_defaultLabel The text to be displayed in the Font Size combo is none of the available values matches the current cursor position or text selection.
<static>	CKEDITOR.config.fontSize_sizes The list of fonts size to be displayed in the Font Size combo in the toolbar.
<static>	CKEDITOR.config.fontSize_style The style definition to be used to apply the font size in the text.
<static>	CKEDITOR.config.forceEnterMode Force the respect of CKEDITOR.config.enterMode as line break regardless of the context, E.g.
<static>	CKEDITOR.config.forcePasteAsPlainText Whether to force all pasting operations to insert on plain text into the editor, loosing any formatting information possibly available in the source text.
<static>	CKEDITOR.config.forceSimpleAmpersand Whether to force using "&" instead of "&" in elements attributes values.
<static>	CKEDITOR.config.format_address The style definition to be used to apply the "Address" format.
<static>	CKEDITOR.config.format_div The style definition to be used to apply the "Normal (DIV)" format.
<static>	CKEDITOR.config.format_h1 The style definition to be used to apply the "Heading 1" format.
<static>	CKEDITOR.config.format_h2 The style definition to be used to apply the "Heading 1" format.
<static>	CKEDITOR.config.format_h3 The style definition to be used to apply the "Heading 1" format.
<static>	CKEDITOR.config.format_h4 The style definition to be used to apply the "Heading 1" format.
<static>	CKEDITOR.config.format_h5 The style definition to be used to apply the "Heading 1" format.
<static>	CKEDITOR.config.format_h6 The style definition to be used to apply the "Heading 1" format.
<static>	CKEDITOR.config.format_p The style definition to be used to apply the "Normal" format.
<static>	CKEDITOR.config.format_pre The style definition to be used to apply the "Formatted" format.
<static>	CKEDITOR.config.format_tags A list of semi colon separated style names (by default tags) representing the style definition for each entry to be displayed in the Format combo in the toolbar.
<static>	CKEDITOR.config.fullPage Indicates whether the contents to be edited are being inputted as a full HTML page.
<static>	CKEDITOR.config.height The height of editing area( content ), in relative or absolute, e.g.
<static>	CKEDITOR.config.htmlEncodeOutput Whether escape HTML when editor update original input element.
<static>	CKEDITOR.config.ignoreEmptyParagraph Whether the editor must output an empty value ("") if it's contents is made by an empty paragraph only.
<static>	CKEDITOR.config.image_previewText Padding text to set off the image in preview area.
<static>	CKEDITOR.config.image_removeLinkByEmptyURL Whether to remove links when emptying the link URL field in the image dialog.
<static>	CKEDITOR.config.keystrokes A list associating keystrokes to editor commands.
<static>	CKEDITOR.config.language The user interface language localization to use.
<static>	CKEDITOR.config.menu_groups A comma separated list of items group names to be displayed in the context menu.
<static>	CKEDITOR.config.menu_subMenuDelay The amount of time, in milliseconds, the editor waits before showing submenu options when moving the mouse over options that contains submenus, like the "Cell Properties" entry for tables.
<static>	CKEDITOR.config.newpage_html The HTML to load in the editor when the "new page" command is executed.
<static>	CKEDITOR.config.pasteFromWordCleanupFile The file that provides the MS Word cleanup function for pasting operations.
<static>	CKEDITOR.config.pasteFromWordNumberedHeadingToList Whether to transform MS Word outline numbered headings into lists.
<static>	CKEDITOR.config.pasteFromWordPromptCleanup Whether to prompt the user about the clean up of content being pasted from MS Word.
<static>	CKEDITOR.config.pasteFromWordRemoveFontStyles Whether to ignore all font related formatting styles, including: font size; font family; font foreground/background color.
<static>	CKEDITOR.config.pasteFromWordRemoveStyles Whether to remove element styles that can't be managed with the editor.
<static>	CKEDITOR.config.plugins Comma separated list of plugins to load and initialize for an editor instance.
<static>	CKEDITOR.config.protectedSource List of regular expressions to be executed over the input HTML, indicating code that must stay untouched.
<static>	CKEDITOR.config.removeFormatAttributes A comma separated list of elements attributes to be removed when executing the "remove format" command.
<static>	CKEDITOR.config.removeFormatTags A comma separated list of elements to be removed when executing the "remove " format" command.
<static>	CKEDITOR.config.removePlugins List of plugins that must not be loaded.
<static>	CKEDITOR.config.resize_dir The directions to which the editor resizing is enabled.
<static>	CKEDITOR.config.resize_enabled Whether to enable the resizing feature.
<static>	CKEDITOR.config.resize_maxHeight The maximum editor height, in pixels, when resizing it with the resize handle.
<static>	CKEDITOR.config.resize_maxWidth The maximum editor width, in pixels, when resizing it with the resize handle.
<static>	CKEDITOR.config.resize_minHeight The minimum editor height, in pixels, when resizing it with the resize handle.
<static>	CKEDITOR.config.resize_minWidth The minimum editor width, in pixels, when resizing it with the resize handle.
<static>	CKEDITOR.config.scayt_autoStartup If enabled (true), turns on SCAYT automatically after loading the editor.
<static>	CKEDITOR.config.scayt_contextCommands Customizes the display of SCAYT context menu commands ("Add Word", "Ignore" and "Ignore All").
<static>	CKEDITOR.config.scayt_contextMenuItemsOrder Define order of placing of SCAYT context menu items by groups.
<static>	CKEDITOR.config.scayt_customDictionaryIds Links SCAYT to custom dictionaries.
<static>	CKEDITOR.config.scayt_customerid Sets the customer ID for SCAYT.
<static>	CKEDITOR.config.scayt_maxSuggestions Defines the number of SCAYT suggestions to show in the main context menu.
<static>	CKEDITOR.config.scayt_moreSuggestions Enables/disables the "More Suggestions" sub-menu in the context menu.
<static>	CKEDITOR.config.scayt_sLang Sets the default spellchecking language for SCAYT.
<static>	CKEDITOR.config.scayt_srcUrl Set the URL to SCAYT core.
<static>	CKEDITOR.config.scayt_uiTabs Sets the visibility of the SCAYT tabs in the settings dialog and toolbar button.
<static>	CKEDITOR.config.scayt_userDictionaryName Makes it possible to activate a custom dictionary on SCAYT.
<static>	CKEDITOR.config.shiftEnterMode Just like the CKEDITOR.config.enterMode setting, it defines the behavior for the SHIFT+ENTER key.
<static>	CKEDITOR.config.skin The skin to load.
<static>	CKEDITOR.config.smiley_columns The number of columns to be generated by the smilies matrix.
<static>	CKEDITOR.config.smiley_descriptions The description to be used for each of the smileys defined in the CKEDITOR.config.smiley_images setting.
<static>	CKEDITOR.config.smiley_images The file names for the smileys to be displayed.
<static>	CKEDITOR.config.smiley_path The base path used to build the URL for the smiley images.
<static>	CKEDITOR.config.startupFocus Sets whether the editor should have the focus when the page loads.
<static>	CKEDITOR.config.startupMode The mode to load at the editor startup.
<static>	CKEDITOR.config.startupOutlineBlocks Whether to automaticaly enable the "show block" command when the editor loads.
<static>	CKEDITOR.config.stylesSet The "styles definition set" to use in the editor.
<static>	CKEDITOR.config.tabIndex The editor tabindex value.
<static>	CKEDITOR.config.tabSpaces Intructs the editor to add a number of spaces ( ) to the text when hitting the TAB key.
<static>	CKEDITOR.config.templates The templates definition set to use.
<static>	CKEDITOR.config.templates_files The list of templates definition files to load.
<static>	CKEDITOR.config.templates_replaceContent Whether the "Replace actual contents" checkbox is checked by default in the Templates dialog.
<static>	CKEDITOR.config.theme The theme to be used to build the UI.
<static>	CKEDITOR.config.toolbar The toolbox (alias toolbar) definition.
<static>	CKEDITOR.config.toolbar_Basic The toolbar definition.
<static>	CKEDITOR.config.toolbar_Full This is the default toolbar definition used by the editor.
<static>	CKEDITOR.config.toolbarCanCollapse Whether the toolbar can be collapsed by the user.
<static>	CKEDITOR.config.toolbarLocation The "theme space" to which rendering the toolbar.
<static>	CKEDITOR.config.toolbarStartupExpanded Whether the toolbar must start expanded when the editor is loaded.
<static>	CKEDITOR.config.undoStackSize The number of undo steps to be saved.
<static>	CKEDITOR.config.useComputedState Indicates that some of the editor features, like alignement and text direction, should used the "computed value" of the feature to indicate it's on/off state, instead of using the "real value".
<static>	CKEDITOR.config.width The editor width in CSS size format or pixel integer.

Namespace Detail

CKEDITOR.config

Since: 3.0

Holds the default configuration settings. Changes to this object are reflected in all editor instances, if not specificaly specified for those instances.

// All editor created after the following setting will not load custom
// configuration files.
CKEDITOR.config.customConfig = '';

Field Detail

<static> {Number} CKEDITOR.config.autoGrow_maxHeight

Since: 3.4

The maximum height to which the editor can reach using AutoGrow. Zero means unlimited.
Defined in: plugins/autogrow/plugin.js.

config.autoGrow_maxHeight = 400;

Default Value:: 0

<static> {Number} CKEDITOR.config.autoGrow_minHeight

Since: 3.4

The minimum height to which the editor can reach using AutoGrow.
Defined in: plugins/autogrow/plugin.js.

config.autoGrow_minHeight = 300;

Default Value:: 200

<static> {Boolean} CKEDITOR.config.autoUpdateElement

Since: 3.0

Whether the replaced element (usually a textarea) is to be updated automatically when posting the form containing the editor.

config.autoUpdateElement = true;

Default Value:: true

<static> {Number} CKEDITOR.config.baseFloatZIndex

Since: 3.0

The base Z-index for floating dialogs and popups.

config.baseFloatZIndex = 2000

Default Value:: 10000

<static> {String} CKEDITOR.config.baseHref

Since: 3.0

The base href URL used to resolve relative and absolute URLs in the editor content.

config.baseHref = 'http://www.example.com/path/';

Default Value:: '' (empty string)

<static> {Array} CKEDITOR.config.blockedKeystrokes

Since: 3.0

A list of keystrokes to be blocked if not defined in the CKEDITOR.config.keystrokes setting. In this way it is possible to block the default browser behavior for those keystrokes.
Defined in: plugins/keystrokes/plugin.js.

// This is actually the default value.
config.blockedKeystrokes =
[
    CKEDITOR.CTRL + 66 /*B*/,
    CKEDITOR.CTRL + 73 /*I*/,
    CKEDITOR.CTRL + 85 /*U*/
];

Default Value:: (see example)

<static> {String} CKEDITOR.config.bodyClass

Since: 3.1

Sets the "class" attribute to be used on the body element of the editing area.

NO EXAMPLE AVAILABLE

Default Value:: ''

<static> {String} CKEDITOR.config.bodyId

Since: 3.1

Sets the "id" attribute to be used on the body element of the editing area.

NO EXAMPLE AVAILABLE

Default Value:: ''

<static> {Boolean} CKEDITOR.config.browserContextMenuOnCtrl

Since: 3.0.2

Whether to show the browser native context menu when the CTRL or the META (Mac) key is pressed while opening the context menu.
Defined in: plugins/contextmenu/plugin.js.

config.browserContextMenuOnCtrl = false;

Default Value:: true

<static> {Object} CKEDITOR.config.colorButton_backStyle

Since: 3.0

Holds the style definition to be used to apply the text background color.
Defined in: plugins/colorbutton/plugin.js.

// This is basically the default setting value.
config.colorButton_backStyle =
    {
        element : 'span',
        styles : { 'background-color' : '#(color)' }
    };

<static> {String} CKEDITOR.config.colorButton_colors

Since: 3.0

Defines the colors to be displayed in the color selectors. It's a string containing the hexadecimal notation for HTML colors, without the "#" prefix. Since 3.3: A name may be optionally defined by prefixing the entries with the name and the slash character. For example, "FontColor1/FF9900" will be displayed as the color #FF9900 in the selector, but will be outputted as "FontColor1".
Defined in: plugins/colorbutton/plugin.js.

// Brazil colors only.
config.colorButton_colors = '00923E,F8C100,28166F';

config.colorButton_colors = 'FontColor1/FF9900,FontColor2/0066CC,FontColor3/F00'

Default Value:: '000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,B22222,A52A2A,DAA520,006400,40E0D0,0000CD,800080,808080,F00,FF8C00,FFD700,008000,0FF,00F,EE82EE,A9A9A9,FFA07A,FFA500,FFFF00,00FF00,AFEEEE,ADD8E6,DDA0DD,D3D3D3,FFF0F5,FAEBD7,FFFFE0,F0FFF0,F0FFFF,F0F8FF,E6E6FA,FFF'

<static> {Boolean} CKEDITOR.config.colorButton_enableMore

Since: 3.0

Whether to enable the "More Colors..." button in the color selectors.
Defined in: plugins/colorbutton/plugin.js.

config.colorButton_enableMore = false;

Default Value:: false

<static> {Object} CKEDITOR.config.colorButton_foreStyle

Since: 3.0

Holds the style definition to be used to apply the text foreground color.
Defined in: plugins/colorbutton/plugin.js.

// This is basically the default setting value.
config.colorButton_foreStyle =
    {
        element : 'span',
        styles : { 'color' : '#(color)' }
    };

<static> {String|Array} CKEDITOR.config.contentsCss

Since: 3.0

The CSS file(s) to be used to apply style to the contents. It should reflect the CSS used in the final pages where the contents are to be used.

config.contentsCss = '/css/mysitestyles.css';
config.contentsCss = ['/css/mysitestyles.css', '/css/anotherfile.css'];

Default Value:: '<CKEditor folder>/contents.css'

<static> {String} CKEDITOR.config.contentsLangDirection

Since: 3.0

The writting direction of the language used to write the editor contents. Allowed values are:

'ui' - which indicate content direction will be the same with the user interface language direction;
'ltr' - for Left-To-Right language (like English);
'rtl' - for Right-To-Left languages (like Arabic).

config.contentsLangDirection = 'rtl';

Default Value:: 'ui'

<static> {String} CKEDITOR.config.contentsLanguage

Since: 3.0

Language code of the writting language which is used to author the editor contents.

config.contentsLanguage = 'fr';

Default Value:: Same value with editor's UI language.

<static> {String} CKEDITOR.config.corePlugins

Since: 3.0

A comma separated list of plugins that are not related to editor instances. Reserved to plugins that extend the core code only.

There are no ways to override this setting, except by editing the source code of CKEditor (_source/core/config.js).

<static> {Object} CKEDITOR.config.coreStyles_bold

Since: 3.0

The style definition to be used to apply the bold style in the text.
Defined in: plugins/basicstyles/plugin.js.

config.coreStyles_bold = { element : 'b', overrides : 'strong' };

config.coreStyles_bold = { element : 'span', attributes : {'class': 'Bold'} };

<static> {Object} CKEDITOR.config.coreStyles_italic

Since: 3.0

The style definition to be used to apply the italic style in the text.
Defined in: plugins/basicstyles/plugin.js.

config.coreStyles_italic = { element : 'i', overrides : 'em' };

CKEDITOR.config.coreStyles_italic = { element : 'span', attributes : {'class': 'Italic'} };

<static> {Object} CKEDITOR.config.coreStyles_strike

Since: 3.0

The style definition to be used to apply the strike style in the text.
Defined in: plugins/basicstyles/plugin.js.

CKEDITOR.config.coreStyles_strike = { element : 'span', attributes : {'class': 'StrikeThrough'}, overrides : 'strike' };

<static> {Object} CKEDITOR.config.coreStyles_subscript

Since: 3.0

The style definition to be used to apply the subscript style in the text.
Defined in: plugins/basicstyles/plugin.js.

CKEDITOR.config.coreStyles_subscript = { element : 'span', attributes : {'class': 'Subscript'}, overrides : 'sub' };

<static> {Object} CKEDITOR.config.coreStyles_superscript

Since: 3.0

The style definition to be used to apply the superscript style in the text.
Defined in: plugins/basicstyles/plugin.js.

CKEDITOR.config.coreStyles_superscript = { element : 'span', attributes : {'class': 'Superscript'}, overrides : 'sup' };

<static> {Object} CKEDITOR.config.coreStyles_underline

Since: 3.0

The style definition to be used to apply the underline style in the text.
Defined in: plugins/basicstyles/plugin.js.

CKEDITOR.config.coreStyles_underline = { element : 'span', attributes : {'class': 'Underline'}};

<static> {String} CKEDITOR.config.customConfig

Since: 3.0

The URL path for the custom configuration file to be loaded. If not overloaded with inline configurations, it defaults to the "config.js" file present in the root of the CKEditor installation directory.

CKEditor will recursively load custom configuration files defined inside other custom configuration files.

// Load a specific configuration file.
CKEDITOR.replace( 'myfiled', { customConfig : '/myconfig.js' } );

// Do not load any custom configuration file.
CKEDITOR.replace( 'myfiled', { customConfig : '' } );

Default Value:: '<CKEditor folder>/config.js'

<static> {String} CKEDITOR.config.defaultLanguage

Since: 3.0

The language to be used if CKEDITOR.config.language is left empty and it's not possible to localize the editor to the user language.

config.defaultLanguage = 'it';

Default Value:: 'en'

<static> {String} CKEDITOR.config.dialog_backgroundCoverColor

Since: 3.0

The color of the dialog background cover. It should be a valid CSS color string.
Defined in: plugins/dialog/plugin.js.

config.dialog_backgroundCoverColor = 'rgb(255, 254, 253)';

Default Value:: 'white'

<static> {Number} CKEDITOR.config.dialog_backgroundCoverOpacity

Since: 3.0

The opacity of the dialog background cover. It should be a number within the range [0.0, 1.0].
Defined in: plugins/dialog/plugin.js.

config.dialog_backgroundCoverOpacity = 0.7;

Default Value:: 0.5

<static> {Number} CKEDITOR.config.dialog_magnetDistance

Since: 3.0

The distance of magnetic borders used in moving and resizing dialogs, measured in pixels.
Defined in: plugins/dialog/plugin.js.

config.dialog_magnetDistance = 30;

Default Value:: 20

<static> {Boolean} CKEDITOR.config.dialog_startupFocusTab

Since: 3.0

If the dialog has more than one tab, put focus into the first tab as soon as dialog is opened.
Defined in: plugins/dialog/plugin.js.

config.dialog_startupFocusTab = true;

Default Value:: false

<static> {Boolean} CKEDITOR.config.disableNativeSpellChecker

Since: 3.0

Disables the built-in spell checker while typing natively available in the browser (currently Firefox and Safari only).

Even if word suggestions will not appear in the CKEditor context menu, this feature is useful to help quickly identifying misspelled words.

This setting is currently compatible with Firefox only due to limitations in other browsers.
Defined in: plugins/wysiwygarea/plugin.js.

config.disableNativeSpellChecker = false;

Default Value:: true

<static> {Boolean} CKEDITOR.config.disableNativeTableHandles

Since: 3.0

Disables the "table tools" offered natively by the browser (currently Firefox only) to make quick table editing operations, like adding or deleting rows and columns.
Defined in: plugins/wysiwygarea/plugin.js.

config.disableNativeTableHandles = false;

Default Value:: true

<static> {Boolean} CKEDITOR.config.disableObjectResizing

Since: 3.0

Disables the ability of resize objects (image and tables) in the editing area.
Defined in: plugins/wysiwygarea/plugin.js.

config.disableObjectResizing = true;

Default Value:: false

<static> {String} CKEDITOR.config.docType

Since: 3.0

Sets the doctype to be used when loading the editor content as HTML.

// Set the doctype to the HTML 4 (quirks) mode.
config.docType = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">';

Default Value:: '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'

<static> {Boolean} CKEDITOR.config.editingBlock

Since: 3.0

Whether to render or not the editing block area in the editor interface.
Defined in: plugins/editingblock/plugin.js.

config.editingBlock = false;

Default Value:: true

<static> {String} CKEDITOR.config.emailProtection

Since: 3.1

The e-mail address anti-spam protection option. The protection will be applied when creating or modifying e-mail links through the editor interface.
Two methods of protection can be choosed:

The e-mail parts (name, domain and any other query string) are assembled into a function call pattern. Such function must be provided by the developer in the pages that will use the contents.
Only the e-mail address is obfuscated into a special string that has no meaning for humans or spam bots, but which is properly rendered and accepted by the browser.

Both approaches require JavaScript to be enabled.
Defined in: plugins/link/dialogs/link.js.

// href="mailto:tester@ckeditor.com?subject=subject&body=body"
config.emailProtection = '';

// href="e-mail"
config.emailProtection = 'encode';

// href="javascript:mt('tester','ckeditor.com','subject','body')"
config.emailProtection = 'mt(NAME,DOMAIN,SUBJECT,BODY)';

Default Value:: '' (empty string = disabled)

<static> {Boolean} CKEDITOR.config.enableTabKeyTools

Since: 3.0

Allow context-sensitive tab key behaviors, including the following scenarios:

When selection is anchored inside table cells:

If TAB is pressed, select the contents of the "next" cell. If in the last cell in the table, add a new row to it and focus its first cell.
If SHIFT+TAB is pressed, select the contents of the "previous" cell. Do nothing when it's in the first cell.

Defined in: plugins/tab/plugin.js.

config.enableTabKeyTools = false;

Default Value:: true

<static> {Number} CKEDITOR.config.enterMode

Since: 3.0

Sets the behavior for the ENTER key. It also dictates other behaviour rules in the editor, like whether the <br> element is to be used as a paragraph separator when indenting text. The allowed values are the following constants, and their relative behavior:

CKEDITOR.ENTER_P (1): new <p> paragraphs are created;
CKEDITOR.ENTER_BR (2): lines are broken with <br> elements;
CKEDITOR.ENTER_DIV (3): new <div> blocks are created.

Note: It's recommended to use the CKEDITOR.ENTER_P value because of its semantic value and correctness. The editor is optimized for this value.

// Not recommended.
config.enterMode = CKEDITOR.ENTER_BR;

<static> {Boolean} CKEDITOR.config.entities

Since: 3.0

Whether to use HTML entities in the output.
Defined in: plugins/entities/plugin.js.

config.entities = false;

Default Value:: true

<static> {String} CKEDITOR.config.entities_additional

Since: 3.0

An additional list of entities to be used. It's a string containing each entry separated by a comma. Entities names or number must be used, exclusing the "&" preffix and the ";" termination.
Defined in: plugins/entities/plugin.js.

Default Value:: '#39' // The single quote (') character.

<static> {Boolean} CKEDITOR.config.entities_greek

Since: 3.0

Whether to convert some symbols, mathematical symbols, and Greek letters to HTML entities. This may be more relevant for users typing text written in Greek. The list of entities can be found at the W3C HTML 4.01 Specification, section 24.3.1.
Defined in: plugins/entities/plugin.js.

config.entities_greek = false;

Default Value:: true

<static> {Boolean} CKEDITOR.config.entities_latin

Since: 3.0

Whether to convert some Latin characters (Latin alphabet No. 1, ISO 8859-1) to HTML entities. The list of entities can be found at the W3C HTML 4.01 Specification, section 24.2.1.
Defined in: plugins/entities/plugin.js.

config.entities_latin = false;

Default Value:: true

<static> {Boolean} CKEDITOR.config.entities_processNumerical

Since: 3.0

Whether to convert all remaining characters, not comprised in the ASCII character table, to their relative decimal numeric representation of HTML entity. When specified as the value 'force', it will simply convert all entities into the above form. For example, the phrase "This is Chinese: 汉语." is outputted as "This is Chinese: 汉语."
Defined in: plugins/entities/plugin.js.

config.entities_processNumerical = true;
config.entities_processNumerical = 'force';		//Convert from " " into " ";

Default Value:: false

<static> {String} CKEDITOR.config.extraPlugins

Since: 3.0

List of additional plugins to be loaded. This is a tool setting which makes it easier to add new plugins, whithout having to touch and possibly breaking the CKEDITOR.config.plugins setting.

config.extraPlugins = 'myplugin,anotherplugin';

<static> {String} CKEDITOR.config.filebrowserBrowseUrl

Since: 3.0

The location of an external file browser, that should be launched when "Browse Server" button is pressed. If configured, the "Browse Server" button will appear in Link, Image and Flash dialogs.
Defined in: plugins/filebrowser/plugin.js.

config.filebrowserBrowseUrl = '/browser/browse.php';

See:: The File Browser/Uploader documentation.

Default Value:: '' (empty string = disabled)

<static> {String} CKEDITOR.config.filebrowserFlashBrowseUrl

Since: 3.0

The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Flash dialog. If not set, CKEditor will use CKEDITOR.config.filebrowserBrowseUrl.
Defined in: plugins/filebrowser/plugin.js.

config.filebrowserFlashBrowseUrl = '/browser/browse.php?type=Flash';

Default Value:: '' (empty string = disabled)

<static> {String} CKEDITOR.config.filebrowserFlashUploadUrl

Since: 3.0

The location of a script that handles file uploads in the Flash dialog. If not set, CKEditor will use CKEDITOR.config.filebrowserUploadUrl.
Defined in: plugins/filebrowser/plugin.js.

config.filebrowserFlashUploadUrl = '/uploader/upload.php?type=Flash';

Default Value:: '' (empty string = disabled)

<static> {String} CKEDITOR.config.filebrowserImageBrowseLinkUrl

Since: 3.2

The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Link tab of Image dialog. If not set, CKEditor will use CKEDITOR.config.filebrowserBrowseUrl.
Defined in: plugins/filebrowser/plugin.js.

config.filebrowserImageBrowseLinkUrl = '/browser/browse.php';

Default Value:: '' (empty string = disabled)

<static> {String} CKEDITOR.config.filebrowserImageBrowseUrl

Since: 3.0

The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Image dialog. If not set, CKEditor will use CKEDITOR.config.filebrowserBrowseUrl.
Defined in: plugins/filebrowser/plugin.js.

config.filebrowserImageBrowseUrl = '/browser/browse.php?type=Images';

Default Value:: '' (empty string = disabled)

<static> {String} CKEDITOR.config.filebrowserImageUploadUrl

Since: 3.0

The location of a script that handles file uploads in the Image dialog. If not set, CKEditor will use CKEDITOR.config.filebrowserUploadUrl.
Defined in: plugins/filebrowser/plugin.js.

config.filebrowserImageUploadUrl = '/uploader/upload.php?type=Images';

Default Value:: '' (empty string = disabled)

<static> {String} CKEDITOR.config.filebrowserUploadUrl

Since: 3.0

The location of a script that handles file uploads. If set, the "Upload" tab will appear in "Link", "Image" and "Flash" dialogs.
Defined in: plugins/filebrowser/plugin.js.

config.filebrowserUploadUrl = '/uploader/upload.php';

See:: The File Browser/Uploader documentation.

Default Value:: '' (empty string = disabled)

<static> {String} CKEDITOR.config.filebrowserWindowFeatures

Since: 3.4.1

The "features" to use in the file browser popup window.
Defined in: plugins/filebrowser/plugin.js.

config.filebrowserWindowFeatures = 'resizable=yes,scrollbars=no';

Default Value:: 'location=no,menubar=no,toolbar=no,dependent=yes,minimizable=no,modal=yes,alwaysRaised=yes,resizable=yes,scrollbars=yes'

<static> {Object} CKEDITOR.config.find_highlight

Since: 3.0

Defines the style to be used to highlight results with the find dialog.
Defined in: plugins/find/plugin.js.

// Highlight search results with blue on yellow.
config.find_highlight =
    {
        element : 'span',
        styles : { 'background-color' : '#ff0', 'color' : '#00f' }
    };

<static> {String} CKEDITOR.config.font_defaultLabel

Since: 3.0

The text to be displayed in the Font combo is none of the available values matches the current cursor position or text selection.
Defined in: plugins/font/plugin.js.

// If the default site font is Arial, we may making it more explicit to the end user.
config.font_defaultLabel = 'Arial';

<static> {String} CKEDITOR.config.font_names

Since: 3.0

The list of fonts names to be displayed in the Font combo in the toolbar. Entries are separated by semi-colons (;), while it's possible to have more than one font for each entry, in the HTML way (separated by comma). A display name may be optionally defined by prefixing the entries with the name and the slash character. For example, "Arial/Arial, Helvetica, sans-serif" will be displayed as "Arial" in the list, but will be outputted as "Arial, Helvetica, sans-serif".
Defined in: plugins/font/plugin.js.

config.font_names =
    'Arial/Arial, Helvetica, sans-serif;' +
    'Times New Roman/Times New Roman, Times, serif;' +
    'Verdana';

config.font_names = 'Arial;Times New Roman;Verdana';

<static> {Object} CKEDITOR.config.font_style

Since: 3.0

The style definition to be used to apply the font in the text.
Defined in: plugins/font/plugin.js.

// This is actually the default value for it.
config.font_style =
    {
        element		: 'span',
        styles		: { 'font-family' : '#(family)' },
        overrides	: [ { element : 'font', attributes : { 'face' : null } } ]
    };

<static> {String} CKEDITOR.config.fontSize_defaultLabel

Since: 3.0

The text to be displayed in the Font Size combo is none of the available values matches the current cursor position or text selection.
Defined in: plugins/font/plugin.js.

// If the default site font size is 12px, we may making it more explicit to the end user.
config.fontSize_defaultLabel = '12px';

<static> {String} CKEDITOR.config.fontSize_sizes

Since: 3.0

The list of fonts size to be displayed in the Font Size combo in the toolbar. Entries are separated by semi-colons (;). Any kind of "CSS like" size can be used, like "12px", "2.3em", "130%", "larger" or "x-small". A display name may be optionally defined by prefixing the entries with the name and the slash character. For example, "Bigger Font/14px" will be displayed as "Bigger Font" in the list, but will be outputted as "14px".
Defined in: plugins/font/plugin.js.

config.fontSize_sizes = '16/16px;24/24px;48/48px;';

config.fontSize_sizes = '12px;2.3em;130%;larger;x-small';

config.fontSize_sizes = '12 Pixels/12px;Big/2.3em;30 Percent More/130%;Bigger/larger;Very Small/x-small';

Default Value:: '8/8px;9/9px;10/10px;11/11px;12/12px;14/14px;16/16px;18/18px;20/20px;22/22px;24/24px;26/26px;28/28px;36/36px;48/48px;72/72px'

<static> {Object} CKEDITOR.config.fontSize_style

Since: 3.0

The style definition to be used to apply the font size in the text.
Defined in: plugins/font/plugin.js.

// This is actually the default value for it.
config.fontSize_style =
    {
        element		: 'span',
        styles		: { 'font-size' : '#(size)' },
        overrides	: [ { element : 'font', attributes : { 'size' : null } } ]
    };

<static> {Undefined} CKEDITOR.config.forceEnterMode

Since: 3.2.1

Force the respect of CKEDITOR.config.enterMode as line break regardless of the context, E.g. If CKEDITOR.config.enterMode is set to CKEDITOR.ENTER_P, press enter key inside a 'div' will create a new paragraph with 'p' instead of 'div'.

// Not recommended.
config.forceEnterMode = true;

Default Value:: false

<static> {Boolean} CKEDITOR.config.forcePasteAsPlainText

Since: 3.0

Whether to force all pasting operations to insert on plain text into the editor, loosing any formatting information possibly available in the source text.
Defined in: plugins/pastetext/plugin.js.

config.forcePasteAsPlainText = true;

Default Value:: false

<static> {Boolean} CKEDITOR.config.forceSimpleAmpersand

Since: 3.0

Whether to force using "&" instead of "&" in elements attributes values. It's not recommended to change this setting for compliance with the W3C XHTML 1.0 standards (C.12, XHTML 1.0).
Defined in: plugins/htmldataprocessor/plugin.js.

config.forceSimpleAmpersand = false;

Default Value:: false

<static> {Object} CKEDITOR.config.format_address

Since: 3.0

The style definition to be used to apply the "Address" format.
Defined in: plugins/format/plugin.js.

config.format_address = { element : 'address', attributes : { class : 'styledAddress' } };

<static> {Object} CKEDITOR.config.format_div

Since: 3.0

The style definition to be used to apply the "Normal (DIV)" format.
Defined in: plugins/format/plugin.js.

config.format_div = { element : 'div', attributes : { class : 'normalDiv' } };

<static> {Object} CKEDITOR.config.format_h1

Since: 3.0