tinymce.EditorCommands
This class enables you to add custom editor commands and it contains overrides for native browser commands to address various bugs and issues.
Methods
| name | summary | defined by |
|---|---|---|
| addCommands() | Adds commands to the command collection. | tinymce.EditorCommands |
| execCommand() | Executes the specified command. | tinymce.EditorCommands |
| queryCommandState() | Queries the current state for a command for example if the current selection is "bold". | tinymce.EditorCommands |
| queryCommandSupported() | Returns true/false if the command is supported or not. | tinymce.EditorCommands |
| queryCommandValue() | Queries the command value for example the current fontsize. | tinymce.EditorCommands |
Methods
addCommands
addCommands(commandList:Object, type:String)
Adds commands to the command collection.
Parameters
- commandList (Object) - Name/value collection with commands to add, the names can also be comma separated.
- type (String) - Optional type to add, defaults to exec. Can be value or state as well.
execCommand
execCommand(command:String, ui:Boolean, value:Object, args:Object):Boolean
Executes the specified command.
Parameters
- command (String) - Command to execute.
- ui (Boolean) - Optional user interface state.
- value (Object) - Optional value for command.
- args (Object) - Optional extra arguments to the execCommand.
Return value
- Boolean - true/false if the command was found or not.
queryCommandState
queryCommandState(command:String):Boolean, Number
Queries the current state for a command for example if the current selection is "bold".
Parameters
- command (String) - Command to check the state of.
Return value
- Boolean - true/false if the selected contents is bold or not, -1 if it's not found.
- Number - true/false if the selected contents is bold or not, -1 if it's not found.
queryCommandSupported
queryCommandSupported(command:String):Boolean
Returns true/false if the command is supported or not.
Parameters
- command (String) - Command that we check support for.
Return value
- Boolean - true/false if the command is supported or not.
queryCommandValue
queryCommandValue(command:String):Object
Queries the command value for example the current fontsize.
Parameters
- command (String) - Command to check the value of.
Return value
- Object - Command value of false if it's not found.
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.