IsSupportedImageFile

Syntax

bool IsSupportedImageFile (StrParamInput)

Parameters

Smart parameters are supported.. A Boolean that determines the type of test to perform.

True: Tests the validity of the image by checking the file extension and attempting to load the image.

False: Only a file extension check is performed to determine if it is a supported file.

Returns

True if parameter is valid, the action is called at the page level and the page's IMAGEFILE variable (set at scan time by the scan tasks) points to a file whose format is supported (can be displayed) by the Image view control. Otherwise False.

Level

Page level.

Details

This action tests a file to determine if the file format is supported. The extension is checked to determine if it denotes a supported image type. If True is passed as a parameter, it also attempts to load the file into the Image view control.

Using False as a parameter improves the speed of this action. A parameter of True slows down the processing, especially if the images are very large, but it adds an extra confirmation that the file is not corrupted and confirm that any subformat of the file type, such as compression type, is also supported.

Example

IsSupportedImageFile()