Programmer's Guide > Interfaces > ANode interface > icon attribute
  
icon attribute
Used to get or set the name of the display icon that appears to the left of this Node (if any). The icons appear in the Document Map and also appear in the Edit window whenever element tags are set to full or partial display. If this Node has no icon, this returns the string"None".
If an invalid display icon is set, it will act as if it were set to "None".
* 
When using an adapter written using the RAOM (Repository Adapter Object Model), the icons for Nodes representing object boundaries will automatically be managed by the application. This icon attribute controls an independent Node icon which can be used by non-RAOM adapters or for other purposes. However, for Nodes representing object boundaries a RAOM adapter may override even this icon attribute. See the IOObject.displayIcon attribute for more information.
The value may be the case-sensitive name of a built-in icon or a full or relative path to a .bmp file. When setting this attribute, if a relative path is given, it will be looked for in the search path given by Application.getOption("graphicspath"). If the .bmp file is not found, it will act as if it were set to the built-in icon “None”.
* 
There is an upper limit (around 200) on the number of unique icons that can be set using a.bmp file. Once this limit is reached, it will act as if it were set to the built-in icon “None ”.
Built-in icon names are case sensitive and are listed in the following table.
Name
Icon
Default use
Attribute
Indicates that an element has attributes assigned to it.
BadAttribute
Indicates that an element has attributes assigned to it and at least one of those attributes is not legal for the current document type definition.
BadElement
Indicates an element whose position or element name are not legal for the current document type definition.
CheckedOut
Indicates a repository object accessed by a Repository Adapter is locked or checked out by the current user.
CollectionClosed
Indicates that a collection of help topics is hidden from view (in the UNIX help table of contents).
CollectionOpen
Indicates that a collection of help topics is expanded for viewing (in the UNIX help table of contents).
Comment
Indicates that an SGML element is part of a comment Marked Section.
Contracted
Indicates that the element's contents are collapsed and hidden from view.
DataMarkedSection
Indicates that an SGML element is part of a data Marked Section.
DocObject
Indicates a repository object accessed by a Repository Adapter that is neither locked nor checked out.
Document
Indicates a document.
Element
Indicates an SGML or XML element.
Empty
Indicates an element with no content.
End
Indicates an end tag.
Equation
Indicates an equation element.
Expanded
Indicates that the element's contents are expanded for viewing.
FileEntity
Indicates a referenced file entity.
Graphic
Indicates a graphic element.
GrayCheckedOut
Indicates a repository object accessed from a Repository Adapter that is locked or checked out by the current user but is unavailable.
GrayDocObject
Indicates a repository object accessed from a Repository Adapter that is neither locked nor checked out by the current user and is unavailable.
GrayLocked
Indicates a repository object accessed from a Repository Adapter that is locked or checked out by another user and is unavailable.
IgnoreMarkedSection
Indicates that an SGML element is part of an ignored Marked Section.
Locked
Indicates a repository object accessed by a Repository Adapter is locked or checked out by another user.
Missing
Indicates where a required element is missing.
None
No icon displayed.
ReadOnly
Indicates an element that is not editable.
Table
Indicates a table element.
icon
Access
read-write
Returns
String