ImageSearchOptions

ImageSearchOptions class

Represents search options for Image signatures.

public class ImageSearchOptions : SearchOptions

Constructors

Name Description
ImageSearchOptions() Initializes a new instance of the ImageSearchOptions class with default values.

Properties

Name Description
AllPages { get; set; } Flag to search on each Document page. By default this value is set to true.
MaxContentSize { get; set; } 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.
MinContentSize { get; set; } 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.
PageNumber { get; set; } Gets or sets Document page number for searching. Value is optional.
PagesSetup { get; set; } Options to specify pages for Signature searching.
ReturnContent { get; set; } 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 ReturnContentType. By default this option is disabled.
ReturnContentType { get; set; } 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 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.
SkipExternal { get; set; } Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

Remarks

Learn more

See Also