Enumeration Types
Enumeration Types
BorderStyle
Specifies the style of border drawn around a signature control.
| Name | Value | Description |
|---|---|---|
| BdrFlat | 0 | Solid border |
| BdrRaised | 5 | 2-pixel wide, 3-d border giving the control the appearance of being raised above its background |
| BdrEtched | 6 | 2-pixel wide, 3-d border with the appearance of a sunken edge. |
| BdrBump | 9 | 2-pixel wide, 3-d border with the appearance of a raised edge. |
| BdrSunken | 10 | 2-pixel wide, 3-d border giving the control the appearance of being sunken into its background |
CaptData
Used to select what data is returned by the SigObj.AdditionalData property.
| Name | Value | Description |
|---|---|---|
| CaptDigitizer | 26 | Identifying information for the digitizer pad |
| CaptDigitizerDriver | 27 | Identifying information for the digitizer pad driver software |
| CaptMachineOS | 28 | Identifying information for computer operating system |
| CaptNetworkCard | 29 | Identifying information for network card |
CaptureData
Return values for legacy SigCtlXHTML Capture method. Obsolete.
CaptureResult
Returned by the Capture methods of the SigCtrl & SigCtrlXHTML.
| Name | Value | Description |
|---|---|---|
| CaptureOK | 0 | Signature captured successfully. |
| CaptureCancel | 1 | Signature not captured because user cancelled Signature Capture Window. |
| CapturePadError | 100 | No capture service available; typically, no functioning digitizing tablet or other device for capturing signatures found. |
| CaptureError | 101 | System error or some other unusual error condition. |
| CaptureIntegrityKeyInvalid | 102 | The integrity key parameter is invalid (obsolete) |
| CaptureNotLicensed | 103 | The component has not been licensed to perform capture. |
| CaptureAbort | 200 | Signature not captured because the handler for the PreCapture event returned False. |
DisplayMode
Specifies the method used to draw a signature within a signature control and by the RenderRect method.
| Name | Value | Description |
|---|---|---|
| DspForceFit | 0 | Scale signature to fit the area |
| DspUseZoom | 1 | Use the Zoom property/parameter to scale the signature relative to actual size. |
| DspBestFit | 2 | Reduce size of signature to fit display area if it is too big, but otherwise show at true size. |
HashType
Specifies the hashing algorithm used by the Hash object.
| Name | Value | Description |
|---|---|---|
| HashNone | 0 | No hashing algorithm selected |
| HashMD5 | 1 | MD5 hashing algorithm |
| HashSHA1 | 2 | SHA-1 hashing algorithm |
| HashSHA224 | 3 | SHA-224 hashing algorithm |
| HashSHA256 | 4 | SHA-256 hashing algorithm |
| HashSHA384 | 5 | SHA-384 hashing algorithm |
| HashSHA512 | 6 | SHA-512 hashing algorithm |
IntegrityStatus
Returned by the CheckIntegrity method of the SigObj interface.
| Name | Value | Description |
|---|---|---|
| IntegrityOK | 0 | Data has not changed since signature capture |
| IntegrityFail | 1 | Data has changed since signature capture |
| IntegrityMissing | 2 | Signature integrity value not found |
| IntegrityWrongType | 3 | Signature was captured using a different integrity check version |
| IntegrityInsufficientData | 4 | MD5MAC key value is required in order to check integrity |
| IntegrityUncertain | 5 | Unable to check integrity. Obsolete |
| IntegrityUnsupported | 6 | Integrity type not supported on the current platform |
KeyType
Specifies the type of a Key object.
| Name | Value | Description |
|---|---|---|
| KeyNone | 0 | No key type set |
| KeyMD5 | 1 | MD5 key |
| KeyMD5MAC | 2 | MD5 MAC key |
| KeySHA1 | 3 | SHA-1 key |
| KeySHA224 | 4 | SHA-224 key |
| KeySHA256 | 5 | SHA-256 key |
| KeySHA384 | 6 | SHA-384 key |
| KeySHA512 | 7 | SHA-512 key |
RBFlags
Bitmask flags supplied to RenderBitmap to select the required options.
| Name | Value | Description |
|---|---|---|
| RenderOutputBase64 | 0x002000 | Return bitmap as a base-64 encoded string |
| RenderOutputBinary | 0x000800 | Return bitmap as binary data |
| RenderOutputFilename | 0x001000 | Write bitmap to file |
| RenderOutputPicture | 0x200000 | Return bitmap as Picture object |
| RenderBackground Transparent | 0x010000 | Render image with a transparent background |
| RenderColor1BPP | 0x020000 | Render using 1 bit-per-pixel (monochrome) |
| RenderColor24BPP | 0x040000 | Render colour image with 24 bits-per-pixel |
| RenderColor32BPP | 0x080000 | Render colour image with 32 bits-per-pixel |
| RenderColorAntiAlias | 0x100000 | Render colour image with antialiasing |
| RenderEncodeData | 0x400000 | Encode signature data within image |
| RenderWatermark | 0x800000 | Encode watermark within image |
| RenderClipped | 0x1000000 | Crop signature image, omitting any parts which were outside of the original capture window |
| RenderRelative | 0x2000000 | Renders the signature image relative to the origin of the original capture window |
ReadEncodedBitmapResult
Result returned by the ReadEncodedBitmap method.
| Name | Value | Description |
|---|---|---|
| ReadEncodedBitmapOK | 0 | Signature data decoded OK |
| ReadEncodedBitmapFileNotFound | 1 | File not found |
| ReadEncodedBitmapNotImage | 2 | Bitmap is not a supported image type |
| ReadEncodedBitmapSigDataNotFound | 3 | Encoded signature data not found in image |
ShowText
Used to specify if and how "act of signing" information (who signed and/or when) is displayed within the control.
| Name | Value | Description |
|---|---|---|
| TxtDontShow | 0 | Don't display the information |
| TxtShowLeft | 1 | Display the information left aligned within the control |
| TxtShowCenter | 2 | Display the information centred within the control |
| TxtShowRight | 4 | Display the information right aligned within the control |
SignedData
Returned by the CheckSignedData method of the SigObj interface.
| Name | Value | Description |
|---|---|---|
| DataGood | 0 | Data has not changed signature capture |
| DataNoHash | 1 | No signature captured, or signature was captured without a hash |
| DataBadType | 2 | Signature was captured with a different type of hash |
| DataBadHash | 3 | Data has changed since signature capture |
| DataError | 4 | Error whilst checking signed data |
| DataUncertain | 5 | Unable to check status of data. Obsolete |
| DataSigMoved | 6 | The position of the SigCtlXHTML control within the HTML document has been changed |
TimeZone
Used to select time zone for time returned by 'When' parameter.
| Name | Value | Description |
|---|---|---|
| TimeLocal | 0 | Local time when signature was captured |
| TimeGMT | 1 | Greenwich Mean Time |
| TimeUTC | 1 | Universal Coordinated Time (synonym for TimeGMT) |