TextSignOptions class Leave feedback
On this page
Represents the Text signature options.
Learn more
- Basic usage of creating Text electronic signature by GroupDocs.Signature: How to eSign document with Text signature
- Advanced usage of settings of Text electronic signature with GroupDocs.Signature: Advanced usage to eSign document with Text signature and additional settings
The TextSignOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of the TextSignOptions class with default values. |
| init | Initializes a new instance of the TextSignOptions class with text. |
| Property | Description |
|---|---|
| background | The signature background settings. |
| border | The border settings. |
| font | The font of the signature. |
| fore_color | The fore color of the signature. |
| form_text_field_title | The title of the text form field to place the text signature into. Can be used only when signature_implementation is set to TextSignatureImplementation.FORM_FIELD. |
| form_text_field_type | The type of form field to place the text signature into. This property is applicable only when signature_implementation is set to TextSignatureImplementation.FORM_FIELD (i.e., TextToFormField). The default value is FormTextFieldType.ALL_TEXT_TYPES. |
| height | The height of the signature on the document page in measure values (pixels, percents, or millimeters). The unit is determined by the SizeMeasureType property. |
| horizontal_alignment | The horizontal alignment of the signature on the document page. |
| left | The left X position of the signature on the document page in measure values (pixels, percents, or millimeters as defined by MeasureType LocationMeasureType property). Works if horizontal alignment is not specified. |
| location_measure_type | The measure type (pixels, percents or millimeters) for left and top properties. |
| margin | The space between the signature and the document edges. Applies only when horizontal or vertical alignment is specified. |
| margin_measure_type | The measure type (pixels, percents or millimeters) for the margin. |
| native | The native attribute. |
| rotation_angle | The rotation angle of the signature on the document page (clockwise). |
| shape_position | The shape position defines where the shape should be presented in the document layout. Available only for Word documents. |
| shape_type | The type of shape to put text. |
| signature_id | The unique ID of the signature, usable in verification options and supported only for PDF documents. |
| signature_implementation | The type of text signature implementation. |
| size_measure_type | The measure type (pixels, percents or millimeters) for Width and Height properties. |
| stretch | The stretch mode on document page. |
| text | The text of the signature. |
| text_horizontal_alignment | The horizontal alignment of text inside a signature, supported only for Image and Annotation signature implementations (see TextSignatureImplementation SignatureImplementation property). |
| text_vertical_alignment | The vertical alignment of text inside a signature. |
| top | The top Y position of the signature on the document page, expressed in measurement units (pixels, percent, or millimeters). |
| transparency | The signature transparency, a float between 0.0 (opaque) and 1.0 (clear). Default is 0.0 (opaque). |
| vertical_alignment | The vertical alignment of the signature on the document page. |
| width | The width of the signature on the document page in measure values (pixels, percents, or millimeters; see MeasureType SizeMeasureType property). |
| all_pages | The signature will be placed on all document pages. (inherited from SignOptions) |
| appearance | The additional signature appearance. (inherited from SignOptions) |
| document_type | The document type of the signature options (DocumentType). (inherited from SignOptions) |
| extensions | The signature extensions. (inherited from SignOptions) |
| hash_algorithm | The hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. (inherited from SignOptions) |
| page_number | The document page number for signing. (inherited from SignOptions) |
| pages_setup | The options to specify pages to be signed. (inherited from SignOptions) |
| signature_type | The signature type (SignatureType). (inherited from SignOptions) |
| zorder | The Z-order position of the text signature, which determines the display order of overlapping signatures. (inherited from SignOptions) |
from groupdocs.signature import Signature
from groupdocs.signature.options import TextSignOptions
def sign_pdf_with_text_signature():
with Signature("sample.pdf") as signature:
options = TextSignOptions("John Smith")
options.left = 100
options.top = 100
result = signature.sign("signed_sample.pdf", options)
print(f"Signatures added: {len(result.succeeded)}")
Task guides that use TextSignOptions:
- Quick Start Guide
- eSign Document with Text Signature
- eSign Document with Multiple Signatures
- Generate signatures preview
- module
groupdocs.signature.options
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
