User Guide

272 Chapter 14: Document
dreamweaver.getObjectRefs() (deprecated)
Availability
Dreamweaver 1; deprecated in 3.
Description
This function scans the specified document for instances of the specified tags or, if no tags are
specified, for all tags in the document and formulates browser-specific references to those tags.
This function is equivalent to calling
getElementsByTagName() and then calling
dreamweaver.getElementRef() for each tag in the nodelist.
Arguments
NSorIE
, sourceDoc, {tag1}, {tag2},...{tagN}
• The NSorIE argument must be either "NS 4.0" or "IE 4.0". The DOM and rules for nested
references differ in Netscape Navigator 4.0 and Internet Explorer 4.0. This argument specifies
for which browser to return a valid reference.
• The sourceDoc argument must be "document", "parent", "parent.frames[number]",
"parent.frames['frameName']", or a URL. The document value specifies the document
that has the focus and contains the current selection. The
parent value specifies the parent
frameset (if the currently selected document is in a frame), and
parent.frames[number] and
parent.frames['frameName'] specify a document that is in a particular frame within the
frameset that contains the current document. If the argument is a relative URL, it is relative to
the extension file.
• The third and subsequent arguments, if supplied, are the names of tags (for example, "IMG",
"FORM", or "HR").
Returns
An array of strings where each array is a valid JavaScript reference to a named instance of the
requested tag type in the specified document (for example,
"document.myLayer.document.myImage") for the specified browser:
• Dreamweaver returns correct references for Internet Explorer for A, AREA, APPLET, EMBED, DIV,
SPAN, INPUT, SELECT, OPTION, TEXTAREA, OBJECT, and IMG tags.
• Dreamweaver returns correct references for Netscape Navigator for A, AREA, APPLET, EMBED,
LAYER, ILAYER, SELECT, OPTION, TEXTAREA, OBJECT, and IMG tags, and for absolutely
positioned
DIV and SPAN tags. For DIV and SPAN tags that are not absolutely positioned,
Dreamweaver returns "cannot reference <tag>".
• Dreamweaver does not return references for unnamed objects. If an object does not contain
either a
NAME or an ID attribute, Dreamweaver returns "unnamed <tag>". If the browser does
not support a reference by name, Dreamweaver references the object by index (for example,
document.myform.applets[3]).
• Dreamweaver does return references for named objects that are contained in unnamed forms
and layers (for example, document.forms[2].myCheckbox).
When the same list of arguments passes to
getObjectTags(), the two functions return arrays of
the same length and with parallel content.
000_DW_API_Print.book Page 272 Wednesday, August 20, 2003 9:14 AM