DdsSignatureTagHelper class | QSYS API Reference Guide
Estimated reading time: 2 minutes
Defines an element where a signature can be captured
Namespace: ASNA.QSys.Expo.Tags Assembly: ASNA.QSys.Expo.Tags.dll
Inheritance: Object –> TagHelper –> FieldBase –> DdsFieldBase
Remarks
DdsSignature Tag Helper provides a Display element that shows a depiction of a hand written signature.
When bound to an input-capable field in the Model, it allows to capture the signature by recording a series of line and curve sketches using an input device (such as mouse, or finger movements on a touch device).
The DdsSignature Tag Helper can be configured to add a date stamp (in the form of a watermark), to set a reference for the signature creation.
The field bound to the Model is a FixedString that holds the depiction of the signature as an Base64-encoded SVG image. SVG images provide a compact lossless image format that can be converted to any other Raster image format (png, jpeg, etc.)
When the sketches of the signature being captured should exceeds the length of the field bound to it, the DdsSignature Tag Helper will simplify the SVG (lowering its quality) to make it fit into the allocated length.
Properties
| Type | Name | Description |
|---|---|---|
| String | AspectRatio | Gets or sets the aspect-ratio of the image used to paint or capture the signature. Format is width:height (in dimension proportion units). Defaults to 3:1 |
| CharAttribute | CharAttribute | Gets the CharAttribute attribute from the Model |
| Boolean | DateStampWhenSigning | Gets or sets value indicating if the date should be stamped at the time the signature was captured |
| FieldAttribute | FieldAttribute | Gets the FieldAttribute from the Model |
| String | InvalidEmptySignatureErrorText | Gets or sets value indicating that the user did not draw enough strokes to make a valid signature |
| String | PenDownOutsideSignatureWarningText | Gets or sets value indicating that the user is tracing strokes outside the capture area of the box |
| String | SignatureIsTooElaborateWarningText | Gets or sets a value that displays as a warning when the image is too commplex to be stored in an encoded string (exceeds max. field length) |
| String | SignEditorCancelButtonText | Gets or sets the stroke editor’s Cancel button text |
| String | SignEditorDoneButtonText | Gets or sets the stroke editor’s Done button text |
| String | SignEditorEraseButtonText | Gets or sets the stroke editor’s Erase button text |
| String | SignEditorTitleText | Gets or sets the stroke editor’s Title text |
| String | SignLinkText | Gets or sets the value of the label used as a link to the image stroke editor |
| Int32 | ValueFieldLength | Gets or sets value defining the maximum length of the field which holds the image encoded |