Sets the background color for the ColdFusion image. The background color is used for clearing a region. Setting the background color only affects the subsequent ImageClearRect calls.
Nothing.
ImageSetBackgroundColor(name
,color
)
ImageClearRect, ImageSetAntialiasing, IsImageFile
ColdFusion 8: Added this function.
Parameters Parameter Description Required. The ColdFusion image on which this operation is performed. Required. Background color:
name
color
If the color value is a string, specify a supported named color; see the name list in Valid HTML named colors. For a hexadecimal value, use the form "##xxxxxx" or "xxxxxx", where x = 0-9 or A-F; use two number signs or none.
Use this function in conjunction with the ImageClearRect function to clear a rectangular area of an image and set it to a specified color.
<!--- This example shows how to set the background color, and then draw a rectangle on an image filled with that color. ---> <!--- Create a ColdFusion image from an existing JPEG file. ---> <cfimage name="myImage" source="../cfdocs/images/artgallery/maxwell01.jpg"> <!--- Turn on antialiasing to improve image quality. ---> <cfset ImageSetAntialiasing(myImage)> <!--- Set the background color to magenta. ---> <cfset ImageSetBackgroundColor(myImage,"magenta")> <!--- Clear the rectangle specified on myImage with the background color specified for the image. ---> <cfset ImageClearRect(myImage,36,45,100,100)> <!--- Display the modified image in a browser. ---> <cfimage source="#myImage#" action="writeToBrowser">