ImageSearchOptions Leave feedback
On this page
Represents search options for Image signatures.
public class ImageSearchOptions : SearchOptions
| Name | Description |
|---|---|
| ImageSearchOptions() | Initializes a new instance of the ImageSearchOptions class with default values. |
| 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. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| 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. |
Learn more
- Basic usage of search for Image electronic signature by GroupDocs.Signature: How to eSearch Image signatures in a document
- Advanced usage of settings of search for Image electronic signature with GroupDocs.Signature: Advanced usage of eSearch Image signatures in a document and additional settings
- class SearchOptions
- namespace GroupDocs.Signature.Options
- assembly GroupDocs.Signature
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.