BarcodeSignOptions class
BarcodeSignOptions class
Represents the Barcode signature options.
Inheritance: BarcodeSignOptions
→
TextSignOptions
→
SignOptions
The BarcodeSignOptions type exposes the following members:
Constructors
Constructor | Description |
---|---|
init | Initializes a new instance of the BarcodeSignOptions class with default values. |
init | Initializes a new instance of the BarcodeSignOptions 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 Barcode 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 Barcode type. |
inner_margins | Gets or sets the space between Barcode elements and result image borders. |
code_text_alignment | Gets or sets the alignment of text in the result Barcode image.
Default value is None. |
return_content | Gets or sets flag to get Barcode image content of a signature which was put on document page.
If this flag is set true, Barcode signature image content will keep raw image data by required format BarcodeSignOptions.return_content_type .
By default this option is disabled. |
return_content_type | 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
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. |
Remarks
Learn more | | | |
See Also
- module
groupdocs.signature.options
- class
BarcodeSignOptions
- class
DocumentType
- class
MeasureType
- class
SignOptions
- class
SignatureType
- class
TextSignOptions
- class
TextSignatureImplementation