getDescription
Description
Get the description for this node, in the current interface language, as specified in the nodeConfig configuration, or in the schema.
Using the method
This is an example of the configuration for a node that includes a description element.
<x:node match="section">
<x:role>hidden-from-ui</x:role>
<x:name xml:lang="en">Section</x:name>
<x:name xml:lang="nl">Sectie</x:name>
<x:description xml:lang="en">You can use a Section to split your document into different parts with each their own header.</x:description>
</x:node>
If you go to the simple demo and look at the start.html file in the Console of your browser, then you can run the following code. If it runs properly the result of this code is the description defined for a section in the configuration.
var doc = Editor.getActiveDocument();
var section = doc.selectSingleNode('//section');
section.getDescription();
Using the method
Return Value
String. The description for this node.
Syntax
XopusNode.getDescription () : String