ImageSearchOptions Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
public class ImageSearchOptions extends SearchOptions
Represents search options for Image signatures.
| Constructor | Description |
|---|---|
| ImageSearchOptions() | Initializes a new instance of the ImageSearchOptions class with default values. |
| Method | Description |
|---|---|
| getReturnContent() | Gets or sets flag to grab image content of signature on document page. |
| setReturnContent(boolean value) | Gets or sets flag to grab image content of signature on document page. |
| getMinContentSize() | For non zero value this flag specifies minimal size of images for search criteria. |
| setMinContentSize(long value) | For non zero value this flag specifies minimal size of images for search criteria. |
| getMaxContentSize() | For non zero value this flag specifies maximum size of images for search criteria. |
| setMaxContentSize(long value) | For non zero value this flag specifies maximum size of images for search criteria. |
| getReturnContentType() | Specifies file type of returned content of the image signature when ReturnContent property is enabled. |
| setReturnContentType(FileType value) | Specifies file type of returned content of the image signature when ReturnContent property is enabled. |
public ImageSearchOptions()
Initializes a new instance of the ImageSearchOptions class with default values.
public final boolean getReturnContent()
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 (#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.
Returns: boolean
public final void setReturnContent(boolean value)
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 (#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final long getMinContentSize()
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.
Returns: long
public final void setMinContentSize(long value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | long |
public final long getMaxContentSize()
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.
Returns: long
public final void setMaxContentSize(long value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | long |
public final FileType getReturnContentType()
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.
Returns: FileType
public final void setReturnContentType(FileType value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | FileType |
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.