Documentation Center

Built-in scope variables

Built-in variables that you can use to your advantage whenever scope plays a role.

namedescriptionproperty
ancestors

Checks and returns an array with the DOM. Provides information from the current selection or context node, and all the way up to the root element.

Code using this variable will be executed every time there is a change in one of these ancestors.

Used for custom UI, and for Command methods such as:
  • getEnabled
  • getAvailable
showChangetrackingAllows you to control the visibility of the Show Changes panel. By listening to this built-in scope variable you can add code to obtain desired behavior.Determines when the panel is visible- whether it is shown or not.

true for shown

false for not shown.

showCustomPanelWhen you build a custom panel, this scope variable allows you to control the visibility of your panel.Determines when the panel is visible- whether it is shown or not.

true for shown

false for not shown.

showFindReplaceAllows you to control the visibility of the Find & Replace panel. By listening to this built-in scope variable you can add code to obtain desired behavior.Determines when the panel is visible- whether it is shown or not.

true for shown

false for not shown.

showPropertiesAllows you to control the visibility of the Properties panel. By listening to this built-in scope variable you can add code to obtain desired behavior.Determines when the panel is visible- whether it is shown or not.

true for shown

false for not shown.

xmlSelectionAllows you access to the editor's current selection, range and cursor. The value of the scope variable xmlSelection is equal to the Editor.Selection object.
Code using this variable will be executed every time there is a change in this selection:
  • getEnabled
  • getAvailable