SearchOptions Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.signature.options.OptionsExtensions
public abstract class SearchOptions extends OptionsExtensions
Represents the extract signatures from document options.
| Method | Description |
|---|---|
| getPageNumber() | Gets or sets Document page number for searching. |
| setPageNumber(Integer value) | Gets or sets Document page number for searching. |
| getPagesSetup() | Options to specify pages for Signature searching. |
| setPagesSetup(PagesSetup value) | Options to specify pages for Signature searching. |
| getAllPages() | Flag to search on each Document page. |
| setAllPages(boolean value) | Flag to search on each Document page. |
| getSkipExternal() | Flag to return only signatures marked as IsSignature. |
| setSkipExternal(boolean value) | Flag to return only signatures marked as IsSignature. |
| getSearchPages(int totalPages) | Virtual method to get list of pages for Signature extraction. |
| toString() | Override string conversion. |
public final Integer getPageNumber()
Gets or sets Document page number for searching. Value is optional.
Returns: java.lang.Integer
public final void setPageNumber(Integer value)
Gets or sets Document page number for searching. Value is optional.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Integer |
public final PagesSetup getPagesSetup()
Options to specify pages for Signature searching.
Returns: PagesSetup
public final void setPagesSetup(PagesSetup value)
Options to specify pages for Signature searching.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PagesSetup |
public final boolean getAllPages()
Flag to search on each Document page. By default this value is set to true.
Returns: boolean
public final void setAllPages(boolean value)
Flag to search on each Document page. By default this value is set to true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final boolean getSkipExternal()
Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.
Returns: boolean
public final void setSkipExternal(boolean value)
Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public System.Collections.Generic.List<Integer> getSearchPages(int totalPages)
Virtual method to get list of pages for Signature extraction.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| totalPages | int | Total count of pages |
Returns: com.aspose.ms.System.Collections.Generic.List<java.lang.Integer> - List of page numbers
public String toString()
Override string conversion.
Returns: java.lang.String -
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.