Icon Clause

Icons help users locate and recognize items by associating a special image with the item. You can assign a special icon to the new administrative object or use the default icon.

Note: These icons are not used in web apps.

For example, you might want to use a company logo for a Vault that contains objects related to doing business with that company. Also, you could use an image of a tax form for a Tax Form Type.

When assigning a unique icon, you must use a GIF image file. To write an Icon clause, you need the full directory path to the icon you are assigning. For example, the following command assigns a calendar icon to the 2007 Records Vault:

add vault “2007 Records”
icon $MATRIXHOME/pixmaps/app/calendar2007.gif;

The gif file must be accessible while defining the item, but then it is stored in the database. GIF filenames should not include the @ sign, as that is used internally by 3DSpace.

Icons can be checked out of the objects that contain them. For syntax, see Image Clause.