Webprint插件api技术手册.doc

eprint插件技术手册Webprint插件api技术手册2007-6-13目录目录1一、简介2二、webprint插件的对象、属性方法21、对象22、属性3defaultPrinterName3marginTop3marginLeft3marginRight4marginBottom4header4footer5copies5pageFrom6pageTo6selectedPages6currentPage7orientation7paperSize7paperSource8pageWidth8pageHeight8zoomValue83、方法9InitPrint()9SetMarginMeasure(int units)9Preview()10Print(bool prompt)10三、例子摘要10设置页边距的打印示例10选择打印纸型的示例12自定义打印纸张的示例13一、简介webprint是在VC7.0上开发的ATL小控件（只有75k），运行时不可视。主要实现对IE浏览器中文档打印格式的控制，可以定制打印纸型，纸张来源，打印方向等等用户经常关心的属性。用户通过代码可以自定义纸张，打印方向，页边距等等属性达到定制打印的目的，这些定制属性的设置不会改变IE浏览器的默认打印属性。也可以通过服务器端的页面调用webprint插件生成客户端的页面达到设置打印参数的目的。开发平台：VC7.0 应用平台Microsoft Windows Win32 OS 平台(除了Windows NT 3.51)Microsoft Internet Explorer versions 5.5以上二、webprint插件的对象、属性方法1、对象webprint描述：打印插件对象。在页面中嵌入此对象实现定制打印。如： 示例： 方成打印插件演示示例。2、属性defaultPrinterName描述：获得当前默认打印机名称，通过获得默认打印机名称可以判断是否安装了打印机。语法：webprint.defaultPrinterName = stringValue应用到：webprint对象示例：下面是一个判断当前是否设置了打印机的javascript代码，PrintCtl是webprint的对象id。if (PrintCtl.defaultPrinterName.length=0)alert(没有设置打印机！)return;marginTop描述：设置打印页面的上边距。设置值的单位默认为毫米，通过SetMarginMeasure()方法可以改变到英寸。语法：webprint.marginTop = numMarginValue应用到：webprint对象示例：webprint.setMarginMeasure(1);webprint.marginTop = 20; /20mm的上边距marginLeft描述：设置打印页面的左边距。设置值的单位默认为毫米，通过SetMarginMeasure()方法可以改变到英寸。语法：webprint.marginLeft = numMarginValue应用到：webprint对象示例：webprint.setMarginMeasure(1);webprint.marginLeft = 20; /20mm的左边距marginRight描述：设置打印页面的右边距。设置值的单位默认为毫米，通过SetMarginMeasure()方法可以改变到英寸。语法：webprint.marginRight = numMarginValue应用到：webprint对象示例：webprint.setMarginMeasure(1);webprint.marginRight = 20; /20mm的右边距marginBottom描述：设置打印页面的下边距。设置值的单位默认为毫米，通过SetMarginMeasure()方法可以改变到英寸。语法：webprint.marginBottom = numMarginValue应用到：webprint对象示例：webprint.setMarginMeasure(1);webprint.marginBottom = 20; /20mm的底边距header描述：设置打印页面的页眉信息。语法：webprint.header = stringValue设置值可以和下面IE的页眉页脚代码合并设置，例如：（page &p of &P）描述代码窗口标题&w页面地址(URL)&u短格式日期 (在控制面板的区域选项中修改短日期格式)&d长格式日期 (在控制面板的区域选项中修改长日期格式)&D时间 (在控制面板的区域选项中修改时间格式)&t24小时格式&T当前页号&p总页数&P文本居中(在&b后面的文本)&b文本靠右 (在 &b&b 后面的文本)&b&b单个&(&)&应用到：webprint对象示例：webprint.header = “webprint3.0 打印演示”footer描述：设置打印页面的页脚信息。语法：webprint.footer = stringValue设置值可以和下面IE的页眉页脚代码合并设置，例如：（page &p of &P）描述代码窗口标题&w页面地址(URL)&u短格式日期 (在控制面板的区域选项中修改短日期格式)&d长格式日期 (在控制面板的区域选项中修改长日期格式)&D时间 (在控制面板的区域选项中修改时间格式)&t24小时格式&T当前页号&p总页数&P文本居中(在&b后面的文本)&b文本靠右 (在 &b&b 后面的文本)&b&b单个&(&)&应用到：webprint对象示例：webprint.footer = “第 &p 页 / 共 &P 页” ;copies描述：设置打印的份数。 语法：webprint.copies = numValue应用到：webprint对象示例：webprint.copies = 2; /打印两份pageFrom描述：设置打印开始页数，通常与pageTo一起使用。pageForm和pageTo的设置值必须在selectedPages属性值为true才能生效。语法：webprint.pageFrom = numValue应用到：webprint对象示例：下面代码实现 选择从第二页打印到第四页。webprint.selectedPages = true ;webprint.pageFrom = 2 ;webprint.pageTo = 4 ;pageTo描述：设置打印结束页，通常与pageFrom一起使用。pageForm和pageTo的设置值必须在selectedPages属性值为true才能生效。语法：webprint.pageTo = numValue应用到：webprint对象示例：下面代码实现 选择从第二页打印到第四页。webprint.selectedPages = true ;webprint.pageFrom = 2 ;webprint.pageTo = 4 ;selectedPages描述：设置是否选择打印页。语法：webprint.selectedPages = boolVlaue true为选择页打印；false为默认值不选择页打印当webprint.selectedPages = true ;时，再设置pageFrom,和pageTo达到选项打印页。应用到：webprint对象示例：下面代码实现 选择从第二页打印到第四页。webprint.selectedPages = true ;webprint.pageFrom = 2 ;webprint.pageTo = 4 ;currentPage描述：设置是否打印当前页。语法：webprint.currentPage = boolValue true为打印当前页；false为默认值不打印当前页。当webprint.currentPage true 和webprint.selectedPages = true时，则那个设置在最后则那个属性值有效。应用到：webprint对象示例：webprint.currentPage = true ;/打印当前页。orientation描述：设置打印方向，横向或者纵向语法：webprint.orientation = numValue 1为纵向，2为横向。应用到：webprint对象示例：下面代码实现 B5纸的横向打印。webprint.paperSize = “B5”;webprint.orientation = 2 ;paperSize 描述：设置打印纸张。语法：webprint.paperSize = stringValue 设置值与打印机的纸型一致。应用到：webprint对象示例：webprint.paperSize = “A4”; /定制A4 纸打印下面代码实现用户自定义纸张尺寸打印。webprint.setMarginMeasure(1);webprint.paperSize = US Std Fanfold; /用户自定义webprint.pageWidth = 297;webprint.pageHeight = 210;paperSource描述：设置纸张来源。语法：webprint.paperSource = stringValue 设置值与打印机的纸张来源一致。应用到：webprint对象示例：webprint.paperSource = “单张”;pageWidth描述：设置打印页面的宽。设置值的单位默认为毫米，通过SetMarginMeasure()方法可以改变到英寸。如果不设置纸张型号，直接设置pageWidth和pageHeight的值，则在页面设置对话框中的纸型将显示当前打印机的默认纸型。语法：webprint.pageWidth = numValue应用到：webprint对象示例：webprint.setMarginMeasure(2);/英寸为单位webprint.pageWidth = 6 ; pageHeight描述：设置打印页面的高。设置值的单位默认为毫米，通过SetMarginMeasure()方法可以改变到英寸。如果不设置纸张型号，直接设置pageWidth和pageHeight的值，则在页面设置对话框中的纸型将显示当前打印机的默认纸型。语法：webprint.pageHeight = numValue应用到：webprint对象示例：webprint.setMarginMeasure(2); /英寸为单位webprint.pageHeight = 8 ;zoomValue描述：设置打印预览时候的显示缩放比例，默认是75%。语法：webprint.zoomValue = stringValue应用到：webprint对象示例：webprint.setMarginMeasure(2); /英寸为单位webprint.pageHeight = 8 ;webprint.zoomValue=”100”;3、方法InitPrint()描述：初始化所有的打印属性设置值。通常在设置一个打印作业之前调用一次此方法。应用到：webprint对象示例：下面代码实现设置打印页眉和页脚为1英寸，在设置之前调用InitPrint()方法，初始化所有打印设置值。webprint.InitPrint();webprint.SetMarginMeasure(2);webprint.marginTop = 1;webprint.marginBottom = 1;SetMarginMeasure(int units)描述：设置打印页面尺寸和边距的单位。参数：units 1 表示 毫米 默认值2 表示 英寸应用到：webprint对象示例：webprint.SetMarginMeasure(2);/设置单位为英寸Preview()描述：打印预览参数：应用于：示例：下面代码实现A4纸横向打印的预览。webprint.paperSize = “A4”;webprint.orientation = 2;webprint.Preview();Print(bool prompt)描述：打印参数：prompt 可选的true 不出打印对话框直接打印fase 弹出打印对话框 默认值示例：下面代码实现A4纸横向打印webprint.paperSize = “A4”webprint.orientation = 2;webprint.Print(); / 弹出打印对话框的打印webprint.Print(true); /不出打印对话框直接打印三、例子摘要设置页边距的打印示例 .button display:none; .button display:block;function SetPrintSettings() document.all.webprint.InitPrint(); document.all.webprint.SetMarginMeasure(2);/1mm是default, 2 inch document.all.webprint.marginTop=1.11; document.all.webprint.marginLeft=1; document.all.webprint.marginRight=1; document.all.webprint.marginBottom=1; document.all.webprint.Preview();function Print() document.all.webprint.InitPrint(); document.all.webprint.SetMarginMeasure(2);/1mm是default, 2 inch document.all.webprint.marginTop=1.11; document.all.webprint.marginLeft=1; document.all.webprint.marginRight=1; document.all.webprint.marginBottom=1; document.all.webprint.Print();/document.all.webprint.Print(true);/不弹出打印对话框直接打印 设置页边距的打印示例。选择打印纸型的示例 .button display:none; .button display:block;function SetPrintSettings() document.all.webprint.InitPrint(); document.all.webprint.SetMarginMeasure(2);/1mm是default, 2 inchdocument.all.webprint.paperSize = Letter; document.all.webprint.Preview();function Print() document.all.webprint.InitPrint(); document.all.webprint.SetMarginMeasure(2);/1mm是default, 2 inchdocument.all.webprint.paperSize = Letter; document.all.webprint.Print();/document.all.webprint.P