Lets you resize and add labels to GIF and JPEG format images.

This tag cannot have a body.

This tag is also supported within <cfscript>

Attribute Description Default
string, optional

Height in pixels of the image.

For the resize attribute, you also can specify the height as a percentage.

When you resize an image, if you specify a value for the width.

number, optional

Angle in degrees to rotate the image.

string, optional

Text string displayed in the CAPTCHA image. Use capital letters for better readability.

Do not include spaces because users cannot detect them in the resulting CAPTCHA image.

number, optional

Quality of the JPEG destination file. Applies only to files with an extension of JPG or JPEG.

Valid values are fractions that range from 0 through 1 (the lower the number, the lower the quality).

any, optional

source file

string, optional

Level of complexity of the CAPTCHA text.

Specify one of the following levels of text distortion: low, medium, high

string, optional

Border color. Hexadecimal value or supported named color.

For a hexadecimal value, use the form "#xxxxxx" or "xxxxxx", where x = 0-9 or A-F; use two number signs or none.

string, optional

HTML attributes that are not explicitly supported by cfimage.

If you specify an attribute and value, they are passed to the tag "img".

string, optional

Width in pixels of the image.

boolean, optional

Specifies whether the source is a Base64 string

string, optional

Name of the image variable to create.

The read action requires a name attribute.

The border, resize, and rotate actions require a name attribute or a destination attribute.

You can specify both.

any, optional

One or more valid fonts to use for the CAPTCHA text. Separate multiple fonts with commas.

Lucee supports only the system fonts that the JDK can recognize. For example, TTF fonts in the Windows directory are supported on Windows.

boolean, optional

should action "writetobrowser" embed the source of the image as base64 encoded string, default is false.

boolean, optional

If the destination file already exists, Lucee generates an error if the overwrite action is not set to yes.

string, optional

Absolute or relative pathname where the image output is written.

The image format is determined by the file extension.

The convert and write actions require a destination attribute.

The border, captcha, resize, and rotate actions require a name attribute or a destination attribute.

You can specify both.

If you do not enter a destination, the CAPTCHA image is placed inline in the HTML output and displayed in the web browser.

string, optional

Action to execute.

  • border
  • captcha
  • convert
  • writetobrowser
  • write
  • rotate
  • resize
  • read
  • info


number, optional

Border thickness in pixels. The border is added to the outside edge of the source image, increasing the image area accordingly.

string, optional

Name of the structure to be created.

string, optional

Format of the image displayed in the browser.

If you do not specify a format, the image is displayed in PNG format.

number, optional

font size of the text in the CAPTCHA image.



Simple Example

<cfset newImg = imageNew("",200,200,"rgb","blue")>
<cfimage action="write" source="#newImg#" name="writeimg" destination="pathname" overwrite="true">

See also