com.groupdocs.signature.options.search

Class SearchOptions

java.lang.Object

com.groupdocs.signature.options.OptionsExtensions

com.groupdocs.signature.options.search.SearchOptions

Direct Known Subclasses:

BarcodeSearchOptions, DigitalSearchOptions, FormFieldSearchOptions, ImageSearchOptions, MetadataSearchOptions, QrCodeSearchOptions, TextSearchOptions

public abstract class SearchOptions
extends com.groupdocs.signature.options.OptionsExtensions

Represents the extract signatures from document options.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SearchOptions(int searchType) Initializes a new instance of the ExtractOptions class.

Method Summary

Modifier and Type	Method and Description
boolean	getAllPages() Flag to search on each Document page.
Integer	getPageNumber() Gets or sets Document page number for searching.
PagesSetup	getPagesSetup() Options to specify pages for Signature searching.
com.aspose.ms.System.Collections.Generic.List<Integer>	getSearchPages(int totalPages) Virtual method to get list of pages for Signature extraction.
boolean	getSkipExternal() Flag to return only signatures marked as IsSignature.
void	setAllPages(boolean value) Flag to search on each Document page.
void	setPageNumber(Integer value) Gets or sets Document page number for searching.
void	setPagesSetup(PagesSetup value) Options to specify pages for Signature searching.
void	setSkipExternal(boolean value) Flag to return only signatures marked as IsSignature.
String	toString() Override string conversion.

Methods inherited from class com.groupdocs.signature.options.OptionsExtensions

typeName, typeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchOptions

protected SearchOptions(int searchType)

Initializes a new instance of the ExtractOptions class.

Method Detail

getAllPages

public final boolean getAllPages()

Flag to search on each Document page. By default this value is set to true.

getPageNumber

public final Integer getPageNumber()

Gets or sets Document page number for searching. Value is optional.

getPagesSetup

public final PagesSetup getPagesSetup()

Options to specify pages for Signature searching.

getSearchPages

public com.aspose.ms.System.Collections.Generic.List<Integer> getSearchPages(int totalPages)

Virtual method to get list of pages for Signature extraction.

Parameters:

totalPages - Total count of pages

Returns:

List of page numbers

getSkipExternal

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.

setAllPages

public final void setAllPages(boolean value)

Flag to search on each Document page. By default this value is set to true.

setPageNumber

public final void setPageNumber(Integer value)

Gets or sets Document page number for searching. Value is optional.

setPagesSetup

public final void setPagesSetup(PagesSetup value)

Options to specify pages for Signature searching.

setSkipExternal

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.

toString

public String toString()

Override string conversion.

Overrides:

toString in class Object

Returns: