VisualWikitext
 
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
===Name===
 +
signature
 +
===Type===
 +
_input
 +
===Synopsis===
 +
How to render a signature field
 +
===Description===
 +
A signature field allows person to add a signature to a form.
 +
===Parameters===
 +
type="signature"
  
 +
 +
<nowiki>*</nowiki> = means required
 +
 +
'''fname'''*
 +
 +
''type : text''
 +
 +
Name of the file to be placed in the Wiki
 +
 +
'''ftype'''*
 +
 +
''type : text''
 +
 +
Filetype. Either png, svg or jpg
 +
 +
'''pagecontent'''*
 +
 +
''type : text''
 +
 +
The (text-) content that goes on the page when saving to the wiki
 +
 +
'''class'''
 +
 +
''type : text''
 +
 +
Adds an additional CSS class to the signature canvas.
 +
 +
By default the signature canvas will always get class: wsform-signature.
 +
 +
'''clearbuttonclass'''
 +
 +
''type : text''
 +
 +
Adds an additional CSS class to the clear button to clear the canvas.
 +
 +
By default the clear button will always get class: wsform-signature-clear.
 +
 +
'''clearbuttontext'''
 +
 +
''type : text''
 +
 +
Text to be placed in the clear button. Default to Clear.
 +
 +
'''background'''
 +
 +
''type : color. Either hexadecimal, CSS color name or css rgb value''
 +
 +
Background color for the signature field
 +
 +
'''drawcolor'''
 +
 +
''type : color. Either hexadecimal, CSS color name or css rgb value''
 +
 +
Color of the signature pen
 +
 +
'''thickness'''
 +
 +
''type : integer''
 +
 +
Thickness of the signature pen
 +
 +
'''notavailablemessage'''
 +
 +
''type : text''
 +
 +
When a browser does not support the signature canvas, this message will be displayed.
 +
 +
Default message : "Your browser doesn't support signing"
 +
 +
'''guideline'''
 +
 +
''type : text''
 +
 +
Show a horizontal line to guide when writing a signature.
 +
 +
Use guideline="true" is the only way to show the guideline.
 +
 +
Please note that the guideline will be saved together with the signature, unless you choose svg as file type.
 +
 +
Additional guideline option, available when guideline is set to true
 +
 +
- '''guidelineoffset'''
 +
 +
''type: integer''
 +
 +
Offset from the bottom of the canvas
 +
 +
- '''guidelineindent'''
 +
 +
''type: integer''
 +
 +
Margin left and right from the line to the side of the canvas
 +
 +
'''- guidelinecolor'''
 +
 +
''type : color. Either hexadecimal, CSS color name or css rgb value''
 +
 +
Color for the guideline
 +
 +
All other valid parameters for an input field are valid
 +
===Example===
 +
<syntaxhighlight lang="html">
 +
<_input type="signature" fname="Signature-test" ftype="png" pagecontent="test" guideline="true" clearbuttonclass="btn btn-primary" />
 +
</syntaxhighlight>
 +
<_input type="signature" fname="Signature-test" ftype="png" pagecontent="test" guideline="true" clearbuttonclass="btn btn-primary" />
 +
===Note===
 +
''Only one signature field per form is supported!''
 +
===Links===
ws-class-props
Line 1: Line 1:
−
 
+
{{Doc properties
 +
|Doc subject=DevOps:Doc/FlexForm
 +
|Subject version=1.1
 +
|Doc parent=DevOps:Doc/FlexForm/1.0/input
 +
|Doc sort order=110
 +
|Doc target group=User
 +
|Doc synopsis=How to render a signature field
 +
}}
ws-page-props
Line 1: Line 1:
−
{{Doc properties
+
 
−
|Subject version=1.0
 
−
|Doc subject=DevOps:Doc/FlexForm
 
−
}}
 

Latest revision as of 14:00, 22 September 2022

Name

signature

Type

_input

Synopsis

How to render a signature field

Description

A signature field allows person to add a signature to a form.

Parameters

type="signature"


* = means required

fname*

type : text

Name of the file to be placed in the Wiki

ftype*

type : text

Filetype. Either png, svg or jpg

pagecontent*

type : text

The (text-) content that goes on the page when saving to the wiki

class

type : text

Adds an additional CSS class to the signature canvas.

By default the signature canvas will always get class: wsform-signature.

clearbuttonclass

type : text

Adds an additional CSS class to the clear button to clear the canvas.

By default the clear button will always get class: wsform-signature-clear.

clearbuttontext

type : text

Text to be placed in the clear button. Default to Clear.

background

type : color. Either hexadecimal, CSS color name or css rgb value

Background color for the signature field

drawcolor

type : color. Either hexadecimal, CSS color name or css rgb value

Color of the signature pen

thickness

type : integer

Thickness of the signature pen

notavailablemessage

type : text

When a browser does not support the signature canvas, this message will be displayed.

Default message : "Your browser doesn't support signing"

guideline

type : text

Show a horizontal line to guide when writing a signature.

Use guideline="true" is the only way to show the guideline.

Please note that the guideline will be saved together with the signature, unless you choose svg as file type.

Additional guideline option, available when guideline is set to true

- guidelineoffset

type: integer

Offset from the bottom of the canvas

- guidelineindent

type: integer

Margin left and right from the line to the side of the canvas

- guidelinecolor

type : color. Either hexadecimal, CSS color name or css rgb value

Color for the guideline

All other valid parameters for an input field are valid

Example

<_input type="signature" fname="Signature-test" ftype="png" pagecontent="test" guideline="true" clearbuttonclass="btn btn-primary" />

Missing attribute "name" for signature field.

Note

Only one signature field per form is supported!

Links

Retrieved from "https://www.open-csp.org/index.php?title=DevOps:Doc/FlexForm/1.0/input/signature&oldid=1446"