SearchOptions

Inheritance: java.lang.Object, com.groupdocs.signature.options.OptionsExtensions

public abstract class SearchOptions extends OptionsExtensions

Represents the extract signatures from document options.

Methods

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.

getPageNumber()

public final Integer getPageNumber()

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

Returns: java.lang.Integer

setPageNumber(Integer value)

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

getPagesSetup()

public final PagesSetup getPagesSetup()

Options to specify pages for Signature searching.

Returns: PagesSetup

setPagesSetup(PagesSetup value)

public final void setPagesSetup(PagesSetup value)

Options to specify pages for Signature searching.

Parameters:

Parameter	Type	Description
value	PagesSetup

getAllPages()

public final boolean getAllPages()

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

Returns: boolean

setAllPages(boolean value)

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

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.

Returns: boolean

setSkipExternal(boolean value)

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

getSearchPages(int totalPages)

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

toString()

public String toString()

Override string conversion.

Returns: java.lang.String -