ImageSearchOptions class

ImageSearchOptions class

Represents search options for Image signatures.

Inheritance: ImageSearchOptions → SearchOptions

The ImageSearchOptions type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of the ImageSearchOptions class with default values.

Properties

Property Description
page_number Gets or sets Document page number for searching.
Value is optional.
pages_setup Options to specify pages for Signature searching.
all_pages Flag to search on each Document page. By default this value is set to true.
skip_external Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.
shape_position Flag to return specify shape position in the document layout. Avaliable only for Word documents
return_content Gets or sets flag to grab image content of signature on document page.
If this flag is set true, image signature content will keep raw image data by required format ImageSearchOptions.return_content_type.
By default this option is disabled.
min_content_size For non zero value this flag specifies minimal size of images for search criteria.
By default this flag is set to zero and does not affect search result.
max_content_size For non zero value this flag specifies maximum size of images for search criteria.
By default this flag is set to zero and does not affect search result.
return_content_type Specifies file type of returned content of the image signature when ReturnContent property is enabled.
By default it set to Null. That means to return image content in original format.
This image format is specified at ImageSignature.format
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than image content in original format will be returned.

Remarks

Learn more | | | |

See Also

ImageSaveOptions class ImageSignOptions class