SignatureLine class

SignatureLine class

Provides access to signature line properties. To learn more, visit the Work with Digital Signatures documentation article.

Properties

NameDescription
allow_commentsGets or sets a value indicating that the signer can add comments in the Sign dialog. Default value for this property is False.
default_instructionsGets or sets a value indicating that default instructions is shown in the Sign dialog. Default value for this property is True.
emailGets or sets suggested signer’s e-mail address. Default value for this property is empty string ().
idGets or sets identifier for this signature line. This identifier can be associated with a digital signature, when signing document using DigitalSignatureUtil. This value must be unique and by default it is randomly generated new Guid ().
instructionsGets or sets instructions to the signer that are displayed on signing the signature line. This property is ignored if SignatureLine.default_instructions is set. Default value for this property is empty string ().
is_signedIndicates that signature line is signed by digital signature.
is_validIndicates that signature line is signed by digital signature and this digital signature is valid.
provider_idGets or sets signature provider identifier for this signature line. Default value is “{00000000-0000-0000-0000-000000000000}”.
show_dateGets or sets a value indicating that sign date is shown in the signature line. Default value for this property is True.
signerGets or sets suggested signer of the signature line. Default value for this property is empty string ().
signer_titleGets or sets suggested signer’s title (for example, Manager). Default value for this property is empty string ().

Examples

Shows how to create a line for a signature and insert it into a document.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
options = aw.SignatureLineOptions()
options.allow_comments = True
options.default_instructions = True
options.email = 'john.doe@management.com'
options.instructions = 'Please sign here'
options.show_date = True
options.signer = 'John Doe'
options.signer_title = 'Senior Manager'
# Insert a shape that will contain a signature line, whose appearance we will
# customize using the "SignatureLineOptions" object we have created above.
# If we insert a shape whose coordinates originate at the bottom right hand corner of the page,
# we will need to supply negative x and y coordinates to bring the shape into view.
shape = builder.insert_signature_line(signature_line_options=options, horz_pos=aw.drawing.RelativeHorizontalPosition.RIGHT_MARGIN, left=-170, vert_pos=aw.drawing.RelativeVerticalPosition.BOTTOM_MARGIN, top=-60, wrap_type=aw.drawing.WrapType.NONE)
self.assertTrue(shape.is_signature_line)
# Verify the properties of our signature line via its Shape object.
signature_line = shape.signature_line
self.assertEqual('john.doe@management.com', signature_line.email)
self.assertEqual('John Doe', signature_line.signer)
self.assertEqual('Senior Manager', signature_line.signer_title)
self.assertEqual('Please sign here', signature_line.instructions)
self.assertTrue(signature_line.show_date)
self.assertTrue(signature_line.allow_comments)
self.assertTrue(signature_line.default_instructions)
doc.save(file_name=ARTIFACTS_DIR + 'Shape.SignatureLine.docx')

See Also

ShapeType enumeration SoftEdgeFormat class