Lodop60技术手册

1WEB打印控件Lodop技术手册Ver6.0.1.7Email:[e-mail]:932131686目录一、概述3二、系统文件3install_lodop.exe3LodopFuncs.js4三、控件参数5Caption52Color5Border5四、功能函数51、基本函数5VERSION5PRINT_INIT6SET_PRINT_PAGESIZE6ADD_PRINT_HTM7ADD_PRINT_TABLE8ADD_PRINT_URL9ADD_PRINT_TEXT10ADD_PRINT_IMAGE10ADD_PRINT_RECT11ADD_PRINT_ELLIPSE11ADD_PRINT_LINE12ADD_PRINT_BARCODE13ADD_PRINT_CHART14SET_PRINT_STYLE15NEWPAGE16PREVIEW17PRINT17PRINT_SETUP17PRINT_DESIGN17GET_PRINTER_COUNT18GET_PRINTER_NAME18SET_PRINTER_INDEX18SELECT_PRINTER18SET_SHOW_MODE19SET_PRINT_MODE21SET_PREVIEW_WINDOW21ADD_PRINT_SETUP_BKIMG22SEND_PRINT_RAWDATA22WRITE_PORT_DATA22READ_PORT_DATA23GET_PRINT_INIFFNAME23WRITE_FILE_TEXT23GET_FILE_TEXT24GET_FILE_TIME24IS_FILE_EXIST24GET_SYSTEM_INFO25GET_VALUE25FORMAT26GET_DIALOG_VALUE272、扩展函数28PRINT_INITA283ADD_PRINT_HTML29ADD_PRINT_TBURL29ADD_PRINT_TEXTA29SET_PRINT_STYLEA29SAVE_TO_FILE32SET_SAVE_MODE32SET_PRINT_TEXT_STYLEA33ADD_PRINT_SHAPE34SET_PRINTER_INDEXA35PREVIEWA35PREVIEWB35PRINTA36PRINTB36SHOW_CHART36SET_LICENSES36五、软件使用权注册37CompanyName37License37LicenseA37LicenseB37六、打印维护和打印设计37七、使用样例38八、计量单位39一、概述Lodop是一款专业的WEB打印控件，其设计目标是简单易用、功能足够强大，开创WEB打印开发的新局面。Lodop设计者对WEB下的打印开发任务进行了分类汇总，高度抽象，设计出仅用几个功能函数，就可实现复杂的打印任务，尽量减少使用者的知识累赘。控件发布包有3个系统文件组成，全部功能用几个控件参数和2组功能函数来实现。尽管我们有个理想化的目标，那就是您不用详细了解这些参数或函数，仅仅看懂几个样例文件就能很轻松地开始使用本控件，为此Lodop提供了一个足够完善的设计界面，用它可以实现大多数打印开发任务，但事实上了解这些参数和函数总还是有好处的，特别是当您的开发任务很复杂时，这就是本文目的，但愿本文档足够详细且简单明了。如果此前曾看过lodop的入门样例程序，本文会更容易理解！二、系统文件Lodop发布包内主要有如下几个文件：install_lodop.exe该文件是控件安装和升级的主文件，提供给用户或开发者下载安装，如果不特意拦截一般都能100%安装，对“网页插件安装难”有一定改善。如果将其复制或改名为uninstall_lodop.exe(名前加un)就可用其卸载控件。Lodop安装后，在操作系统目录WINDOWS\system32下会安装两个实体文件：CAOSOFT_WEB_PRINT_LODOP.OCX和NPCAOSOFT_WEB_PRINT_lodop.dll，前一个文件是OCX文件，后者是Npplugin文件，其作用是实现多浏览器支持。目前Lodop支持IE系列、IE内核系列(遨游、360、世界之窗、腾讯TT、搜狗等)浏览器，以及Firefox(火狐)4系列、Chrome(谷歌)系列、Opera系列、Safari系列等Windows下几乎所有的浏览器。程序文件有几个预定参数：-waitXX该参数设置安装程序运行完毕后自动关闭窗口，这里的XX表示关闭前等待的秒数，如果是0秒则安装（或卸载）成功后立即关闭，例如：–wait8-nowindow该参数设置安装程序运行时不出现窗口。-un该参数使程序执行卸载操作，参数优先于文件名。-in该参数使程序执行安装操作，参数优先于文件名。LodopFuncs.js该文件是用来引导安装控件的一个JS文件，是个样例，但建议直接采用。其中getLodop的任务是判断浏览器的类型并决定采用哪个控件实例，并检测控件是否安装、是否最新版本、并引导安装或升级。文件内容如下：functiongetLodop(oOBJECT,oEMBED){varstrHtml1=brfontcolor='#FF00FF'打印控件未安装!点击这里ahref='install_lodop.exe'执行安装/a,安装后请刷新页面或重新进入。/font;varstrHtml2=brfontcolor='#FF00FF'打印控件需要升级!点击这里ahref='install_lodop.exe'执行升级/a,升级后请重新进入。/font;varstrHtml3=brbrfontcolor='#FF00FF'(注：如曾安装过Lodop旧版附件npActiveXPLugin,请在【工具】-【附加组件】中先卸载它)/font;varLODOP=oEMBED;try{if(navigator.appVersion.indexOf(MSIE)=0)LODOP=oOBJECT;if((LODOP==null)||(typeof(LODOP.VERSION)==undefined)){if(navigator.userAgent.indexOf('Firefox')=0)document.documentElement.innerHTML=strHtml3+document.documentElement.innerHTML;if(navigator.appVersion.indexOf(MSIE)=0)document.write(strHtml1);elsedocument.documentElement.innerHTML=strHtml1+document.documentElement.innerHTML;}elseif(LODOP.VERSION6.0.0.1){if(navigator.appVersion.indexOf(MSIE)=0)document.write(strHtml2);elsedocument.documentElement.innerHTML=strHtml2+document.documentElement.innerHTML;}//*****如下空白位置适合调用统一功能:*********//*******************************************returnLODOP;}catch(err){document.documentElement.innerHTML=Error:+strHtml1+document.documentElement.innerHTML;returnLODOP;}}其中的关键点是Version函数，Lodop提供了一个“读版本号”功能，这样控件的安装和升级任务就交给JS来实现，以下是控件在页面内的调用代码，其中包含getLodop的利用：headtitle/title5scriptlanguage=javascriptsrc=LodopFuncs.js/scriptobjectid=LODOPclassid=clsid:2105C259-1E0C-4534-8141-A753534CB4CAwidth=0height=0embedid=LODOP_EMtype=application/x-print-lodopwidth=0height=0/embed/object/headbodyscriptlanguage=javascriptvarLODOP=getLodop(document.getElementById('LODOP'),document.getElementById('LODOP_EM'));/script…/body以上两段代码相互配合实现了Lodop的安装、调用和升级。之所以将LodopFuncs.js作为一个资源文件来部署，既可以利用浏览器的缓存减少页面内容的重复下载，同时还实现了控件发布统一管理，整个应用系统中只要这一个地方发布Lodop。其它页面直接拷贝嵌入第2段代码就可以了。三、控件参数Lodop有如下控件参数,以页面object对象元素的参数形式使用：Caption名称：设置打印控件的显示标题格式：paramname=Captionvalue=我是打印控件lodop功能：打印控件在页面内一般是以object元素形式被引用。可以通过设置元素的width和height等于0来隐藏控件，不隐藏时可以为控件设置一个标题，以便于看到控件是否被正确安装，以及控制对象在页面内的位置。希望打印预览界面或设计界面内嵌到网页内时，本参数很有用。Color名称：设置打印控件的显示区域颜色格式：paramname=Colorvalue=#C0C0C0功能：通过该参数设置控件显示区域的底色，对于希望打印预览界面或设计界面内嵌到网页内时，本参数可以让控件容易融于整体页面。参数值采用超文本颜色形式，可以是三色16进制值组合，也可以是英文颜色名。Border名称：设置打印控件的显示区域边界格式：paramname=Bordervalue=1功能：通过该参数设置控件显示区域的边界，值等于1表示有边界，否则无边界。本参数可以让控件更融于整体页面。另外，控件还有三个用于注册的辅助参数，参考后面《软件使用权注册》一节。四、功能函数Lodop的功能函数不多，但参数比较复杂。全部函数分“基本函数”和“扩展函数”两类，两类函数有类似性，基本函数使用简单，达不到要求时请使用扩展函数，二者无本质区别。1、基本函数VERSION6名称：获得软件版本号格式：VERSION结果：返回字符型结果版本号有四个数字组成，样式为：X.X.X.XPRINT_INIT名称：打印初始化格式：PRINT_INIT(strTaskName)功能：初始化运行环境，清理异常打印遗留的系统资源，设定打印任务名。参数：strTaskName：打印任务名，字符型参数，由开发者自主设定，未限制长度，字符要求符合Windows文件起名规则，Lodop会根据该名记忆相关的打印设置、打印维护信息。若strTaskName空，控件则不保存本地化信息，打印全部由页面程序控制。结果：返回逻辑值返回逻辑真表示初始化成功，逻辑假表示初始化失败，失败原因有：前一个打印事务没有完成；操作系统没有打印机(驱动)等。建议或要求：该函数与PRINT_INITA都有初始化功能，每个打印事务至少初始化一次，建议打印程序首先调用该函数。任务名要尽量区别于其它打印任务，譬如用“XX单位_XX管理信息系统_XX子系统_XX模块_XX打印作业”字样。不希望最终用户更改打印布局时，则设strTaskName空。SET_PRINT_PAGESIZE名称：设定纸张大小格式：SET_PRINT_PAGESIZE(intOrient,PageWidth,PageHeight,