SigCtlXHTML
SigCtlXHTML
Summary
| Method | |
|---|---|
| (as SigCtl) | |
| CheckHostDocument | |
| CheckHostDocument2 | |
| GetProperty | |
| InsertMarkup | |
| SetProperty | |
| Property | |
|---|---|
| (as SigCtl) | |
| Printer | |
| Event | |
|---|---|
| (as SigCtl) | |
Extends SigCtl, the additions are indicated below.
Methods
CheckHostDocument
Recalculates the document hash to determine whether any changes have been made since signing. The methods call SigObj.CheckSignedData with the necessary Hash data.
| SignedData CheckHostDocument() | |
|---|---|
| Parameters | |
| None | |
| Return Value | |
| SignedData |
CheckHostDocument2
Recalculates the document hash and compares it with a value stored within the HTML document itself, e.g.:
<!-- DocHash:081726885B7A342A74 -->The hash is inserted by a Wacom HTML converter component and is used to check that documents are not changed prior to signing.
| SignedData CheckHostDocument2() | |
|---|---|
| Parameters | |
| None | |
| Return Value | |
| SignedData |
InsertMarkup
Inserts text into an HTML element. Only plain text will be allowed. It will be assigned to the innerText property of the element. The HTML element must be empty (contain no text or child elements) and the control must not contain a captured signature.
If a signature with associated markup is re-captured, markup will be removed from the document and lost. In order to re-capture with markup, first clear the signature and re-insert markup.
Attempting to insert markup into an element that does not exist or is not empty, or calling the method on a control that contains a signature will result in an exception being thrown in JavaScript.
| Void InsertMarkup(Id, Text) | |
|---|---|
| Parameters | |
| Id | String specifying the id of an HTML element in which to insert text. |
| Text | Text to insert. |
| Return Value | |
| None | |
Properties
| Property | Property Type | SigCtlXHTML Property Description |
|---|---|---|
See SigCtl Properties | ||
Printer | PrintObj | Creates and returns a PrintObj object. Deprecated. (Read-only) |
Properties supported by GetProperty/SetProperty
| Name | Get/Set Type | Description |
As SigCtl supported properties with the modification: | ||
Document_HashType | HashType | The HashType used for hash creation prior to signature capture. Only supported in SigCtlXHTML |
DisablePropertyChange | Not supported in SigCtlXHTML | |
PostCapture | Not supported in SigCtlXHTML |
Events
As SigCtl