TinyMCE 5 webinar: Q1 review, migration tips, roadmap —  Register today
TinyMCE 5 webinar : Q1 review, migration tips, roadmap

tinymce.CommandEvent

This class is the event object send when the BeforeExecCommand and ExecCommand event occurs.

Examples

tinymce.activeEditor.on('ExecCommand', function(e) {
    console.log(e.command, e.ui, e.value);
});

Properties

name type summary defined by
command String Name of the command to execute. tinymce.CommandEvent
type String The event type name for example "click". tinymce.Event
ui Boolean User interface state. Normally false. tinymce.CommandEvent
value Object Value object for the execCommand call. tinymce.CommandEvent

Methods

name summary defined by
isDefaultPrevented() Returns true/false if the default action is to be prevented or not. tinymce.Event
isImmediatePropagationStopped() Returns true/false if the event immediate propagation is stopped or not. tinymce.Event
isPropagationStopped() Returns true/false if the event propagation is stopped or not. tinymce.Event
preventDefault() Prevents the default action of an event to be executed. tinymce.Event
stopImmediatePropagation() Prevents the event from propagating to listeners on the same object. tinymce.Event
stopPropagation() Stops the event from propagating up to listeners on parent objects. tinymce.Event

Methods

isDefaultPrevented

isDefaultPrevented():Boolean

Returns true/false if the default action is to be prevented or not.

Return value
  • Boolean - True/false if the event is to be execured or not.

isImmediatePropagationStopped

isImmediatePropagationStopped():Boolean

Returns true/false if the event immediate propagation is stopped or not.

Return value
  • Boolean - True/false if the event immediate propagation is stopped or not.

isPropagationStopped

isPropagationStopped():Boolean

Returns true/false if the event propagation is stopped or not.

Return value
  • Boolean - True/false if the event propagation is stopped or not.

preventDefault

preventDefault()

Prevents the default action of an event to be executed.

stopImmediatePropagation

stopImmediatePropagation()

Prevents the event from propagating to listeners on the same object.

stopPropagation

stopPropagation()

Stops the event from propagating up to listeners on parent objects.

Can't find what you're looking for? Let us know.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.