QrCodeSearchOptions

QrCodeSearchOptions class

Represents search options for QR-Code signatures.

public class QrCodeSearchOptions : SearchOptions

Constructors

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

Properties

Name Description
AllPages { get; set; } Flag to search on each Document page. By default this value is set to true.
DataEncryption { get; set; } Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
EncodeType { get; set; } Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types.
MatchType { get; set; } Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.
PageNumber { get; set; } Gets or sets Document page number for searching. Value is optional.
PagesSetup { get; set; } Options to specify pages for Signature searching.
ReturnContent { get; set; } 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. By default this option is disabled.
ReturnContentType { get; set; } 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 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.
ShapePosition { get; set; } Flag to return specify shape position in the document layout. Avaliable only for Word documents
SkipExternal { get; set; } Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.
Text { get; set; } Specifies QR-Code Signature Text if it should be searched and matched.

Remarks

Learn more

See Also