漢王簽批控件接口說(shuō)明文檔-v2.2

1、漢王筆跡簽名控件接口說(shuō)明文檔v2.2控件使用平臺(tái)1.1操作系統(tǒng)平臺(tái) Windows XP，Windows Vista，Windows 71.2 支持軟件平臺(tái)1瀏覽器：IE瀏覽器V2.0至目前IE的最高版本V10.0采用IE內(nèi)核的瀏覽器注：360、搜狗、傲游等瀏覽器，均是雙核瀏覽器，即兼容模式下為支持IE內(nèi)核模式，此時(shí)支持控件的加載。極速模式下為采用了Chromium內(nèi)核，此種模式下不支持加載控件。        當(dāng)用戶瀏覽簽批控件所在的頁(yè)面時(shí)，請(qǐng)將以上瀏覽器的模式切換至兼容模式，否那么控件無(wú)法正常工作。 2支持co

2、m組件調(diào)用的應(yīng)用程序中1.3控件功能控件為瀏覽器的子窗口故不能創(chuàng)立透明的簽名窗口，可在窗口內(nèi)實(shí)現(xiàn)帶壓感的原筆跡手寫簽字。提供接口支持筆形(壓力筆/鋼筆)、筆寬共5級(jí)、筆顏色、窗口邊框?qū)挾燃邦伾?、窗口?nèi)部背景顏色的設(shè)置，支持一次性去除所有筆跡，支持對(duì)手寫模塊的初始化和卸載控制，支持獲取簽字筆跡的bmp/jpg/png/gif圖片格式的base64數(shù)據(jù)流。1.4 控件界面上圖是簽批控件HWPenSign.ocx界面圖，此控件是ActiveX控件，可以嵌入到網(wǎng)頁(yè)中使用。此控件可以提供用戶定制開發(fā)，額外收取軟件開發(fā)費(fèi)用?？丶涌谧ⅲ簽楸ＷC圖像不失真，PC端控件顯示窗口與設(shè)備窗口長(zhǎng)寬比應(yīng)一致。因此，建議

3、對(duì)于設(shè)備ESP370，設(shè)置控件窗口長(zhǎng)寬比為8:3。對(duì)于設(shè)備ESP560，設(shè)置控件窗口長(zhǎng)寬比為5:3。2.1函數(shù)返回值錯(cuò)誤碼HW_eOk 0 成功HW_eDeviceNotFound -1 未找到對(duì)應(yīng)的漢王手寫設(shè)備HW_eFailedLoadModule -2 手寫模塊加載失敗HW_eFailedInitModule -3 手寫模塊初始化失敗HW_eWrongImageFormat -4 不支持的圖片格式HW_eNoSignData -5 沒有簽名數(shù)據(jù)HW_eInvalidInput -6 無(wú)效輸入?yún)?shù)其它返回值，參見windowsWinError.h頭文件中定義常見錯(cuò)誤碼含義。2.2 根本接口

4、1. LONG HWInitialize (void)函數(shù)功能： 手寫模塊初始化 參數(shù)說(shuō)明： 返回值見2.1 2. LONG HWFinalize (void)函數(shù)功能： 手寫模塊卸載 參數(shù)說(shuō)明： 無(wú)3. LONG HWClearPenSign(void)函數(shù)功能： 去除筆跡4. LONG HWSetPenMode(LONG flag) 函數(shù)功能： 設(shè)置筆模型 參數(shù)說(shuō)明： flag：0 -> 毛筆默認(rèn)1 -> 鋼筆5. LONG HWSetPenWidth(LONG penWidth) 函數(shù)功能： 設(shè)置筆寬 參數(shù)說(shuō)明： penWidth：筆寬， 提供1-5個(gè)級(jí)別的設(shè)置，默認(rèn)為3級(jí)

5、6. LONG HWSetPenColor(OLE_COLOR color) 函數(shù)功能： 設(shè)置筆的顏色默認(rèn)顏色為0x000000參數(shù)說(shuō)明： color： 顏色，格式為RGB7. LONG HWSetBkColor(OLE_COLOR color) 函數(shù)功能：設(shè)置簽名區(qū)域背景顏色 參數(shù)說(shuō)明： color：顏色，無(wú)背景圖片時(shí)設(shè)置,默認(rèn)為白色8. LONG HWSetCtlFrame(LONG linewidth, OLE_COLOR color) 函數(shù)功能： 設(shè)置邊框?qū)挾群皖伾珔?shù)說(shuō)明： linewidth：邊框?qū)挾龋?0為無(wú)邊框。 Color： 邊框顏色9. LONG HWSetFilePath

6、(VARIANT &path)函數(shù)功能： 設(shè)置簽名圖像的保存路徑，確保輸入路徑的目標(biāo)文件夾存在，假設(shè)不存在，控件不創(chuàng)立。參數(shù)說(shuō)明： path：路徑，支持圖像格式為bmp，jpg，png，gif注：win7 / vista存在寫文件權(quán)限問題，因此不支持將保存路徑設(shè)置為該操作系統(tǒng)盤盤符下。 10. LONG HWSaveFile(void) 函數(shù)功能： 保存文件參數(shù)說(shuō)明： 返回值見2.111. BSTR HWGetBase64Stream(LONG flag) 函數(shù)功能： 獲取簽字區(qū)域圖像的base64流 參數(shù)說(shuō)明： flag：0 -> bmp 圖像類型 1 -> jpg 2

7、-> png 3 -> gif返回值：簽字圖像對(duì)應(yīng)的base64數(shù)據(jù)流12. LONG HWSwitchMonitor(LONG mode, LONG ctlapp)函數(shù)功能： 顯示器模式切換鏡像&擴(kuò)展參數(shù)說(shuō)明： mode：0 > 漢王簽批控件切換到擴(kuò)展屏顯示 1 -> 漢王簽批控件在主顯示器顯示 ctlapp: 0 -> 保存，取值為0注：此接口僅適用于漢王手寫液晶屏。13. LONG HWSetExtWndHandle(LONG hWndHandle)函數(shù)功能：傳遞與控件通信的窗口句柄值參數(shù)說(shuō)明：hWndHandle：窗口句柄值14. LONG HWL

8、oadImage(VARIANT &pathBackImage)函數(shù)功能：給控件手寫區(qū)域添加背景圖片參數(shù)說(shuō)明：pathBackImage > 背景圖片路徑，當(dāng)背景圖片大小與控件手寫區(qū)域大小不一致 時(shí)，背景圖片將被進(jìn)行拉伸或縮放 返回值：見2.1注：此接口僅適用于獲取整個(gè)簽字區(qū)域圖像版本的控件。15. LONG HWLoadBase64Stream(VARIANT &stream)函數(shù)功能：給控件手寫區(qū)域添加背景圖片參數(shù)說(shuō)明：stream à 背景圖片的Base64數(shù)據(jù)流 返回值：見2.1。注：此接口僅適用于獲取整個(gè)簽字區(qū)域圖像版本的控件。16. LONG HWI

9、sNeedSave(void)函數(shù)功能：是否有需要保存的筆跡參數(shù)說(shuō)明：無(wú)返回值： 0 à 無(wú)筆跡 1 à 有筆跡17. void HWSetSignArea(LONG width, LONG height)函數(shù)功能：設(shè)置待獲取的簽字圖像大小參數(shù)說(shuō)明：width à 簽字圖像的寬度 Height à 簽字圖像的高度注：此接口僅支持無(wú)窗口版本的控件。2.3 簽名動(dòng)作的自動(dòng)觸發(fā)2.3.1 簽名板1、回調(diào)觸發(fā)簽名板的簽名界面上帶有“重簽和“確認(rèn)按鈕，用戶簽名完成后，點(diǎn)擊按鈕的動(dòng)作，漢王簽名控件可以捕獲。(一) 應(yīng)用系統(tǒng)的HTML頁(yè)面通過(guò)JS代碼引用漢王的簽名板控

10、件(ActiveX)。(二) 應(yīng)用系統(tǒng)通過(guò)調(diào)用漢王控件接口函數(shù)HWInitialize開始簽名；(三) 客戶簽名完成，點(diǎn)擊簽名界面下按鈕進(jìn)行重簽、確認(rèn)動(dòng)作；(四) ActiveX控件監(jiān)聽到客戶的動(dòng)作，調(diào)用應(yīng)用系統(tǒng)HTML頁(yè)面上的JS函數(shù)；(五) 應(yīng)用系統(tǒng)調(diào)用漢王控件接口函數(shù)HWFinalize結(jié)束簽名。 控件ActiveX與HTML頁(yè)面上的回調(diào)函數(shù)存在以下對(duì)應(yīng)關(guān)系：1) “確定按鈕 à 調(diào)用HTML頁(yè)面上的“signComplete函數(shù)2) “重簽按鈕 à 調(diào)用HTML頁(yè)面上的signRestart函數(shù) 客戶可以根據(jù)需要自行實(shí)現(xiàn)上述“signComplete和signRes

11、tart函數(shù)，完成簽名動(dòng)作的自動(dòng)觸發(fā)機(jī)制 (如Demo.html頁(yè)面所示在signComplete函數(shù)里調(diào)用HWGetBase64Stream接口獲取簽名圖片。)。應(yīng)用系統(tǒng)也可以不采用這種觸發(fā)機(jī)制，而通過(guò)手動(dòng)的方式去獲取用戶的簽名圖像，此時(shí)在應(yīng)用系統(tǒng)的HTML頁(yè)面中不實(shí)現(xiàn)“signComplete和signRestart函數(shù)即可。2、窗口消息觸發(fā)約定：當(dāng)用戶點(diǎn)擊簽名板上的取消、確定按鈕時(shí)，控件會(huì)往往以下窗口句柄發(fā)送簽名取消或完成的消息調(diào)用HWSetExtWndHandle接口傳進(jìn)來(lái)的窗口句柄。用戶可在程序中響應(yīng)對(duì)應(yīng)的消息即可。消息定義如下：HW_SIGN_COMPELETE 0x7ffeHW_

12、SIGN_CLEAR 0x7ffd2.3.2 手寫液晶屏1、回調(diào)觸發(fā)手寫液晶屏的左側(cè)有4個(gè)按鍵，當(dāng)用戶觸發(fā)按鍵時(shí)，控件可以捕獲并回調(diào)頁(yè)面函數(shù)。具體步驟。(一) 應(yīng)用系統(tǒng)的HTML頁(yè)面通過(guò)JS代碼引用漢王的簽名板控件(ActiveX)。(二) 應(yīng)用系統(tǒng)通過(guò)調(diào)用漢王控件接口函數(shù)HWInitialize開始簽名；(三) 客戶觸發(fā)手寫液晶屏左側(cè)按鍵；(四) ActiveX控件監(jiān)聽到客戶的動(dòng)作，調(diào)用應(yīng)用系統(tǒng)HTML頁(yè)面上的JS函數(shù)；(五) 應(yīng)用系統(tǒng)調(diào)用漢王控件接口函數(shù)HWFinalize結(jié)束簽名?？丶嗀ctiveX與HTML頁(yè)面上的回調(diào)函數(shù)存在以下對(duì)應(yīng)關(guān)系：1) “確認(rèn)按鈕 à 調(diào)用HTML頁(yè)

13、面上的“Confirm_Event函數(shù)。2) “取消按鈕 à 調(diào)用HTML頁(yè)面上的“Cancel_Event函數(shù)。3) “上翻按鈕 à 調(diào)用HTML頁(yè)面上的“PrePage_Event函數(shù)。4) “下翻按鈕 à 調(diào)用HTML頁(yè)面上的“NextPage_Event函數(shù)客戶可以根據(jù)需要自行實(shí)現(xiàn)上述“Confirm_Event、“Cancel_Event、“PrePage_Event、“NextPage_Event函數(shù)，實(shí)現(xiàn)自動(dòng)觸發(fā)機(jī)制 (如Demo.html頁(yè)面所示依次在各個(gè)回調(diào)函數(shù)中給出彈框提示)。2、窗口消息觸發(fā)約定：當(dāng)用戶點(diǎn)擊簽名板上的取消、確定按鈕時(shí)，控件會(huì)往往以下窗口句柄發(fā)送簽名取消或完成的消息調(diào)用HWSetExtWndHandle接口傳進(jìn)來(lái)的窗口句柄。用戶可