User Guide

The Property inspector API 219
The Property inspector API
Two of the Property inspector API functions (canInspectSelection() and
inspectSelection()) are required.
canInspectSelection()
Description
Determines whether the Property inspector is appropriate for the current selection.
Arguments
None.
Use
dom.getSelectedNode() to get the current selection as a JavaScript object (for more
information about
dom.getSelectedNode(), see the Dreamweaver API Reference).
Returns
Dreamweaver expects a Boolean value: true if the inspector can inspect the current selection;
false otherwise.
Example
The following instance of the canInspectSelection() function returns a true value if the
selection contains the
CLASSID attribute, and the value of that attribute is "clsid:D27CDB6E-
AE6D-11cf-96B8-444553540000"
(the class ID for Flash Player):
function canInspectSelection(){
var theDOM = dw.getDocumentDOM();
var theObj = theDOM.getSelectedNode();
return (theObj.nodeType == Node.ELEMENT_NODE && ¬
theObj.hasAttribute("classid") && ¬
theObj.getAttribute("classid").toLowerCase()== ¬
"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000");
}
displayHelp()
Description
If this function is defined, a question mark (?) icon appears in the upper-right corner of the
Property inspector. This function is called when the user clicks the icon.
Arguments
None.
Returns
Dreamweaver expects nothing.