优道PDF阅读控件使用帮助

• 功能概述
• 运行环境
• 网页中嵌入控件
• 服务器文档加密
• 服务器端版权控制
• 控件属性
• 控件方法
• 控件事件
• 错误码说明
• 其它

功能概述

优道PDF阅读控件（UUDoc PDF Control）是一款支持反截屏功能的PDF文档数字版权保护控件，支持对PDF文档的在线加密保护，可支持多种不同类型的浏览器和桌面应用程序使用。控件通过简单的属性设置即可完成对文档的复制、打印和截图的授权控制，独特的服务器端配置模式，支持在服务器端对控件进行属性设置, 防止了客户端通过脚本对版权控制功能进行篡改的可能。控件支持内存方式加载文档和加密传输方式远程加载文档，控件小巧可独立运行，不需要另外再安装其它庞大的PDF阅读器。

控件自带有换页、查找、缩放、拖拽、旋转、适应页面、适应页宽等常用文档浏览器的功能，可以轻松的嵌入到各类网站、Web应用系统和桌面应用程序当中，能有效的和您目前的应用进行无缝集成。控件支持PDF动态水印定义功能，能给您最强有力的文档阅读和数字版权保护功能支持。

运行环境

服务器端：支持Windows和Linux操作系统，支持任何的服务器编程语言，例如asp,asp.net,php,java,python,ruby等

支持使用HTTP、HTTPS、FTP协议从服务器远程加载文档，支持服务器身份验证

控件客户端支持的操作系统：WindowsXP/2003/2008/Vista/Win7/Win8

桌面开发支持的编程语言：VB、CSharp 、VB.NET、Delphi、C++等

支持32位及64位操作系统和浏览器

支持嵌入到基于ActiveX技术的IE浏览器和使用NPAPI技术的非IE浏览器中

支持英文、中文简体、中文繁体等多种语言用户界面

网页中嵌入控件

您可以参考我们提供的演示文件在网页中嵌入优道PDF阅读控件：

控件的PlogId为:UdPdf.Viewer

控件的ClassId为:8C3D3705-1100-4D52-9D04-7E9A435CE220

控件的ContentType为: application/udpdf-plugin

   
    <object id="pdfCtl" width="100%" height="600" classid="CLSID:8C3D3705-1100-4D52-9D04-7E9A435CE220"
         codebase="UdPdf/axUdPdf32.msi#Version=2,5,4,0">
         <param name="License" value="" />

         <embed id="pdfPlugin" width="100%" height="600" type="application/udpdf-plugin"
            pluginspage="UdPdf/npUdPdf.msi#Version=2,5,4,0"
            License=""
            onReady="f_onReady" onDownload="f_onDownload" onPageChanged="f_onPageChanged"
            onZoom="f_onZoom" onError="f_onError"></embed>
    </object>

    

其中axUdPdf32.msi为控件32位ActiveX版的安装程序,安装后控件支持IE访问；npUdPdf.msi为NPAPI版的安装程序，安装后支持FireFox、Chrome、Safari等使用NPAPI标准的非IE浏览器使用。

初始化判断控件是否安装,并获取PDF控件对象：

    function f_initPdf(){
        var udPdfCtl = null;
        if(window.ActiveXObject){//if IE
            var axobj = null;                
            var setupFile = "UdPdf/axUdPdf32.msi";//PDF控件安装文件
            if(window.navigator.platform == "Win64" 
              || window.navigator.cpuClass == "x64")//64位浏览器安装文件
                setupFile = "UdPdf/axUdPdf64.msi";
			
            try{
                axobj = new ActiveXObject('UdPdf.Viewer'); 
            }catch(e){}
            if(axobj) {
                if(f_checkNewVersion(axobj.GetVersion())){                    
                    document.getElementById("udPdfDiv").innerHTML = "<a href='" + setupFile
                     + "' class='inst' target='_blank'>PDF控件有新版本v" 
                     + UDPDF_VERSION + "，点这里升级安装...</a>";
                }
                else{
                    udPdfCtl = document.getElementById("udPdfCtl");
                    return udPdfCtl;
                }
            }
            else{
                document.getElementById("udPdfDiv").innerHTML = "<a href='" + setupFile
                 + "' class='inst' target='_blank'>>您尚未安装PDF控件，点这里进行安装...</a>";
            }		    
        }
        else{//NOT IE
            var setupFile = "UdPdf/npUdPdf.msi";
            if (navigator.plugins && navigator.plugins.length > 0){
                var plugin = navigator.plugins["UdPdf Plugin"];
                if(plugin){
                    udPdfCtl = document.getElementById("udPdfPlugin");
                    if(f_checkNewVersion(udPdfCtl.GetVersion())){
                        document.getElementById("udPdfDiv").innerHTML = "<a href='" + setupFile
                         + "' target='_blank' class='inst'>PDF控件有新版本v"
                         + UDPDF_VERSION + "，点这里升级安装...</a>";
                    }
                    else{
                        return udPdfCtl;
                    }
                }
                else{
                    document.getElementById("udPdfDiv").innerHTML = "<a href='" + setupFile
                     + "' target='_blank' class='inst'>您尚未安装PDF插件，点这里进行安装...</a>";
                }     
            }   
            else{
                document.getElementById("udPdfDiv").innerHTML = "<span class='inst'>当前浏览器不支持插件<span>";   
            }     
        }
        return null;
    }

    //版本比较，检查是否安装了新版本
    function f_checkNewVersion(instVer){
        var newVer = UDPDF_VERSION.split(".");
        var curVer = instVer.split(".");
        if(parseInt(newVer[0]) > parseInt(curVer[0]))
            return true;
        if(parseInt(newVer[0]) == parseInt(curVer[0]) && parseInt(newVer[1]) > parseInt(curVer[1]))
            return true;
        if(parseInt(newVer[0]) == parseInt(curVer[0]) && parseInt(newVer[1]) == parseInt(curVer[1]) 
          && parseInt(newVer[2]) > parseInt(curVer[2]))
            return true;
        return false;
    }

    //初始化加载的时候获取控件对象
    var ctl;
    function f_onload() {
        ctl = f_initPdf();//获取失败返回null
        if(ctl){
            ctl.FileId="PdfSample"
            ctl.LoadFromWeb("GetFile.asp");
        }
    }
    

属性的设置示例：

   
    <script type="text/javascript">
        //根据复选框判断是否显示工具条
        function f_toolbarVisible() {
            if(ctl)
                ctl.ToolbarVisible = document.getElementById("chkToolbarVisible").checked
        }
    </script>
    

方法的调用示例

    <script type="text/javascript"> 
        //放大操作
        function f_zoomIn() {
            if(ctl)
                ctl.ZoomIn();
        }
    </script>
    

事件的捕捉示例，兼容所有浏览器：

    <script type="text/javascript" event="OnError(errorCode)" for="pdfCtl">  
        f_onError(errorCode);
    </script>

    <script type="text/javascript">  
        function f_onError(errorCode){
	    document.getElementById("info").innerHTML = "OnError事件，文档加载失败，错误码：" + errorCode;
	}
    </script>
    

服务器文档加密

使用优道科技提供的文档加密工具UdPdfTools.exe对文档进行加密，加密后的文件会在原扩展名前加上en前缀。加密工具支持命令行方式。

加密时可以指定加密密码，加密后需要将密码的哈希值填写到控件的HashKey参数当中

将加密后的文件上传到服务器上，在控件页面根据所传递的参数将需要的加密文件读取并进行输出

若不想别人通过页面获取到参数的配置情况，可以使用此工具对属性配置内容进行加密，原配置字符串使用"&"分隔的键值对格式，多个参数之间使用"|"进行分隔，支持相应的属性或方法名称

也可在服务器上调用加密命令行工具直接完成普通文档文件到加密文件的转换，命令行使用说明：

   
        参数说明:
          -input <file>           要进行加密保护的PDF文件名
          -output <folder>        指定加密后的文件输出目录或文件名
          -password <password>    设置加密使用的密码,会返回加密过的哈希码,可放在PDF控件的HashKey属性当中
          -encrypt <config>       创建使用"&"进行分隔的加密字符串,可用在PDF控件的EncryptConfig属性
                                  和EncryptExecute方法中使用
          -help                   显示UdPdfTools.exe的使用帮助信息

        使用示例:
          UdPdfTools -input c:\test.pdf -output "c:\hello world" -password 123abc

          以下是对属性配置进行加密,加密后的字符串可以放在EncryptConfig属性当中
          UdPdfTools -encrypt "EnableCopy=true&EnablePrint=false&ToolbarVisible=false"

          以下是对方法进行加密,支持"|"分隔的多个参数,加密后的字符串可以用EncryptExecute(string)函数来执行
          UdPdfTools -encrypt "LoadFromWeb=sample.asp|123456"

          如果是对密码参数进行加密，传入密码参数时需要添加“[Encrypt]”前缀。
          例如:  UdPdfTools.exe –encrypt 123456
          The encrypt confing string is:
          4019DA9B613B82F72186203AA9ABE0C7

          然后可以添加“[Encrypt]”前缀使用加密密码的方式打开pdf文档：
          ctl.LoadFromWeb(“getfile.aspx”,“[Encrypt]4019DA9B613B82F72186203AA9ABE0C7”,“post”);


      

ActiveX控件的FileId会被提交回服务器，可以根据该值输出不同的文件，以下是C#的服务器ASP.NET示例代码，也可方便的用其它语言编写：

        protected void Page_Load(object sender, EventArgs e)
        {
            if (Request.Form["uudoc_getfile"] == "1")//如果是提交请求文件
            {
		//可以通过HashKey的设置进行HTTP头安全校验
    		if (Request.Headers["UdPdf-HashKey"] != "3CE59E850E2C590AFD6E4D3516BA3F1B")
    	    	    return;

                //根据文件ID获取不同的加密文件或原始文件，需要根据实际情况编写自己的业务逻辑
		if (Request.Form["uudoc_encrypted"] == "1")//是否使用加密读取方式
		{
		    //读取加密过的PDF文件                	
                    Response.WriteFile(Server.MapPath("upload/" + Request.Form["uudoc_fileid"] + ".enpdf"));
		}
		else
		{
		    //读取原始PDF文件
                    Response.WriteFile(Server.MapPath("upload/" + Request.Form["uudoc_fileid"] + ".pdf"));
		}
                Response.End();
            }
        }
    

可向服务器提交的参数有：

服务器端版权控制

优道PDF控件支持服务器端的属性设置，在服务器端进行属性设置后客户端的部分版权控制功能将不再有效，从而更安全的保护了PDF文档的安全性。

服务器端使用http头的方式对控件属性进行设置，支持的http头设置的名称为UdPdf-Config和UdPdf-EncryptConfig。

UdPdf-Config配置的参数值为使用“&”分隔的字符串，例如"EnableCopy=true&EnablePrint=false&ToolbarVisible=false"。

UdPdf-EncryptConfig配置的参数值为以上加密后的字符串内容，具体加密方法请参看上一节中UdPdfTools.exe工具的使用

在C#/VB.NET中可以使用Response.AppendHeader进行http头的设置，例如：

        Response.AppendHeader("UdPdf-Config", "EnableCopy=false&EnablePrint=false");
    或者：
	Response.AppendHeader("UdPdf-EncryptConfig", "74321C0******BA168");

在Java语言中可以使用response.setHeader进行http头的设置，例如：

	response.setHeader("UdPdf-Config", "EnableCopy=false&EnablePrint=false");
    或者：
	response.setHeader("UdPdf-EncryptConfig", "***加密后的字符串***");

使用http头进行属性设置后下列和版权保护相关的属性在客户端的设置将不再有效：

ActiveX控件向服务器请求文件的时候同时会以http头的方式提交下列值：

• UdPdf-Version：优道PDF阅读控件的版本号
• UdPdf-HashKey：HashKey属性，可用作请求合法性校验
• UdPdf-UrlType：如果使用相对路径来请求的这里值为0，使用绝对路径值为1，可以用来控制是否只允许相对路径来获取文件

在C#/VB.NET语言中可以使用Request.Headers["UdPdf-UrlType"]来获取到相关的http头的值，Java中可以使用request.getHeader("UdPdf-UrlType")来获取。

控件属性

控件方法

在需要传入密码的方法中，例如LoadFromWeb,LoadFromFile,SetServerUser等方法，可以先使用UdPdfTools.exe工具对密码进行加密，然后使用“[Encrypt]”前缀(不区分大小写)支持传入加密过的密码，防止别人获取到密码直接对PDF文档进行解密。

例如某个pdf文档的默认加密密码是：123456，使用命令行工具：

UdPdfTools.exe –encrypt 123456

获取到加密后的密码是：4019DA9B613B82F72186203AA9ABE0C7

然后可以添加“[Encrypt]”前缀使用加密密码的方式打开pdf文档：

ctl.LoadFromWeb(“getfile.aspx”,“[Encrypt]4019DA9B613B82F72186203AA9ABE0C7”,“post”);

控件事件

错误码说明

其它

• 关于优道：珠海市优道信息科技有限公司是一家致力于文档管理、数字版权保护和移动办公产品研发和推广的科技公司。
• 优道网站：www.uudoc.com
• 优道服务热线：0756-2132796，技术支持邮件：support@uudoc.com，技术支持QQ：13063574