QrCodeSignOptions class

QrCodeSignOptions class

Represents the QR-Code signature options.

Inheritance: QrCodeSignOptions → TextSignOptions → SignOptions

The QrCodeSignOptions type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of the QRCodeSignOptions class with default values.
init Initializes a new instance of the QRCodeSignOptions class with text.
init Initializes a new instance of the BarcodeSignOptions class with text.

Properties

Property Description
page_number Gets or sets document page number for signing.
Minimal and default value is 1.
all_pages Put signature on all document pages.
appearance Additional signature appearance.
extensions Signature Extensions.
pages_setup Options to specify pages to be signed.
signature_type Get the Signature Type SignatureType
document_type Get or set the Document Type of the Signature Options DocumentType
z_order Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.
hash_algorithm Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.
left Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
(works if horizontal alignment is not specified).
top Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
(works if vertical alignment is not specified).
width Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).
height Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).
location_measure_type Measure type (pixels, percents or millimeters) for Left and Top properties.
size_measure_type Measure type (pixels, percents or millimeters) for Width and Height properties.
stretch Stretch mode on Document Page.
rotation_angle Rotation angle of signature on document page (clockwise).
horizontal_alignment Horizontal alignment of signature on document page.
vertical_alignment Vertical alignment of signature on document page.
margin Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).
margin_measure_type Gets or sets the measure type (pixels, percents or millimeters) for Margin.
transparency Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).
text Gets or sets the text of signature.
font Gets or sets the font of signature.
fore_color Gets or sets the Fore color of QR-Code bars
Using of this property could cause problems with verification. Use it carefully.
signature_implementation Gets or sets the type of text signature implementation.
text_horizontal_alignment Horizontal alignment of text inside a signature.
This feature is supported only for Image and Annotation signature implementations
(see TextSignatureImplementation SignatureImplementation property).
text_vertical_alignment Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see TextSignatureImplementation SignatureImplementation property).
form_text_field_title Gets or sets the title of text form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.
form_text_field_type Gets or sets the type of form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.
Value by default is AllTextTypes.
shape_type Gets or sets the type of shape to put text.
This property could be used only with SignatureImplementation = TextStamp.
Value by default is Rectangle.
signature_id Gets or sets the unique ID of signature. It can be used in signature verification options.
Property is supported for Pdf documents only.
border Specify border settings
background Gets or sets the signature background settings.
native Gets or sets the native attribute. If it is set document specific signatures could be used.
Native text watermark for WordProcessing documents is different than regular, for example.
shape_position Defines where shape should be presented in the document layout. Avaliable only for Word documents
encode_type Gets or sets QR-Code type.
inner_margins Gets or sets the space between QR-Code elements and result image borders.
code_text_alignment Gets or sets the alignment of text in the result QR-code image.
Default value is None.
logo_file_path Gets or sets the QR-code logo image file name.
This property in use only if LogoStream is not specified.
Using of this property could cause problems with verification. Use it carefully.
logo_stream Gets or sets the QR-code logo image stream.
If this property is specified it is always used instead LogoFilePath.
Using of this property could cause problems with verification. Use it carefully.
data Gets or sets custom object to serialize to QR-Code content.
data_encryption Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
return_content Gets or sets flag to get QR-Code image content of a signature which was put on document page.
If this flag is set true, QR-Code signature image content will keep raw image data by required format QrCodeSignOptions.return_content_type.
By default this option is disabled.
return_content_type 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 .png format will be returned.

Remarks

Learn more | | | |

See Also

QrCodeSearchOptions class QrCodeVerifyOptions class