bgImageRef

Syntax bgImageRef (imageSpec, pageTable)

Params bgImageRef is an optional parameter, the name or URL of the background image. If not supplied, the #background directive is used.

pageTable is the optional address of the page table.

Action Builds the background attribute for a <body...> tag.

Returns A string containing "background=" plus the URL or path to the background image.

Examples bgImageRef ()

   » background="../images/bgBlue.gif"

bgImageRef ("bgBlue")

   » background="../images/bgBlue.gif"

bgImageRef ("http:/\/www.xyz.com/images/bgBlue.gif")

   » background="http:/\/www.xyz.com/images/bgBlue.gif"

Notes If you're using the pageHeader macro, you don't need to call this macro.

If you're using the #pageHeader attribute, but call the bodyTag macro, you don't need to call this macro.

This macro is stored at html.data.standardMacros.bgImageRef.

See Also imageRef

bodyTag

pageHeader

Discuss