Ektron® eWebEditPro Developer's Reference Guide

Parameters:
Parameter Type Description
CommandName String The command to retrieve.
Method: ConvertImage
Return: This returns a reference directly to the command item.
Description: Converts a specified image into a file format requested by the client.
The imgfmt element of the configuration data determines which graphic file
formats are available in your system.
See Also: ”imgfmt” on page 517
This method differs from the SaveAs method in that it does not depend on the
current image. Instead, it lets the client application or script quickly change any
file’s format.
Object: ”Image Editor Object”
Parameters
Parameter Type Description
SrcImagePath String The path to the image to convert. If this is
empty, the current image is converted
and saved.
DestImagePath String The location and name to which to save
the image. If the file extension specified
in this parameter does not match the
format parameter, the extension is
modified to match the format.
Format String The format in which to save the image.
See Also: ”Specifying Image Format” on
page 523
ColorDepth Long The depth of the color conversion.
See Also: ”Specifying Color Depth” on
page 523
Remarks
If an image is identified, it is loaded and saved to the given destination in the given
format.
See Also: ”Method: SaveAs” on page 92
Ektron® eWebEditPro Developer’s Reference Guide, Release 5.1, Revision 1 52