Groupdocs API References – com.groupdocs.signature.options.search

Nodejs-Java: BarcodeSearchOptions

Mon, 01 Jan 0001 00:00:00 +0000

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

public class BarcodeSearchOptions extends SearchOptions

Represents abstract search Options for Barcode signatures.

Constructors

Constructor	Description
BarcodeSearchOptions()	Initializes a new instance of the SearchBarcodeOptions class with default values.
BarcodeSearchOptions(BarcodeType encodeType)	Initializes a new instance of the SearchBarcodeOptions class with encode type value.
BarcodeSearchOptions(BarcodeType encodeType, String text)	Initializes a new instance of the SearchBarcodeOptions class with encode type and text values.

Methods

Method	Description
getEncodeType()	Specifies Encode Type property to search Barcodes.
setEncodeType(BarcodeType value)	Specifies Encode Type property to search Barcodes.
getText()	Specifies Barcode Signature text if it should be searched and matched.
setText(String value)	Specifies Barcode Signature text if it should be searched and matched.
getMatchType()	Gets or sets Barcode text Match Type search.
setMatchType(int value)	Gets or sets Barcode text Match Type search.
getReturnContent()	Gets or sets flag to grab Barcode image content of signature on document page.
setReturnContent(boolean value)	Gets or sets flag to grab Barcode image content of signature on document page.
getReturnContentType()	Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
setReturnContentType(FileType value)	Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.

BarcodeSearchOptions()

public BarcodeSearchOptions()

Initializes a new instance of the SearchBarcodeOptions class with default values.

BarcodeSearchOptions(BarcodeType encodeType)

public BarcodeSearchOptions(BarcodeType encodeType)

Initializes a new instance of the SearchBarcodeOptions class with encode type value.

Parameters:

Parameter	Type	Description
encodeType	BarcodeType	Specifies Barcode encode type.

BarcodeSearchOptions(BarcodeType encodeType, String text)

public BarcodeSearchOptions(BarcodeType encodeType, String text)

Initializes a new instance of the SearchBarcodeOptions class with encode type and text values.

Parameters:

Parameter	Type	Description
encodeType	BarcodeType	Specifies Barcode encode type.
text	java.lang.String	Set Text of Barcode signature.

getEncodeType()

public final BarcodeType getEncodeType()

Specifies Encode Type property to search Barcodes. If this value is not set, search is processed for all supported Barcode Types

Returns: BarcodeType

setEncodeType(BarcodeType value)

public final void setEncodeType(BarcodeType value)

Specifies Encode Type property to search Barcodes. If this value is not set, search is processed for all supported Barcode Types

Parameters:

Parameter	Type	Description
value	BarcodeType

getText()

public final String getText()

Specifies Barcode Signature text if it should be searched and matched.

Returns: java.lang.String

setText(String value)

public final void setText(String value)

Specifies Barcode Signature text if it should be searched and matched.

Parameters:

Parameter	Type	Description
value	java.lang.String

getMatchType()

public final int getMatchType()

Gets or sets Barcode text Match Type search. It is used only when Text property is set.

Returns: int

setMatchType(int value)

public final void setMatchType(int value)

Gets or sets Barcode text Match Type search. It is used only when Text property is set.

Parameters:

Parameter	Type	Description
value	int

getReturnContent()

public final boolean getReturnContent()

Gets or sets flag to grab Barcode image content of signature on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format ReturnContentType (#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

Returns: boolean

setReturnContent(boolean value)

public final void setReturnContent(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

getReturnContentType()

public final FileType getReturnContentType()

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at BarcodeSignature.Format (BarcodeSignature.getFormat}) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned.

Returns: FileType

setReturnContentType(FileType value)

public final void setReturnContentType(FileType value)

Parameters:

Parameter	Type	Description
value	FileType

Nodejs-Java: CertificateSearchOptions

Mon, 01 Jan 0001 00:00:00 +0000

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

public class CertificateSearchOptions extends SearchOptions

Represents search options for Certificate metadata signatures.

Learn more

Constructor	Description
CertificateSearchOptions()	Initializes a new instance of the TextSearchOptions class with default values.
CertificateSearchOptions(String text)	Initializes a new instance of the TextSearchOptions class with text value.

Methods

Method	Description
getText()	Specifies certificate property text to match on searching.
setText(String value)	Specifies certificate property text to match on searching.
getMatchType()	Gets or sets text match type search.
setMatchType(int value)	Gets or sets text match type search.

CertificateSearchOptions()

public CertificateSearchOptions()

Initializes a new instance of the TextSearchOptions class with default values.

CertificateSearchOptions(String text)

public CertificateSearchOptions(String text)

Initializes a new instance of the TextSearchOptions class with text value.

Parameters:

Parameter	Type	Description
text	java.lang.String	Set Text of Text signature.

getText()

public final String getText()

Specifies certificate property text to match on searching.

Returns: java.lang.String

setText(String value)

public final void setText(String value)

Specifies certificate property text to match on searching.

Parameters:

Parameter	Type	Description
value	java.lang.String

getMatchType()

public final int getMatchType()

Gets or sets text match type search.

Returns: int

setMatchType(int value)

public final void setMatchType(int value)

Gets or sets text match type search.

Parameters:

Parameter	Type	Description
value	int

Nodejs-Java: DigitalSearchOptions

Mon, 01 Jan 0001 00:00:00 +0000

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

public class DigitalSearchOptions extends SearchOptions

Represents base options for Digital signatures search

Constructors

Constructor	Description
DigitalSearchOptions()	Initializes a new instance of the DigitalSearchOptions class with default values.

Methods

Method	Description
getComments()	Comments of Digital signature to search.
setComments(String value)	Comments of Digital signature to search.
getSignDateTimeFrom()	Date and time range of Digital signature to search.
setSignDateTimeFrom(Date value)	Date and time range of Digital signature to search.
getSignDateTimeTo()	Date and time range of Digital Signature to search.
setSignDateTimeTo(Date value)	Date and time range of Digital Signature to search.
getSubjectName()	For non empty values specifies distinguished subject name of the certificate to search.
setSubjectName(String value)	For non empty values specifies distinguished subject name of the certificate to search.
getIssuerName()	For non empty values specifies distinguished name of the certificate issuer to search.
setIssuerName(String value)	For non empty values specifies distinguished name of the certificate issuer to search.

DigitalSearchOptions()

public DigitalSearchOptions()

Initializes a new instance of the DigitalSearchOptions class with default values.

getComments()

public final String getComments()

Comments of Digital signature to search.

Returns: java.lang.String

setComments(String value)

public final void setComments(String value)

Comments of Digital signature to search.

Parameters:

Parameter	Type	Description
value	java.lang.String

getSignDateTimeFrom()

public final Date getSignDateTimeFrom()

Date and time range of Digital signature to search. Nullable value will be ignored.

Returns: java.util.Date

setSignDateTimeFrom(Date value)

public final void setSignDateTimeFrom(Date value)

Date and time range of Digital signature to search. Nullable value will be ignored.

Parameters:

Parameter	Type	Description
value	java.util.Date

getSignDateTimeTo()

public final Date getSignDateTimeTo()

Date and time range of Digital Signature to search. Nullable value will be ignored.

Returns: java.util.Date

setSignDateTimeTo(Date value)

public final void setSignDateTimeTo(Date value)

Date and time range of Digital Signature to search. Nullable value will be ignored.

Parameters:

Parameter	Type	Description
value	java.util.Date

getSubjectName()

public final String getSubjectName()

For non empty values specifies distinguished subject name of the certificate to search.

Returns: java.lang.String

setSubjectName(String value)

public final void setSubjectName(String value)

For non empty values specifies distinguished subject name of the certificate to search.

Parameters:

Parameter	Type	Description
value	java.lang.String

getIssuerName()

public final String getIssuerName()

For non empty values specifies distinguished name of the certificate issuer to search.

Returns: java.lang.String

setIssuerName(String value)

public final void setIssuerName(String value)

For non empty values specifies distinguished name of the certificate issuer to search.

Parameters:

Parameter	Type	Description
value	java.lang.String

Nodejs-Java: FormFieldSearchOptions

Mon, 01 Jan 0001 00:00:00 +0000

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

public class FormFieldSearchOptions extends SearchOptions

Represents abstract search Options for Form-field signatures.

Constructors

Constructor	Description
FormFieldSearchOptions()	Initializes a new instance of the SearchFormFieldOptions class with default values.

Methods

Method	Description
getType()	Specifies type of form field signature if it should be searched.
setType(Integer value)	Specifies type of form field signature if it should be searched.
getName()	Specifies regular expression pattern of form field signature name if it should be searched.
setName(String value)	Specifies regular expression pattern of form field signature name if it should be searched.
getValue()	Specifies value of form field signature if it should be searched.
setValue(Object value)	Specifies value of form field signature if it should be searched.

FormFieldSearchOptions()

public FormFieldSearchOptions()

Initializes a new instance of the SearchFormFieldOptions class with default values.

getType()

public final Integer getType()

Specifies type of form field signature if it should be searched. Default value is null.

Returns: java.lang.Integer

setType(Integer value)

public final void setType(Integer value)

Specifies type of form field signature if it should be searched. Default value is null.

Parameters:

Parameter	Type	Description
value	java.lang.Integer

getName()

public final String getName()

Specifies regular expression pattern of form field signature name if it should be searched. You can use it simple as “text” or regular expression like “abc\d+”. Default value is empty string.

Returns: java.lang.String

setName(String value)

public final void setName(String value)

Specifies regular expression pattern of form field signature name if it should be searched. You can use it simple as “text” or regular expression like “abc\d+”. Default value is empty string.

Parameters:

Parameter	Type	Description
value	java.lang.String

getValue()

public final Object getValue()

Specifies value of form field signature if it should be searched. Default value is null.

Returns: java.lang.Object

setValue(Object value)

public final void setValue(Object value)

Specifies value of form field signature if it should be searched. Default value is null.

Parameters:

Parameter	Type	Description
value	java.lang.Object

Nodejs-Java: ImageSearchOptions

Mon, 01 Jan 0001 00:00:00 +0000

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.

Constructors

Constructor	Description
ImageSearchOptions()	Initializes a new instance of the ImageSearchOptions class with default values.

Methods

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.

ImageSearchOptions()

public ImageSearchOptions()

Initializes a new instance of the ImageSearchOptions class with default values.

getReturnContent()

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

setReturnContent(boolean value)

public final void setReturnContent(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

getMinContentSize()

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

setMinContentSize(long value)

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

getMaxContentSize()

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

setMaxContentSize(long value)

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

getReturnContentType()

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

setReturnContentType(FileType value)

public final void setReturnContentType(FileType value)

Parameters:

Parameter	Type	Description
value	FileType

Nodejs-Java: MetadataSearchOptions

Mon, 01 Jan 0001 00:00:00 +0000

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

public class MetadataSearchOptions extends SearchOptions

Represents abstract search Options for Metadata signatures.

Constructors

Constructor	Description
MetadataSearchOptions()	Initializes a new instance of the SearchMetadataOptions class with default values.

Methods

Method	Description
getName()	Specifies Metadata Signature name if it should be searched and matched.
setName(String value)	Specifies Metadata Signature name if it should be searched and matched.
getNameMatchType()	Gets or sets Metadata name Match Type search.
setNameMatchType(int value)	Gets or sets Metadata name Match Type search.
getIncludeBuiltinProperties()	Indicates if Built-in document properties like Document statistic, information etc should be included into Search result.
setIncludeBuiltinProperties(boolean value)	Indicates if Built-in document properties like Document statistic, information etc should be included into Search result.
getDataEncryption()	Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
setDataEncryption(IDataEncryption value)	Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

MetadataSearchOptions()

public MetadataSearchOptions()

Initializes a new instance of the SearchMetadataOptions class with default values.

getName()

public final String getName()

Specifies Metadata Signature name if it should be searched and matched.

Returns: java.lang.String

setName(String value)

public final void setName(String value)

Specifies Metadata Signature name if it should be searched and matched.

Parameters:

Parameter	Type	Description
value	java.lang.String

getNameMatchType()

public final int getNameMatchType()

Gets or sets Metadata name Match Type search. It is used only when Name property is set.

Returns: int

setNameMatchType(int value)

public final void setNameMatchType(int value)

Gets or sets Metadata name Match Type search. It is used only when Name property is set.

Parameters:

Parameter	Type	Description
value	int

getIncludeBuiltinProperties()

public final boolean getIncludeBuiltinProperties()

Indicates if Built-in document properties like Document statistic, information etc should be included into Search result. This flag has sense for Presentation, Spreadhsheet and Word Processing document file types.

Returns: boolean

setIncludeBuiltinProperties(boolean value)

public final void setIncludeBuiltinProperties(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

getDataEncryption()

public final IDataEncryption getDataEncryption()

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

Returns: IDataEncryption

setDataEncryption(IDataEncryption value)

public final void setDataEncryption(IDataEncryption value)

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

Parameters:

Parameter	Type	Description
value	IDataEncryption

Nodejs-Java: QrCodeSearchOptions

Mon, 01 Jan 0001 00:00:00 +0000

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

public class QrCodeSearchOptions extends SearchOptions

Represents abstract search Options for QR-Code signatures.

Constructors

Constructor	Description
QrCodeSearchOptions()	Initializes a new instance of the QRCodeSearchOptions class with default values.
QrCodeSearchOptions(QrCodeType encodeType)	Initializes a new instance of the QRCodeSearchOptions class with encode type value.
QrCodeSearchOptions(QrCodeType encodeType, String text)	Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.

Methods

Method	Description
getEncodeType()	Specifies Encode Type property to search QR-Codes.
setEncodeType(QrCodeType value)	Specifies Encode Type property to search QR-Codes.
getText()	Specifies QR-Code Signature Text if it should be searched and matched.
setText(String value)	Specifies QR-Code Signature Text if it should be searched and matched.
getMatchType()	Gets or sets QR-Code Text Match Type search.
setMatchType(int value)	Gets or sets QR-Code Text Match Type search.
getDataEncryption()	Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
setDataEncryption(IDataEncryption value)	Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
getReturnContent()	Gets or sets flag to grab QR-Code image content of signature on document page.
setReturnContent(boolean value)	Gets or sets flag to grab QR-Code image content of signature on document page.
getReturnContentType()	Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
setReturnContentType(FileType value)	Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.

QrCodeSearchOptions()

public QrCodeSearchOptions()

Initializes a new instance of the QRCodeSearchOptions class with default values.

QrCodeSearchOptions(QrCodeType encodeType)

public QrCodeSearchOptions(QrCodeType encodeType)

Initializes a new instance of the QRCodeSearchOptions class with encode type value.

Parameters:

Parameter	Type	Description
encodeType	QrCodeType	Specifies QR-Code encode type.

QrCodeSearchOptions(QrCodeType encodeType, String text)

public QrCodeSearchOptions(QrCodeType encodeType, String text)

Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.

Parameters:

Parameter	Type	Description
encodeType	QrCodeType	Specifies QR-Code encode type.
text	java.lang.String	Set Text of QR-Code signature.

getEncodeType()

public final QrCodeType getEncodeType()

Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types.

Returns: QrCodeType

setEncodeType(QrCodeType value)

public final void setEncodeType(QrCodeType value)

Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types.

Parameters:

Parameter	Type	Description
value	QrCodeType

getText()

public final String getText()

Specifies QR-Code Signature Text if it should be searched and matched.

Returns: java.lang.String

setText(String value)

public final void setText(String value)

Specifies QR-Code Signature Text if it should be searched and matched.

Parameters:

Parameter	Type	Description
value	java.lang.String

getMatchType()

public final int getMatchType()

Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

Returns: int

setMatchType(int value)

public final void setMatchType(int value)

Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

Parameters:

Parameter	Type	Description
value	int

getDataEncryption()

public final IDataEncryption getDataEncryption()

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

Returns: IDataEncryption

setDataEncryption(IDataEncryption value)

public final void setDataEncryption(IDataEncryption value)

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

Parameters:

Parameter	Type	Description
value	IDataEncryption

getReturnContent()

public final boolean getReturnContent()

Gets or sets flag to grab QR-Code image content of signature on document page. If this flag is set true, QR-Code signature image content will keep raw image data by required format ReturnContentType (#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

Returns: boolean

setReturnContent(boolean value)

public final void setReturnContent(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

getReturnContentType()

public final FileType getReturnContentType()

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at QrCodeSignature.Format () Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in original .png will be returned.

Returns: FileType

setReturnContentType(FileType value)

public final void setReturnContentType(FileType value)

Parameters:

Parameter	Type	Description
value	FileType

Nodejs-Java: SearchOptions

Mon, 01 Jan 0001 00:00:00 +0000

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 -

Nodejs-Java: TextSearchOptions

Mon, 01 Jan 0001 00:00:00 +0000

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

public class TextSearchOptions extends SearchOptions

Represents search options for Text signatures.

Constructors

Constructor	Description
TextSearchOptions()	Initializes a new instance of the TextSearchOptions class with default values.
TextSearchOptions(String text)	Initializes a new instance of the TextSearchOptions class with text value.

Methods

Method	Description
getText()	Specifies signature text to match on searching.
setText(String value)	Specifies signature text to match on searching.
getMatchType()	Gets or sets text match type search.
setMatchType(int value)	Gets or sets text match type search.
getSignatureImplementation()	Specifies text signature implementation to search.
setSignatureImplementation(Integer value)	Specifies text signature implementation to search.

TextSearchOptions()

public TextSearchOptions()

Initializes a new instance of the TextSearchOptions class with default values.

TextSearchOptions(String text)

public TextSearchOptions(String text)

Initializes a new instance of the TextSearchOptions class with text value.

Parameters:

Parameter	Type	Description
text	java.lang.String	Set Text of Text signature.

getText()

public final String getText()

Specifies signature text to match on searching.

Returns: java.lang.String

setText(String value)

public final void setText(String value)

Specifies signature text to match on searching.

Parameters:

Parameter	Type	Description
value	java.lang.String

getMatchType()

public final int getMatchType()

Gets or sets text match type search.

Returns: int

setMatchType(int value)

public final void setMatchType(int value)

Gets or sets text match type search.

Parameters:

Parameter	Type	Description
value	int

getSignatureImplementation()

public final Integer getSignatureImplementation()

Specifies text signature implementation to search.

Returns: java.lang.Integer

setSignatureImplementation(Integer value)

public final void setSignatureImplementation(Integer value)

Specifies text signature implementation to search.

Parameters:

Parameter	Type	Description
value	java.lang.Integer