Skip to main content

Enumeration Types

Enumeration Types

BorderStyle

Specifies the style of border drawn around a signature control.

NameValueDescription
BdrFlat0Solid border
BdrRaised52-pixel wide, 3-d border giving the control the appearance of being raised above its background
BdrEtched62-pixel wide, 3-d border with the appearance of a sunken edge.
BdrBump92-pixel wide, 3-d border with the appearance of a raised edge.
BdrSunken102-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.

NameValueDescription
CaptDigitizer26Identifying information for the digitizer pad
CaptDigitizerDriver27Identifying information for the digitizer pad driver software
CaptMachineOS28Identifying information for computer operating system
CaptNetworkCard29Identifying information for network card

CaptureData

Return values for legacy SigCtlXHTML Capture method. Obsolete.

CaptureResult

Returned by the Capture methods of the SigCtrl & SigCtrlXHTML.

NameValueDescription
CaptureOK0Signature captured successfully.
CaptureCancel1Signature not captured because user cancelled Signature Capture Window.
CapturePadError100No capture service available; typically, no functioning digitizing tablet or other device for capturing signatures found.
CaptureError101System error or some other unusual error condition.
CaptureIntegrityKeyInvalid102The integrity key parameter is invalid (obsolete)
CaptureNotLicensed103The component has not been licensed to perform capture.
CaptureAbort200Signature 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.

NameValueDescription
DspForceFit0Scale signature to fit the area
DspUseZoom1Use the Zoom property/parameter to scale the signature relative to actual size.
DspBestFit2Reduce 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.

NameValueDescription
HashNone0No hashing algorithm selected
HashMD51MD5 hashing algorithm
HashSHA12SHA-1 hashing algorithm
HashSHA2243SHA-224 hashing algorithm
HashSHA2564SHA-256 hashing algorithm
HashSHA3845SHA-384 hashing algorithm
HashSHA5126SHA-512 hashing algorithm

IntegrityStatus

Returned by the CheckIntegrity method of the SigObj interface.

NameValueDescription
IntegrityOK0Data has not changed since signature capture
IntegrityFail1Data has changed since signature capture
IntegrityMissing2Signature integrity value not found
IntegrityWrongType3Signature was captured using a different integrity check version
IntegrityInsufficientData4MD5MAC key value is required in order to check integrity
IntegrityUncertain5Unable to check integrity. Obsolete
IntegrityUnsupported6Integrity type not supported on the current platform

KeyType

Specifies the type of a Key object.

NameValueDescription
KeyNone0No key type set
KeyMD51MD5 key
KeyMD5MAC2MD5 MAC key
KeySHA13SHA-1 key
KeySHA2244SHA-224 key
KeySHA2565SHA-256 key
KeySHA3846SHA-384 key
KeySHA5127SHA-512 key

RBFlags

Bitmask flags supplied to RenderBitmap to select the required options.

NameValueDescription
RenderOutputBase640x002000Return bitmap as a base-64 encoded string
RenderOutputBinary0x000800Return bitmap as binary data
RenderOutputFilename0x001000Write bitmap to file
RenderOutputPicture0x200000Return bitmap as Picture object
RenderBackground Transparent0x010000Render image with a transparent background
RenderColor1BPP0x020000Render using 1 bit-per-pixel (monochrome)
RenderColor24BPP0x040000Render colour image with 24 bits-per-pixel
RenderColor32BPP0x080000Render colour image with 32 bits-per-pixel
RenderColorAntiAlias0x100000Render colour image with antialiasing
RenderEncodeData0x400000Encode signature data within image
RenderWatermark0x800000Encode watermark within image
RenderClipped0x1000000Crop signature image, omitting any parts which were outside of the original capture window
RenderRelative0x2000000Renders the signature image relative to the origin of the original capture window

ReadEncodedBitmapResult

Result returned by the ReadEncodedBitmap method.

NameValueDescription
ReadEncodedBitmapOK0Signature data decoded OK
ReadEncodedBitmapFileNotFound1File not found
ReadEncodedBitmapNotImage2Bitmap is not a supported image type
ReadEncodedBitmapSigDataNotFound3Encoded 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.

NameValueDescription
TxtDontShow0Don't display the information
TxtShowLeft1Display the information left aligned within the control
TxtShowCenter2Display the information centred within the control
TxtShowRight4Display the information right aligned within the control

SignedData

Returned by the CheckSignedData method of the SigObj interface.

NameValueDescription
DataGood0Data has not changed signature capture
DataNoHash1No signature captured, or signature was captured without a hash
DataBadType2Signature was captured with a different type of hash
DataBadHash3Data has changed since signature capture
DataError4Error whilst checking signed data
DataUncertain5Unable to check status of data. Obsolete
DataSigMoved6The position of the SigCtlXHTML control within the HTML document has been changed

TimeZone

Used to select time zone for time returned by 'When' parameter.

NameValueDescription
TimeLocal0Local time when signature was captured
TimeGMT1Greenwich Mean Time
TimeUTC1Universal Coordinated Time (synonym for TimeGMT)