Search
Preparing search index...
The search index is not available
DefinitelyTyped
Inherited
Private
Externals
Only exported
CKEDITOR
editor
Class editor
Hierarchy
event
editor
Index
Constructor methods
constructor
Properties
activeEnterMode
activeFilter
activeShiftEnterMode
blockless
config
container
contextMenu
dataProcessor
document
element
elementMode
enterMode
filter
focusManager
id
keystrokeHandler
lang
langCode
mode
name
plugins
readOnly
shiftEnterMode
status
tabIndex
templates
title
toolbar
ui
useCapture
widgets
window
Methods
addCommand
addFeature
addMenuGroup
addMenuItem
addMenuItems
addMode
addRemoveFormatFilter
applyStyle
attachStyleStateChange
capture
checkDirty
createFakeElement
createFakeParserElement
createRange
define
destroy
editable
elementPath
execCommand
fire
fireOnce
focus
forceNextSelectionCheck
getClipboardData
getColorFromDialog
getCommand
getData
getMenuItem
getResizable
getSelection
getSnapshot
getStylesSet
getUiColor
hasListeners
insertElement
insertHtml
insertText
loadSnapshot
lockSelection
on
once
openDialog
popup
removeAllListeners
removeListener
removeMenuItem
removeStyle
resetDirty
resetUndo
resize
restoreRealElement
selectionChange
setActiveEnterMode
setActiveFilter
setData
setKeystroke
setMode
setReadOnly
setUiColor
unlockSelection
updateElement
Constructor methods
constructor
(
instanceConfig
?:
Object
, element
?:
element
, mode
?:
number
)
:
editor
Parameters
instanceConfig?:
Object
optional
element?:
element
optional
mode?:
number
optional
Returns
editor
Properties
public
activeEnterMode
:
number
public
activeFilter
:
filter
public
activeShiftEnterMode
:
number
public
blockless
:
boolean
public
config
:
config
public
container
:
element
public
contextMenu
:
contextMenu
public
dataProcessor
:
dataProcessor
public
document
:
document
public
element
:
element
public
elementMode
:
number
public
enterMode
:
number
public
filter
:
filter
public
focusManager
:
focusManager
public
id
:
string
public
keystrokeHandler
:
keystrokeHandler
public
lang
:
any
public
langCode
:
string
public
mode
:
string
public
name
:
string
public
plugins
:
Object
public
readOnly
:
boolean
public
shiftEnterMode
:
number
public
status
:
string
public
tabIndex
:
number
public
templates
:
Object
public
title
:
any
public
toolbar
:
Object
public
ui
:
ui
public
useCapture
:
boolean
public
widgets
:
repository
public
window
:
window
Methods
public
addCommand
(
commandName
:
string
, commandDefinition
:
commandDefinition
)
Parameters
commandName:
string
commandDefinition:
commandDefinition
public
addFeature
(
feature
:
feature
)
:
boolean
Parameters
feature:
feature
Returns
boolean
public
addMenuGroup
(
name
:
string
, order
?:
number
)
Parameters
name:
string
order?:
number
optional
public
addMenuItem
(
name
:
string
, definition
?:
any
)
Parameters
name:
string
definition?:
any
optional
public
addMenuItems
(
definitions
:
Array<any>
)
Parameters
definitions:
Array<any>
public
addMode
(
mode
:
string
, exec
:
() => void
)
Parameters
mode:
string
exec:
() => void
public
addRemoveFormatFilter
(
func
:
Function
)
Parameters
func:
Function
public
applyStyle
(
style
:
style
)
Parameters
style:
style
public
attachStyleStateChange
(
style
:
style
, callback
:
Function
)
Parameters
style:
style
callback:
Function
public
capture
(
)
public
checkDirty
(
)
:
boolean
Returns
boolean
public
createFakeElement
(
realElement
:
Object
, className
:
Object
, realElementType
:
Object
, isResizable
:
Object
)
Parameters
realElement:
Object
className:
Object
realElementType:
Object
isResizable:
Object
public
createFakeParserElement
(
realElement
:
Object
, className
:
Object
, realElementType
:
Object
, isResizable
:
Object
)
Parameters
realElement:
Object
className:
Object
realElementType:
Object
isResizable:
Object
public
createRange
(
)
:
range
Returns
range
public
define
(
name
:
string
, meta
:
Object
)
Parameters
name:
string
meta:
Object
public
destroy
(
noUpdate
?:
boolean
)
Parameters
noUpdate?:
boolean
optional
public
editable
(
elementOrEditable
:
element
)
Parameters
elementOrEditable:
element
public
editable
(
elementOrEditable
:
editable
)
Parameters
elementOrEditable:
editable
public
elementPath
(
startNode
?:
node
)
:
elementPath
Parameters
startNode?:
node
optional
Returns
elementPath
public
execCommand
(
commandName
:
string
, data
?:
Object
)
:
boolean
Parameters
commandName:
string
data?:
Object
optional
Returns
boolean
public
fire
(
eventName
:
string
, data
?:
Object
, editor
?:
editor
)
:
any
Parameters
eventName:
string
data?:
Object
optional
editor?:
editor
optional
Returns
any
public
fireOnce
(
eventName
:
string
, data
?:
Object
, editor
?:
editor
)
:
any
Parameters
eventName:
string
data?:
Object
optional
editor?:
editor
optional
Returns
any
public
focus
(
)
public
forceNextSelectionCheck
(
)
public
getClipboardData
(
options
:
Object
, callback
:
Function
)
Parameters
options:
Object
callback:
Function
public
getColorFromDialog
(
callback
:
Function
, scope
?:
Object
)
Parameters
callback:
Function
scope?:
Object
optional
public
getCommand
(
commandName
:
string
)
:
command
Parameters
commandName:
string
Returns
command
public
getData
(
noEvents
:
Object
)
:
string
Parameters
noEvents:
Object
Returns
string
public
getMenuItem
(
name
:
string
)
:
Object
Parameters
name:
string
Returns
Object
public
getResizable
(
forContents
:
boolean
)
:
element
Parameters
forContents:
boolean
Returns
element
public
getSelection
(
forceRealSelection
?:
boolean
)
:
selection
Parameters
forceRealSelection?:
boolean
optional
Returns
selection
public
getSnapshot
(
)
:
string
Returns
string
public
getStylesSet
(
callback
:
Function
)
Parameters
callback:
Function
public
getUiColor
(
)
:
string
Returns
string
public
hasListeners
(
eventName
:
string
)
:
boolean
Parameters
eventName:
string
Returns
boolean
public
insertElement
(
element
:
element
)
Parameters
element:
element
public
insertHtml
(
html
:
string
, mode
?:
string
)
Parameters
html:
string
mode?:
string
optional
public
insertText
(
text
:
string
)
Parameters
text:
string
public
loadSnapshot
(
snapshot
:
Object
)
Parameters
snapshot:
Object
public
lockSelection
(
sel
?:
selection
)
:
boolean
Parameters
sel?:
selection
optional
Returns
boolean
public
on
(
eventName
:
string
, listenerFunction
:
(eventInfo: CKEDITOR.eventInfo) => void
, scopeObj
?:
Object
, listenerData
?:
Object
, priority
?:
number
)
Parameters
eventName:
string
listenerFunction:
(eventInfo: CKEDITOR.eventInfo) => void
scopeObj?:
Object
optional
listenerData?:
Object
optional
priority?:
number
optional
public
once
(
eventName
:
string
, listenerFunction
:
(eventInfo: CKEDITOR.eventInfo) => void
, scopeObj
?:
Object
, listenerData
?:
Object
, priority
?:
number
)
Parameters
eventName:
string
listenerFunction:
(eventInfo: CKEDITOR.eventInfo) => void
scopeObj?:
Object
optional
listenerData?:
Object
optional
priority?:
number
optional
public
openDialog
(
dialogName
:
string
, callback
:
Function
)
:
CKEDITOR.dialog
Parameters
dialogName:
string
callback:
Function
Returns
CKEDITOR.dialog
public
popup
(
url
:
string
, width
?:
number
, height
?:
number
, options
?:
string
)
Parameters
url:
string
width?:
number
optional
height?:
number
optional
options?:
string
optional
public
popup
(
url
:
string
, width
?:
string
, height
?:
number
, options
?:
string
)
Parameters
url:
string
width?:
string
optional
height?:
number
optional
options?:
string
optional
public
popup
(
url
:
string
, width
?:
number
, height
?:
string
, options
?:
string
)
Parameters
url:
string
width?:
number
optional
height?:
string
optional
options?:
string
optional
public
popup
(
url
:
string
, width
?:
string
, height
?:
string
, options
?:
string
)
Parameters
url:
string
width?:
string
optional
height?:
string
optional
options?:
string
optional
public
removeAllListeners
(
)
public
removeListener
(
eventName
:
string
, listenerFunction
:
(eventInfo: CKEDITOR.eventInfo) => void
)
Parameters
eventName:
string
listenerFunction:
(eventInfo: CKEDITOR.eventInfo) => void
public
removeMenuItem
(
name
:
string
)
Parameters
name:
string
public
removeStyle
(
style
:
style
)
Parameters
style:
style
public
resetDirty
(
)
public
resetUndo
(
)
public
resize
(
width
:
number
, height
:
number
, isContentHeight
?:
boolean
, resizeInner
?:
boolean
)
Parameters
width:
number
height:
number
isContentHeight?:
boolean
optional
resizeInner?:
boolean
optional
public
resize
(
width
:
string
, height
:
number
, isContentHeight
?:
boolean
, resizeInner
?:
boolean
)
Parameters
width:
string
height:
number
isContentHeight?:
boolean
optional
resizeInner?:
boolean
optional
public
resize
(
width
:
number
, height
:
string
, isContentHeight
?:
boolean
, resizeInner
?:
boolean
)
Parameters
width:
number
height:
string
isContentHeight?:
boolean
optional
resizeInner?:
boolean
optional
public
resize
(
width
:
string
, height
:
string
, isContentHeight
?:
boolean
, resizeInner
?:
boolean
)
Parameters
width:
string
height:
string
isContentHeight?:
boolean
optional
resizeInner?:
boolean
optional
public
restoreRealElement
(
fakeElement
:
Object
)
:
element
Parameters
fakeElement:
Object
Returns
element
public
selectionChange
(
checkNow
?:
boolean
)
Parameters
checkNow?:
boolean
optional
public
setActiveEnterMode
(
enterMode
:
number
, shiftEnterMode
:
number
)
Parameters
enterMode:
number
shiftEnterMode:
number
public
setActiveFilter
(
filter
:
filter
)
Parameters
filter:
filter
public
setData
(
data
:
string
, callback
:
Function
, internal
:
boolean
)
Parameters
data:
string
callback:
Function
internal:
boolean
public
setKeystroke
(
keystroke
:
number
, behavior
?:
string
)
Parameters
keystroke:
number
behavior?:
string
optional
public
setKeystroke
(
keystroke
:
Array<any>
, behavior
?:
string
)
Parameters
keystroke:
Array<any>
behavior?:
string
optional
public
setKeystroke
(
keystroke
:
number
, behavior
?:
boolean
)
Parameters
keystroke:
number
behavior?:
boolean
optional
public
setKeystroke
(
keystroke
:
Array<any>
, behavior
?:
boolean
)
Parameters
keystroke:
Array<any>
behavior?:
boolean
optional
public
setMode
(
newMode
:
string
, callback
:
Function
)
Parameters
newMode:
string
callback:
Function
public
setReadOnly
(
isReadOnly
?:
boolean
)
Parameters
isReadOnly?:
boolean
optional
public
setUiColor
(
color
:
string
)
Parameters
color:
string
public
unlockSelection
(
restore
?:
boolean
)
Parameters
restore?:
boolean
optional
public
updateElement
(
)
Globals
CKEDITOR
CKEDITOR.ajax
CKEDITOR.dialog.definition
CKEDITOR.dom
CKEDITOR.htmlParser
CKEDITOR.plugins
CKEDITOR.plugins.link
CKEDITOR.plugins.widget
ALT
CTRL
DIALOG_RESIZE_BOTH
DIALOG_RESIZE_HEIGHT
DIALOG_RESIZE_NONE
DIALOG_RESIZE_WIDTH
ELEMENT_MODE_APPENDTO
ELEMENT_MODE_INLINE
ELEMENT_MODE_NONE
ELEMENT_MODE_REPLACE
END
ENTER_BR
ENTER_P
EVENT_PHASE_AT_TARGET
EVENT_PHASE_BUBBLING
EVENT_PHASE_CAPTURING
LINEUTILS_AFTER
LINEUTILS_BEFORE
LINEUTIS_INSIDE
NODE_COMMENT
NODE_DOCUMENT
NODE_DOCUMENT_FRAGMENT
NODE_ELEMENT
NODE_TEXT
SELECTION_ELEMENT
SELECTION_NONE
SELECTION_TEXT
SHIFT
SHRINK_ELEMENT
SHRINK_TEXT
START
TRISTATE_DISABLED
TRISTATE_OFF
TRISTATE_ON
UI_BUTTON
UI_MENUBUTTON
UI_PANEL
UI_PANELBUTTON
UI_RICHCOMBO
UI_SEPARATOR
basePath
currentInstance
disableAutoInline
document
instances
loadFullCoreTimeout
replaceClass
revision
rnd
skinName
status
timestamp
version
commandDefinition
config
dataProcessor
dialog
editable
eventInfo
feature
focusManager
keystrokeHandler
style
template
xml
command
dtd
editor
constructor
activeEnterMode
activeFilter
activeShiftEnterMode
blockless
config
container
contextMenu
dataProcessor
document
element
elementMode
enterMode
filter
focusManager
id
keystrokeHandler
lang
langCode
mode
name
plugins
readOnly
shiftEnterMode
status
tabIndex
templates
title
toolbar
ui
useCapture
widgets
window
addCommand
addFeature
addMenuGroup
addMenuItem
addMenuItems
addMode
addRemoveFormatFilter
applyStyle
attachStyleStateChange
capture
checkDirty
createFakeElement
createFakeParserElement
createRange
define
destroy
editable
elementPath
execCommand
fire
fireOnce
focus
forceNextSelectionCheck
getClipboardData
getColorFromDialog
getCommand
getData
getMenuItem
getResizable
getSelection
getSnapshot
getStylesSet
getUiColor
hasListeners
insertElement
insertHtml
insertText
loadSnapshot
lockSelection
on
once
openDialog
popup
removeAllListeners
removeListener
removeMenuItem
removeStyle
resetDirty
resetUndo
resize
restoreRealElement
selectionChange
setActiveEnterMode
setActiveFilter
setData
setKeystroke
setMode
setReadOnly
setUiColor
unlockSelection
updateElement
event
filter
menu
ui
add
addCss
addTemplate
appendTo
domReady
editorConfig
getCss
getTemplate
getUrl
inline
inlineAll
loadFullCore
replace
replaceAll