imageRef
| Syntax |
imageRef (imageSpec, explanation, hspace, align, usemap, ismap, border, pageTable, glossref, vspace, lowsrc, rollsrc, height, width, name, id, style, class, title)
|
| Params |
imageSpec is the name or address of an image for which an <img...> tag should be generated. explanation, an optional string, includes the alt text for the image. hspace, an optional number, is the amount of horizontal space around the image. align, an optional string, is the alignment of the image. usemap, an optional string, specifies the name of the client side image map to use. ismap, an optional boolean, specifies whether or not the image is a clickable image map. border, an optional number which defaults to 0, is the amount of border around the image. pageTable is the optional address of the page table. glossref, an optional string, is the name of a glossary entry the image should link to. vspace, an optional number, is the amount of vertical space around the image. lowsrc, an optional string, is the name of an image to include as the low-resolution version. rollsrc, an optional string, is the name of an image to appear during mouse roll-overs. (Works with IE only.) height, an optional number, specifies the height of the image, over-riding the image's actual height. width, an optional number, specifies the width of the image, over-riding the image's actual width. name, an optional string, sets the name attribute of the img tag. id, an optional string, sets the id attribute of the img tag. style, an optional string, sets the style attribute of the img tag. class, an optional string, sets the class attribute of the img tag. title, an optional string, sets the title attribute of the img tag.
|
| Action |
Generates the HTML for an img tag and publishes the image.
|
| Returns |
The img tag HTML string.
|
| Examples |
imageRef ("lineFade") » "<img src=\"images/lineFade.gif" height=3 width=359 border=0>"
imageRef ("lineFade", height:6)
imageRef ("lineFade", "This is a faded line.", height:1, class:"foo")
|
| Notes |
If imageSpec is an address rather than a string, then the image is placed at the same level as the page being rendered. Otherwise, the image is placed in the images folder. For dynamic pages, using strings is recommended over using addresses. This macro automatically calculates the height and width of the image. This macro is stored at html.data.standardMacros.imageRef.
|
| See Also |
bgImageRef
|
