打印插件API参考手册

最新推荐文章于 2020-12-30 19:34:07 发布
最新推荐文章于 2020-12-30 19:34:07 发布
阅读量514 收藏
点赞数
分类专栏： 打印插件 文章标签： 打印插件 nengjj 能加加
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/matthewwu/article/details/110347317
版权

nengjj.getInstance()

获取打印实例，一个页面只能调用一次本函数，获取一个实例。

var instance = nengjj.getInstance(jsonConfig);

参数

jsonConfig

配置信息，Object类型，可选。包含的字段：

字段名称类型必选描述
hostString否代理软件所在电脑的IP地址，默认值为"localhost"

返回值

返回Object类型的打印实例。

示例

指定IP、端口获取实例：

var instance = nengjj.getInstance({
    host: "192.168.1.10"
});

instance.getInfo()

获取插件的版本号，是否安装许可证等信息。

instance.getInfo(onsuccess, onerror);

参数

onsuccess

成功回调函数，Function类型，可选。

onsuccess(result) {
    console.log(result); 
}

参数说明：

字段名称类型描述
resultObject插件的相关信息

result中的字段：

字段名称类型描述
appVerString插件版本号
printVerString打印模块版本号
osString插件的运行平台，取值：win/linux/macos 之一

onerror

失败回调函数，Function类型，可选。

onerror(status, text) {
    console.log(status + ":" + text); 
}

参数说明：

字段名称类型描述
statusInteger错误状态号，例如：400
textString错误信息，例如：授权证书无效

返回值

无

示例

获取插件信息：

instance.getInfo(function(res){
    console.log(res);
});

输出:

{
    appVer: "1.2", // 插件版本
    isLicenseInstalled: true, // license是否安装
    os: "win", // 插件运行的平台
    printVer: "1.1" // 打印模块版本
    ...
}

instance.readLicense()

读取许可证(license)。

instance.readLicense(onsuccess, onerror);

参数

onsuccess

成功回调函数，Function类型，可选。

onsuccess(result) {
    console.log(result); 
}

参数说明：

字段名称类型描述
resultObjectlicense内容

onerror

失败回调函数，Function类型，可选。

onerror(status, text) {
    console.log(status + ":" + text); 
}

参数说明：

字段名称类型描述
statusInteger错误状态号，例如：400
textString错误信息，例如：授权证书无效

返回值

无

示例

安装许可证：

instance.readLicense(
    function(res) { // 调用成功回调函数
        console.log(res); 
    },
    function(status, text) { // 调用出错回调函数
        console.error(status + ":" + text);
    }
);

instance.installLicense()

更新许可证(license)。

instance.installLicense(license, onsuccess, onerror);

参数

license

许可证内容，String类型，必选。

onsuccess

成功回调函数，Function类型，可选。

onsuccess(result) {
    console.log(result); 
}

参数说明：

字段名称类型描述
resultString成功信息，例如：”设置成功”

onerror

失败回调函数，Function类型，可选。

onerror(status, text) {
    console.log(status + ":" + text); 
}

参数说明：

字段名称类型描述
statusInteger错误状态号，例如：400
textString错误信息，例如：授权证书无效

返回值

无

示例

安装许可证：

//
// 许可证只需安装一次，安装前可以先调用readLicense接口，获知许可证
// 是否已经安装
// 

instance.readLicense(
    function(res){
        console.log(res);
        if(!res) {
            var license = "..."; // 替换为license字符串
            instance.installLicense(license, null, function(st, text){
                console.log(st + ":" + text);
                alert(text);
            });
        }
    },
    function(st, text){
        console.log(st + ":" + text);
        if(st == 0) {
            alert("插件未启动，请确认插件已启动！");
        } else {
            alert(text);
        }
    }
);

instance.print.listPrinter()

获取打印机名称列表。

instance.print.listPrinter(onsuccess, onerror);

参数

onsuccess

成功回调函数，Function类型，可选。

onsuccess(result) {
    console.log(result); 
}

参数说明：

字段名称类型描述
resultArray打印机名称列表（字符串数组），例如：["Printer A", "Printer B" ]

onerror

失败回调函数，Function类型，可选。

onerror(status, text) {
    console.log(status + ":" + text); 
}

参数说明：

字段名称类型描述
statusInteger错误状态号，例如：400
textString错误信息，例如：授权证书无效

返回值

无

示例

获取打印机名称列表：

instance.print.listPrinter(
    function(res) { // 调用成功回调函数
        console.log(res);
    },
    function(status, text) { // 调用出错回调函数
        console.error(status + ":" + text);
    }
);

调用成功输出：

[
    "Microsoft XPS Document Writer", 
    "Microsoft Print to PDF", 
    "HP DeskJet 5820 series (网络)", 
    "Foxit Reader PDF Printer", 
    "Fax"
]

instance.print.getDefaultPrinter()

获取默认打印机名称。

instance.print.getDefaultPrinter(onsuccess, onerror);

参数

onsuccess

成功回调函数，Function类型，可选。

onsuccess(result) {
    console.log(result); 
}

参数说明：

字段名称类型描述
resultString打印机名称（字符串），例如："Printer A"
  • result: 打印机名称（字符串），例如："Printer A"

onerror

失败回调函数，Function类型，可选。

onerror(status, text) {
    console.log(status + ":" + text); 
}

参数说明：

字段名称类型描述
statusInteger错误状态号，例如：400
textString错误信息，例如：授权证书无效

返回值

无

示例

获取默认打印机名称：

instance.print.getDefaultPrinter(
    function(res) { // 调用成功回调函数
        console.log(res);
    },
    function(status, text) { // 调用出错回调函数
        console.error(status + ":" + text);
    }
);

调用成功过输出：

HP DeskJet 5820 series (网络)

instance.print.listPrinterPaper()

获取打印机支持的纸张规格。

instance.print.listPrinterPaper(printerName, onsuccess, onerror);

参数

printerName

指定打印机名称，String类型，必选。

onsuccess

成功回调函数，Function类型，可选。

onsuccess(result) {
    console.log(result); 
}

参数说明：

字段名称类型描述
resultArray纸张名称列表（json数组），格式如下。

result中，数组元素内容：

字段名称类型描述
nameString纸张名称，例如: “A4”
widthInteger纸张宽度, 单位0.01毫米
heightInteger纸张高度, 单位0.01毫米

result示例：

[
    {
        name: "A4",         // 纸张名称, String类型
        width: 21000,       // 纸张宽度, 单位0.01毫米, Integer类型
        height: 29700,      // 纸张高度, 单位0.01毫米, Integer类型
    },
    {
        name: "A5",         // 纸张名称, String类型
        width: 14800,       // 纸张宽度, 单位0.01毫米, Integer类型
        height: 21000,      // 纸张高度, 单位0.01毫米, Integer类型
    }
    ...
]

onerror

失败回调函数，Function类型，可选。

onerror(status, text) {
    console.log(status + ":" + text); 
}

参数说明：

字段名称类型描述
statusInteger错误状态号，例如：400
textString错误信息，例如：授权证书无效

返回值

无

示例

获取打印机支持的纸张规格：

var printerName = "xxx xxx";
instance.print.listPrinterPaper(
    printerName, 
    function(res) { // 调用成功回调函数
        console.log(res);
    },
    function(status, text) { // 调用出错回调函数
        console.error(status + ":" + text);
    }
);

调用成功过输出：

[
    {name: "信纸", height: 27940, width: 21590},
    {name: "法律专用纸", height: 35560, width: 21590},
    {name: "Statement", height: 21590,  width: 13970},
    {name: "Executive", height: 26670, width: 18410},
    {name: "A4", height: 29700, width: 21000},
    {name: "A5", height: 21000, width: 14800},
    // ...
]

instance.print.listPrinterJob()

获取打印机当前的作业列表。

instance.print.listPrinterJob(printerName, onsuccess, onerror);

参数

printerName

打印机名称，String类型，必选。

onsuccess

成功回调函数，Function类型，可选。

onsuccess(result) {
    console.log(result); 
}

参数说明：

字段名称类型描述
resultArray打印作业列表（json数组），格式如下

作业内容，Windows平台与Linux/macOS平台不同。

Windows平台作业信息字段：

字段名称类型描述
documentString文档名称， 详情参考 pDocument
idInteger作业ID，详情参考 JobId
statusInteger状态码， 详情参考 Status
priorityInteger作业优先级， 详情参考 Priority
sizeInteger打印内容大小，单位字节， 详情参考 Size
totalPagesInteger要打印的总页数， 详情参考 TotalPages
pagesPrintedInteger已打印页数，有些打印机总是返回0，详情参考 PagesPrinted
positionInteger当前作业在作业队列中位置， 详情参考 Position

Linux/macOS平台作业信息：

字段名称类型描述
documentString文档名称
idInteger作业ID
statusInteger作业状态

 

  • 3 (IPP_JSTATE_PENDING): 等待打印
  • 4 (IPP_JSTATE_HELD: 作业被保留用于打印
  • 5 (IPP_JSTATE_PROCESSING): 作业被保留用于打印
  • 6 (IPP_JSTATE_STOPPED): 作业已停止
  • 7 (IPP_JSTATE_CANCELED): 作业已被取消
  • 8 (IPP_JSTATE_ABORTED): 由于错误，作业已中止
  • 9 (IPP_JSTATE_COMPLETED): 工作已成功完成
priorityInteger作业优先级（1-100）
sizeInteger打印内容大小，单位字节

onerror

失败回调函数，Function类型，可选。

onerror(status, text) {
    console.log(status + ":" + text); 
}

参数说明：

字段名称类型描述
statusInteger错误状态号，例如：400
textString错误信息，例如：授权证书无效

返回值

无

示例

获取打印机当前的作业列表：

var printerName = "xxx xxx";
instance.print.listPrinterJob(
    printerName, 
    function(res) { // 调用成功回调函数
        console.log(res);
    },
    function(status, text) { // 调用出错回调函数
        console.error(status + ":" + text);
    }
);

instance.print.getPrinterState()

获取打印机状态。

instance.print.getPrinterState(printerName, onsuccess, onerror);

参数

printerName

指定打印机名称，String类型，必选。

onsuccess

成功回调函数，Function类型，可选。

onsuccess(result) {
    console.log(result); 
}

参数说明：

字段名称类型描述
resultString打印机状态，是下面4个值之一：

 

  • "idle" 空闲
  • "active" 活跃
  • "aborted" 退出
  • "error" 错误

onerror

失败回调函数，Function类型，可选。

onerror(status, text) {
    console.log(status + ":" + text); 
}

参数说明：

字段名称类型描述
statusInteger错误状态号，例如：400
textString错误信息，例如：授权证书无效

返回值

无

示例

获取打印机当前状态：

var printerName = "xxx xxx";
instance.print.getPrinterState(
    printerName, 
    function(res) { // 调用成功回调函数
        console.log(res); // 输出状态，例如："idle"
    },
    function(status, text) { // 调用出错回调函数
        console.error(status + ":" + text);
    }
);

instance.print.print() / instance.print.printConfig() / instance.print.printPreview()

发送打印内容（文档）。这些接口都是异步调用，调用后立即返回。可通过监听事件，获取调用结果。

// 直接打印
function print(doc, onsuccess, onerror); 

// 弹出打印设置对话框，点击"打印"按钮打印
function printConfig(doc, onsuccess, onerror);  

// 显示打印预览窗口，点击"打印"按钮打印
function printPreview(doc, onsuccess, onerror);

参数

doc

json格式，要打印的内容配置。

参数名称类型必选描述
printerNameString否打印机名称，省略则使用默认打印机
nameString否文档名称，默认值“文档”
typeString否文档类型，可以取值html/url/pdf，默认值html
contentString是要发送的打印内容。当type为html类型时，content值为html内容，支持css，例如："<div style='color: red; font-weight:bold;'>HTML内容</div>"。当type为url类型时，content值为url，例如："https://www.nengjj.com"。
optionObject否打印选项设置，选项详情见下面的表：option字段

表：option字段

参数名称类型必选描述
collateString否是否逐份打印，取值"yes"/"no"，默认值"yes"
colorString否黑白或彩色打印，取值"yes"，表示使用彩色打印，取值"no"，表示使用黑白打印，默认值"yes"
orientationString否纸张纵向或横向打印，取值"portrait"，表示纵向打印，取值"landscape"，表示横向打印，默认值"portrait"纵向打印
duplexString否双面/单面打印（需要打印机支持）。
可取值如下：

 

  • "duplex_none" 单面打印
  • "duplex_auto" 由打印机的默认设置决定
  • "duplex_long_side" 双面（长边反转）
  • "duplex_short_side" 双面（短边反转）

默认值"duplex_none" 单面打印

copyCountInteger否打印份数，默认值1
pageRangeString否页码范围，可取值"1-8"，表示打印1到8页，省略表示全部页面
paperWidth
paperHeight		Double否纸张尺寸（规格），单位毫米。如果设置的纸张尺寸与标准纸张尺寸很接近，会自动转换为标准纸张尺寸。在设置纸张尺寸前，可使用listPrinterPaper函数获取打印机支持的纸张规格。省略使用打印机当前设置。
marginTop
marginBottom
marginLeft
marginRight		Double否页面边距，单位毫米。打印机通常都有默认的最小边距（例如2.96mm），小于最小值的边距设置将无效。省略使用打印机当前设置。

onsuccess

成功回调函数。

onsuccess(result) {
    console.log(result); 
}

参数说明：

字段名称类型描述
resultObject打印内容发送结果

result包含的字段：

字段名称类型描述
docIdString生成文档的ID（UUID格式），可用于在监听事件时，过滤事件。

onerror

失败回调函数。

onerror(status, text) {
    console.log(status + ":" + text); 
}

参数说明：

字段名称类型描述
statusInteger错误状态号，例如：400
textString错误信息，例如：授权证书无效

返回值

无

示例

打印预览：

instance.print.printPreview({
    content: "<div style='color: red; font-weight:bold;'>HTML内容</div>",
    option: {
        marginTop: 10,
        marginBottom: 10,
        marginLeft: 10,
        marginRight: 10,
        paperWidth: 210,
        paperHeight: 297,
    }
},
function(result){
    console.log(result);
});

nengjj_event_print 事件

打印过程中的事件通知。打印请求都是异步请求，打印结果将以事件方式通知调用者，调用者需监听相关事件。

document.addEventListener("nengjj_event_print", function(e){
    console.log(e);
    console.log(e.detail);
});

事件详情包含在event.detail属性中。

event例子：

{
    type: "nengjj_event_print",
    detail: {
        docId: "1de9962c-1ea9-477a-af78-947988fe1020",
        state: "PRINT_INIT",
        ...
    }
    ...
}

参数

“PRINT_INIT”状态

表示插件收到网页端发送的打印请求。

字段名称类型描述
stateString状态值，此处取值"PRINT_INIT"
docIdString文档ID

“PRINT_CANCEL”状态

用户取消打印请求。例如，在printConfig调用时，弹出对话框，没有点击打印按钮，而是关闭对话框退出了，代理插件会发送此状态事件。

字段名称类型描述
stateString状态值，此处取值"PRINT_CANCEL"
docIdString文档ID

“PRINT_SUBMIT”状态

打印内容已经提交给打印机，打印任务将被放置到作业队列中。

字段名称类型描述
stateString状态值，此处取值"PRINT_SUBMIT"
docIdString文档ID

“PRINT_ERROR”状态

打印出错。

字段名称类型描述
stateString状态值，此处取值"PRINT_ERROR"
docIdString文档ID
stateTextString状态文本

“PRINT_DONE”状态

打印结束。Windows平台和Linux/macOS平台参数有区别。

windows平台：

字段名称类型描述
stateString状态值，此处取值"PRINT_DONE"
docIdString文档ID
jobIdInteger作业ID
totalPagesInteger要打印的总页数
pagesPrintedInteger已打印页数

Linux/macOS平台：

字段名称类型描述
stateString状态值，此处取值"PRINT_DONE"
docIdString文档ID
jobIdInteger作业ID

Linux/macOS平台收到此状态的事件，通常已经打印完全部页面。

示例

例1：

监听打印机状态改变事件。

document.addEventListener("nengjj_event_print", function(e){
    console.log(e);
});

输出：

{
    type: "nengjj_event_print",
    detail: {
        docId: "1de9962c-1ea9-477a-af78-947988fe1020",
        state: "PRINT_INIT",
        ...
    }
    ...
}

例2：

监听某次打印的事件。

instance.print.print({
	name:"测试",
	content: "<div style='color: red; font-weight:bold;'>Hello</div>",
}, 
function(result){
    console.log(result);

    document.addEventListener(
        "nengjj_event_print", // 事件类型总是 nengjj_event_print
        function(e) {
            console.log(e);

            if(e.detail.docId == result.docId) {
                switch(e.detail.state)
                {
                    case "PRINT_INIT":
                    // ...
                    break;

                    case "PRINT_DONE":
                    // ...
                    break;

                }
            }

        }
    );
});
八狐云|酷画册|二维码生成
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
python 利用win32 打印文件
Alfie的博客
09-09 4445
python调用win32api 查看打印机信息： import win32print printers=win32print.EnumPrinters(2) #关于EnumPrinters中的一些参数获得不同的嵌套元组，获得打印机的具体信息 print(printers) import tempfile import win32api import win32print filena...
获取所有打印机，设置默认打印机，获取默认打印机
lys07962000的专栏
03-26 5470
#include #pragma comment(lib, "Winspool.lib") /////////////////////////获取默认打印机///////////////////// static void GetDefaultPrinter(CString& csPrinter) { HANDLE hPrinter = NULL; DWORD dwSize = 0;
获取对应打印机纸张长宽的C#类
04-23
完全是源码,用vs2012开发,不过,把类拿 过去 ,直接调用就可以了,我用的是2.0编译的,纯源码,希望 大家喜欢
遍历电脑打印机、设置默认打印机、EnumPrinters ,SetDefaultPrinter,GetDefaultPrinter
weixin_34187822的博客
08-24 655
时间紧迫，直接上代码：   得到电脑的默认打印机 TCHAR szBuffer[1024]={0}; DWORD length = 1024; int ret = ::GetDefaultPrinter(szBuffer,&amp;length); if(ret == FALSE) ret = ::GetLastError();...
QT打印PDF
CPeasant_Eva的专栏
04-25 3038
QPrinter printer;        QPrintDialog printDialog(&printer);        if(printDialog.exec())        {               QString qstrPrinterName = printer.printerName();               memset(szBufferDef
Java 9 - 在线API中文手册中文版 - 函数查询助手
最新发布
06-17
总之，这个Java 9在线API中文手册中文版是开发过程中不可或缺的参考资料，无论是Java SE还是Java EE，甚至是Android开发者，都能从中受益匪浅。通过深入学习和实践手册中的内容，开发者可以充分利用Java 9的新特性，...
jQuery API 手册（英文版）
02-23
《jQuery API 手册》是Web开发者不可或缺的参考资料，它详细介绍了jQuery库的各种函数、方法和事件，旨在帮助开发者高效地使用这个强大的JavaScript库。英文版的手册为全球开发者提供了通用的语言环境，使得交流和...
FastReport.NET 用户手册2023（中文版）
06-01
2023年的最新版用户手册是开发者掌握FastReport.NET核心功能和最新特性的关键参考资料。本文将深入探讨FastReport.NET的关键知识点，包括其设计理念、主要功能、报表设计、数据绑定、打印与导出、以及插件与扩展。 ...
TeklaOpenAPI指导手册20.0版本
05-28
8. **许可证和兼容性**：使用 Tekla OpenAPI 进行开发需要合适的许可证，同时要注意 API 的版本与 Tekla Structures 版本之间的兼容性，确保所编写的插件或脚本能在目标环境中正常运行。 通过掌握 Tekla OpenAPI，...
FastReport.NET 程序员手册2023（中文版）
06-01
《FastReport.NET 程序员手册2023（中文版）》是针对.NET开发者设计的一款详尽的报表开发指南。FastReport是一款强大的报表解决方案，它...无论你是初学者还是有经验的开发者，这本手册都将是你得力的工具和参考资料。
webprint插件api文档
08-05
webprint是在VC7.0上开发的ATL小控件（只有75k），运行时不可视。主要实现对IE浏览器中文档打印格式的控制，可以定制打印纸型，纸张来源，打印方向等等用户经常关心的属性。 用户通过代码可以自定义纸张，打印方向，页边距等等属性达到定制打印的目的，这些定制属性的设置不会改变IE浏览器的默认打印属性。也可以通过服务器端的页面调用webprint插件生成客户端的页面达到设置打印参数的目的。 开发平台：VC7.0 应用平台 Microsoft Windows Win32 OS 平台(除了Windows NT 3.51) Microsoft Internet Explorer versions 5.5以上
使用python和pywin32模块实现连接打印机批量打印文件
一览大侠的博客
09-24 5985
使用python实现连接打印机批量打印文件python打印文件python连接打印机python打印文档文件python打印图片文件python批量打印文文件 python打印文件 python连接打印机 使用模块：win32print 官方文档： 模块win32print. pip install pywin32 import win32print import win32api 查看当前电脑上安装了哪些打印机： #查看当前电脑上安装了哪些打印机： import win32print printers =
分享一段用VC调用默认打印机打印菜单的程序
moruite的专栏
03-01 6932
1. 获取默认打印机名称 BOOL GetDefaultPrinter(LPTSTR szPrinterName, int nPrintNameBufferLen) { *szPrinterName = 0; CPrintDialog pd(FALSE); if (pd.GetDefaults()) { if (pd.m_pd.hDC)
C#调用windows api 实现打印机控制
weixin_34010566的博客
08-03 1445
using System; using System.Text; using System.Runtime.InteropServices; using System.Security; using System.ComponentModel; namespace SoftPOS { public class PrinterHelper { ...
delphi 获取打印机默认纸张_请教用DELPHI怎样设置和获得打印机的纸张大小
weixin_39637457的博客
12-30 446
由 wutianbin » 星期一, 2000年12月11日 15:20usesWindows,WinSpool, //一定要 uses 这玩意SysUtils,Registry,Classes;//=================================function TForm1.GetDeviceName():String;var MyReg: TRegistry;szDevi...
【.Net码农】c#打印机设置，取得打印机列表及相应打印机的所有纸张格式
能看代码的CrackLibby
07-18 5463
http://www.it610.com/article/1490591.htm c#打印机设置，取得打印机列表及相应打印机的所有纸张格式 using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawi
获取打印机设置的纸张参数
weixin_30371875的博客
10-18 648
PrintDialogBS=newPrintDialog(); intx=BS.PrinterSettings.DefaultPageSettings.PaperSize.Width;//打印机默认纸张大小 inty=BS.PrinterSettings.DefaultPageSettings.PaperSize.Height; 转载于:https://www.cnblog...
Webprint插件api技术手册样本.doc
12-18
Webprint插件API技术手册提供了一个详细的技术指南，用于理解和操作Webprint插件，这是一款基于VC7.0开发的ATL小控件，专用于IE浏览器文档的打印格式控制。这款插件的主要特点是其轻量级（仅75KB），并且在运行时是...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值