Editor
Directive
kendo-editor
Child Components
Props
deserialization Object
Fine-tunes the deserialization in the Editor (deserialization
in Kendo UI for jQuery). Deserialization is the process of parsing the HTML string input from the value()
method or from the viewHtml
dialog into editable content. The supported composite props are available in DeserializationProps
.
domain String
Relaxes the same-origin policy when the iframe-based Editor is in use (domain
in Kendo UI for jQuery). This process is automatic except when the policy is relaxed by document.domain = document.domain
in which case you have to use the domain
property to enable the proper functioning of the Editor across browsers. As of the 2014.1.319 release, the domain
property is available in internal builds.
encoded Boolean
Indicates whether the Editor will submit encoded HTML tags (encoded
in Kendo UI for jQuery). By default, the submitted value is encoded.
immutables Boolean | Object
If immutables
is enabled, the Editor disables the edit and command execution in elements that are marked with the editablecontent="false"
attribute (immutables
in Kendo UI for jQuery). The supported composite props are available in ImmutablesProps
.
messages Object
Defines the text of the labels that are displayed within the Editor (messages
in Kendo UI for jQuery). Used primarily for localization. The supported composite props are available in MessagesProps
.
paste-cleanup Object
The options for controlling the way the pasted content is modified before it is added to the Editor (pasteCleanup
in Kendo UI for jQuery). The supported composite props are available in PasteCleanupProps
.
pdf Object
Configures the PDF export settings of the Editor (pdf
in Kendo UI for jQuery). The supported composite props are available in PdfProps
.
placeholder String
The displayed hint when the Editor is empty. (placeholder
in Kendo UI for jQuery). Only applicable in the classic mode.
resizable Boolean | Object
If resizable
is enabled, the Editor renders a resize handle (resizable
in Kendo UI for jQuery). The supported composite props are available in ResizableProps
serialization Object
Allows the setup of the serialization options (serialization
in Kendo UI for jQuery). The supported composite props are available in SerializationProps
.
stylesheets Array
Allows the inclusion of the custom stylesheets in the editing area (stylesheets
in Kendo UI for jQuery). The stylesheets
setting is applicable only when the Editor is initialized from a textarea
and a contenteditable
iframe is generated.
tools Array
A collection of tools for interacting with the Editor (tools
in Kendo UI for jQuery). To include tools, specify their names. Custom tools and tools that require configuration are defined as objects.
The supported Editor commands are:
- Basic text formatting options—
bold
,italic
,underline
,strikethrough
,subscript
,superscript
. - Font and color—
fontName
,fontSize
,foreColor
,backColor
. - Alignment—
justifyLeft
,justifyCenter
,justifyRight
,justifyFull
. - Lists—
insertUnorderedList
,insertOrderedList
,indent
,outdent
. - Links, images, and files—
createLink
,unlink
,insertImage
,insertFile
. - Table editing—
tableWizard
,createTable
,addColumnLeft
,addColumnRight
,addRowAbove
,addRowBelow
,deleteRow
,deleteColumn
. - Structural markup and styles—
formatting
,cleanFormatting
. - Snippets—
insertHtml
. - HTML code view—
viewHtml
. - Print edited page—
print
. - Export to PDF—
pdf
.
image-browser Object
The configuration for the image browser dialog (imageBrowser
in Kendo UI for jQuery). The supported composite props are available in ImageBrowserProps
.
file-browser Object
The configuration for the file browser dialog (fileBrowser
in Kendo UI for jQuery). The supported composite props are available in FileBrowserProps
.
Events
change: Function
Fires when the Editor is blurred and its content was changed (change
in Kendo UI for jQuery).
execute: Function
Fires when an Editor command is executed (execute
in Kendo UI for jQuery).
keydown: Function
Fires when the user presses a keyboard key (keydown
in Kendo UI for jQuery). Triggered multiple times if the user holds the key down.
keyup: Function
Fires when the user releases a keyboard key (keyup
in Kendo UI for jQuery).
paste: Function
Fires before the content is pasted in the Editor (paste
in Kendo UI for jQuery).
pdfexport: Function
Fires when the user clicks the Export to PDF toolbar button (pdfexport
in Kendo UI for jQuery).
select: Function
Fires when the Editor selection changed (select
in Kendo UI for jQuery).
Methods
For more details about the methods available in the component's API please check its Kendo UI for jQuery API documentation.
kendoWidget
returns
Returns the Kendo UI Editor instance.