文档

ActivePDF

更新时间:

本文介绍与PDF文档ActivePDF相关的API。

ActivePDF

获取当前PDF文档。

  • 语法

    表达式.ActivePDF

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取当前PDF文档
      const ActivePDF = await app.ActivePDF;
    }

方法

ActivePDF.GetOperatorsInfo()

通过GetOperatorsInfo()方法,您可以获取登录操作者的信息。

  • 语法

    表达式.ActivePDF.GetOperatorsInfo()

    表达式:文档类型应用对象

  • 返回值

    • Object object

      属性

      数据类型

      描述

      type

      String

      请求类型。

      response

      Object

      用户信息列表。

    • response结构

      属性

      数据类型

      描述

      id

      String

      用户ID。

      avatar_url

      String

      用户头像。

      logined

      String

      用户登录状态。

      name

      String

      用户姓名。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取登录操作者信息
      const operatorsInfo = await app.ActivePDF.GetOperatorsInfo();
      console.log(operatorsInfo);
    }

ActivePDF.JumpToPage()

通过JumpToPage()方法,您可以跳转到指定页面。

  • 语法

    表达式.ActivePDF.JumpToPage(PageNum)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    PageNum

    Number

    跳转到的页码。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //跳转到指定页面
      await app.ActivePDF.JumpToPage(3);
    }

ActivePDF.ExportAsFixedFormat()

通过ExportAsFixedFormat()方法,您可以将当前PDF文档导出图片。

  • 语法

    表达式.ActivePDF.ExportAsFixedFormat({ FixedFormatType })

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    FixedFormatType

    Enum

    导出的文件类型,目前仅支持导出图片。更多信息,请参见FixedFormatType

    Print

    Boolean

    是否直接打开导出后的文件。取值范围如下:

    • false(默认):否。

    • true:是。

    ImgFormat

    Enum

    导出图片的格式。更多信息,请参见ExportImgFormatType

    Dpi

    Number

    图片分辨率,单位为ppi。取值范围为96~2048,默认值为96。

    Combine2LongPic

    Boolean

    是否导出长图。取值范围如下:

    • false(默认):否。

    • true:是。

    RangeType

    Enum

    导出范围。更多信息,请参见RangeType

    WaterMark

    Boolean

    导出文件是否含水印。取值范围如下:

    • false(默认):否。

    • true:是。

    From

    Boolean

    起始页。默认为当前页。

    To

    Boolean

    结束页。默认为当前页。

  • 返回值

    返回导出文件的URL。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //导出当前PDF文档为图片
      const imgUrl = await app.ActivePDF.ExportAsFixedFormat({
        FixedFormatType: app.Enum.FixedFormatType.TypeIMG,
      });
      console.log(imgUrl);
    }

ActivePDF.Save()

通过Save()方法,您可以保存文件的改动。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.Save()

    表达式:文档类型应用对象

  • 返回值

    属性

    数据类型

    描述

    result

    String

    保存状态。

    size

    Number

    文件大小,单位为字节。

    version

    Number

    版本。

    保存状态说明

    保存状态

    描述

    ok

    版本保存成功,可在历史版本中查看。

    nochange

    文档无更新,无需保存版本。

    SavedEmptyFile

    暂不支持保存空文件。触发场景:内核保存完后文件为空。

    SpaceFull

    空间已满。

    QueneFull

    保存中请勿频繁操作。触发场景:服务端处理保存队列已满,正在排队。

    fail

    保存失败。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //保存文件的改动
      const saveResult = await app.ActivePDF.Save();
      console.log(saveResult);
    }

ActivePDF.SetOpenMarkerInkEdit()

通过SetOpenMarkerInkEdit()方法,您可以设置开启画笔或者保存画笔并退出。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.SetOpenMarkerInkEdit({ Open })

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Open

    Boolean

    设置是否开启画笔或者保存画笔并退出。取值范围如下:

    • true(默认):开启画笔。

    • false:保存画笔并退出。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //开启画笔
      await app.ActivePDF.SetOpenMarkerInkEdit(true);
    
      setTimeout(async () => {
        //5000 ms后保存画笔并退出
        await app.ActivePDF.SetOpenMarkerInkEdit(false);
      }, 5000);
    }

ActivePDF.ScrollTo()

通过ScrollTo()方法,您可以设置滚动到指定位置。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.ScrollTo(x, y)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    x

    Number

    滚动位置的x坐标。

    y

    Number

    滚动位置的y坐标。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //设置滚动到指定位置
      await app.ActivePDF.ScrollTo(100, 100);
    }

ActivePDF.StartPlay()

通过StartPlay()方法,您可以设置播放模式。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.StartPlay(type, DisFullscreen, HiddenMenu)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Type

    String

    播放模式。取值范围如下:

    • start:从第一页开始播放。

    • active(默认):从当前页开始播放。

    DisFullscreen

    Boolean

    是否全屏。取值范围如下:

    • false(默认):否。

    • true:是。

    HiddenMenu

    Boolean

    是否隐藏菜单。取值范围如下:

    • false(默认):否。

    • true:是。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //设置播放模式
      await app.ActivePDF.StartPlay("active", true, true);
    }

ActivePDF.EndPlay()

通过EndPlay()方法,您可以退出播放模式。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.EndPlay()

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //退出播放模式
      await app.ActivePDF.EndPlay();
    }

ActivePDF.GetSelectionPicture()

通过GetSelectionPicture()方法,您可以获取选定的图片。

重要

JS-SDK V1.1.11及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.GetSelectionPicture()

    表达式:文档类型应用对象

  • 返回值

    属性

    数据类型

    描述

    result

    String

    图片地址。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取选定的图片
      await app.ActivePDF.GetSelectionPicture();
    }

ActivePDF.GetPageRenderPicture()

通过GetPageRenderPicture()方法,您可以将指定页转换为图片。

重要

JS-SDK V1.1.11及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.GetPageRenderPicture()

    表达式:文档类型应用对象

  • 返回值

    属性

    数据类型

    描述

    result

    String

    图片地址。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //将指定页转换为图片
      await app.ActivePDF.GetPageRenderPicture();
    }

ActivePDF.GetMenuPageIndex()

通过GetMenuPageIndex()方法,您可以获取右键菜单所在的页。

重要

JS-SDK V1.1.11及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.GetMenuPageIndex()

    表达式:文档类型应用对象

  • 返回值

    属性

    数据类型

    描述

    result

    Number

    页码。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取右键菜单所在的页
      await app.ActivePDF.GetMenuPageIndex();
    }

ActivePDF.PageTextData()

通过PageTextData()方法,您可以获取指定页中的文本数据。

重要

JS-SDK V1.1.12及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.PageTextData(PageIndex)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    PageIndex

    Number

    指定的页码。

  • 返回值

    属性

    数据类型

    描述

    result

    Array

    文本数据对象Object。

    • pg:当前页数。

    • content:文本数据。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取第一页的文本数据
      const result = await app.ActivePDF.PageTextData(1);
      console.log(result)
    }

ActivePDF.GetSelectionEndPos()

通过GetSelectionEndPos()方法,您可以获取选定区域。

重要

JS-SDK V1.1.12及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.GetSelectionEndPos()

    表达式:文档类型应用对象

  • 返回值

    属性

    数据类型

    描述

    hasSelection

    Boolean

    是否选中。取值范围如下:

    • true:是。

    • false:否。

    x

    Number

    选区x轴坐标。

    y

    Number

    选区y轴坐标。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取选定区域
      const selectionEndPos = await app.ActivePDF.GetSelectionEndPos();
      console.log(selectionEndPos);
    }

ActivePDF.GetTextSelection()

通过GetTextSelection()方法,您可以获取选定区域的文本内容。

重要

JS-SDK V1.1.12及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.GetTextSelection()

    表达式:文档类型应用对象

  • 返回值

    属性

    数据类型

    描述

    Text

    String

    选区文本内容。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取选定区域的文本内容
      const selectionText = await app.ActivePDF.GetTextSelection();
      console.log(selectionText);
    }

ActivePDF.SetCopyToastVisible()

通过SetCopyToastVisible()方法,您可以设置显示或隐藏复制提示。

重要

JS-SDK V1.1.12及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.SetCopyToastVisible(Visible)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Visible

    Boolean

    是否显示复制提示。取值范围如下:

    • false(默认):否。

    • true:是。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //设置复制提示显示
      await app.ActivePDF.SetCopyToastVisible(true);
    
    }

ActivePDF.GetFileCreator()

通过GetFileCreator()方法,您可以获取文件的创建来源。

重要

JS-SDK V1.1.12及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.GetFileCreator()

    表达式:文档类型应用对象

  • 返回值

    属性

    数据类型

    描述

    result

    String

    文件创建来源。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取文件的创建来源
      const creator = await app.ActivePDF.GetFileCreator();
      console.log(creator);
    }

ActivePDF.GetScreenModeInPlay()

通过GetScreenModeInPlay()方法,您可以获取PDF文档的播放模式。

重要

JS-SDK V1.1.12及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.GetScreenModeInPlay()

    表达式:文档类型应用对象

  • 返回值

    属性

    数据类型

    描述

    mode

    String

    播放模式。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取播放模式
      const mode = await app.ActivePDF.GetScreenModeInPlay();
      console.log(mode);
    }

ActivePDF.BuiltinDocumentProperties()

通过BuiltinDocumentProperties()方法,您可以获取文档的内置属性。

重要

JS-SDK V1.1.12及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.BuiltinDocumentProperties(Name)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Name

    String

    属性名称。

  • 返回值

    属性

    数据类型

    描述

    documnet

    DocumentProperty

    属性对象。

    • Name:属性名称。

    • Value:属性值。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取文档的Title属性对象
      const Title = await app.ActivePDF.BuiltinDocumentProperties('Title');
      console.log(Title);
    }

ActivePDF.GetPageWidth()

通过GetPageWidth()方法,您可以通过页码获取指定页面的宽度。

重要

JS-SDK V1.1.12及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.GetPageWidth(PageIndex)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    PageIndex

    Number

    页码。

  • 返回值

    返回Number类型的页面宽度。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //通过页码获取指定页面的宽度
      const pageWidth = await app.ActivePDF.GetPageWidth(1);
      console.log(pageWidth);
    }

ActivePDF.GetPageHeight()

通过GetPageHeight()方法,您可以通过页码获取指定页面的高度。

重要

JS-SDK V1.1.12及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.GetPageHeight(PageIndex)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    PageIndex

    Number

    页码。

  • 返回值

    返回Number类型的页面高度。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //通过页码获取指定页面的高度
      const pageHeight = await app.ActivePDF.GetPageHeight(1);
      console.log(pageHeight);
    }

ActivePDF.GetPointPageInfoByWinPoint()

通过GetPointPageInfoByWinPoint()方法,您可以通过相对窗口页面的坐标获取原始PDF页面的坐标和页码。

重要

JS-SDK V1.1.12及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.GetPointPageInfoByWinPoint(x, y)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    x

    Number

    相对窗口页面的x坐标。

    y

    Number

    相对窗口页面的y坐标。

  • 返回值

    属性

    数据类型

    描述

    inContentRange

    Boolean

    传入坐标是否在PDF正文区域。取值范围如下:

    • true:是。

    • false:否。

    说明

    当返回值为false时,其他属性不会存在,即pageindexxy无返回值。

    pageIndex

    Number

    传入坐标对应原始PDF的所在页的页码。

    x

    Number

    传入坐标对应原始PDF页面的x坐标。

    y

    Number

    传入坐标对应原始PDF页面的y坐标。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //通过相对窗口页面的坐标获取原始PDF页面的坐标和页码
      const pointPageInfo = await app.ActivePDF.GetPointPageInfoByWinPoint(500,500);
      console.log(pointPageInfo);
    }

ActivePDF.RotatePage()

通过RotatePage()方法,您可以旋转PDF。

  • 语法

    表达式.ActivePDF.RotatePage(Value)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Value

    Number

    旋转角度。取值范围如下:

    • 参数可以为空,调用一次就在当前的角度上加90度。

    • 0:文档旋转角度为0度。

    • 90:文档旋转角度为90度。

    • 180:文档旋转角度为180度。

    • 270:文档旋转角度为270度。

  • 示例

    //@file=base.pdf
    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      const success = await app.ActivePDF.RotatePage();
      console.log('success: ', success);
    }

ActivePDF.SetSupportSelectArea()

通过SetSupportSelectArea()方法,您可以开启关闭框选功能。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.SetSupportSelectArea({isSupport})

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    参数值

    必填

    说明

    isSupport

    Boolean

    true

    开启框选功能

    isSupport

    Boolean

    false

    关闭框选功能

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // 开启框选功能
      await app.ActivePDF.SetSupportSelectArea({ isSupport: true });
    }

ActivePDF.PageCommentData()

通过PageCommentData()方法,您可以获取指定页中的批注。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.PageCommentData({PageIndex})

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    PageIndex

    Number

    指定的页数,从1开始

  • 返回值

    属性

    数据类型

    描述

    -

    Array

    对象数组

  • 数据对象Object

    属性

    数据类型

    描述

    id

    String

    批注id

    items

    Array

    注解批注评论数据

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      const data = await app.ActivePDF.PageCommentData({ PageIndex: 1 });
      console.log('data: ', data);
    }

ActivePDF.Find()

通过Find()方法,您可以查找关键字。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.Find({Value})

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Value

    String

    查找的参数

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      await app.ActivePDF.Find({ Value: 'hello' });
    }

ActivePDF.FindNext()

通过FindNext()方法,您可以查找下一个关键字。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.FindNext()

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      await app.ActivePDF.FindNext();
    }

ActivePDF.FindPrev()

通过FindPrev()方法,您可以查找上一个关键字。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.FindPrev()

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      await app.ActivePDF.FindPrev();
    }

ActivePDF.DiscardFind()

通过DiscardFind()方法,您可以取消查找。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.DiscardFind()

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      await app.ActivePDF.DiscardFind();
    }

ActivePDF.OpenAnnoList()

通过OpenAnnoList()方法,您可以打开批注列表。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActivePDF.OpenAnnoList()

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      await app.ActivePDF.OpenAnnoList();
    }

属性

ActivePDF.CurrentPage

通过CurrentPage属性,您可以获取当前页码。

  • 语法

    表达式.ActivePDF.CurrentPage

    表达式:文档类型应用对象

  • 返回值

    返回Number类型的页码。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取当前页码
      const curryPage = await app.ActivePDF.CurrentPage;
      console.log(curryPage);
    }

ActivePDF.DocumentMap

通过DocumentMap属性,您可以设置显示或隐藏目录。

  • 语法

    表达式.ActivePDF.DocumentMap = Boolean

    表达式:文档类型应用对象

    Boolean取值为true表示显示目录,取值为false表示隐藏目录。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //设置显示目录
      app.ActivePDF.DocumentMap = true;
    }

ActivePDF.PageMode

通过PageMode属性,您可以设置文档为单页或多页模式。

  • 语法

    表达式.ActivePDF.PageMode = Number

    表达式:文档类型应用对象

    Number取值为1表示单页模式,取值为0表示多页模式。

  • 示例

    async function example() {
      await instance.ready();
      
      const app = instance.Application;
    
      //设置文档为单页模式
      app.ActivePDF.PageMode = 1;
    }

ActivePDF.PagesCount

通过PagesCount属性,您可以获取文档的总页数。

  • 语法

    表达式.ActivePDF.PagesCount

    表达式:文档类型应用对象

  • 返回值

    返回Number类型的总页数。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取文档总页数
      const totalPages = await app.ActivePDF.PagesCount;
      console.log(totalPages);
    }

ActivePDF.Zoom

通过Zoom属性,您可以设置或获取窗口的缩放比例。

  • 语法

    表达式.ActivePDF.Zoom

    表达式:文档类型应用对象

  • 返回值

    返回Number类型的缩放比例。

  • 示例

    async function example() {
      await instance.ready();
      
      const app = instance.Application;
    
      //获取窗口缩放比例,默认为100,表示缩放比例为100%
      const result = await app.ActivePDF.Zoom;
      console.log(result);
    
      //设置窗口缩放比例
      app.ActivePDF.Zoom = 66;
    }

ActivePDF.ZoomToFit

对窗口大小调整后,您可以通过ZoomToFit属性设置是否缩放视图以适应文档窗口的尺寸。

  • 语法

    表达式.ActiveWindow.View.ZoomToFit = Number

    表达式:文档类型应用对象

    Number的取值范围如下:

    • -1:对文档窗口大小进行调整后使页面以最佳尺寸适应活动窗口。

    • 0:对文档窗口大小进行调整后不为适应文档窗口尺寸而缩放视图。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //不为适应文档窗口尺寸而缩放视图
      app.ActivePDF.ZoomToFit = 0;
    }

ActivePDF.Scroll

通过Scroll属性,您可以获取文档的滚动位置。

重要

JS-SDK V1.1.10以上版本支持此功能。

  • 语法

    表达式.ActivePDF.Scroll

    表达式:文档类型应用对象

  • 返回值

    返回滚动位置的坐标{x:xx,y:yy}。其中xx表示x轴的坐标,yy表示y轴的坐标。

  • 示例

    async function example() {
      await instance.ready();
      
      const app = instance.Application;
    
      //获取文档的滚动位置
      const result = await app.ActivePDF.Scroll;
      console.log(result);
    
    }

ActivePDF.PlayMode

通过PlayMode属性,您可以设置或获取播放状态。

重要

JS-SDK V1.1.10以上版本支持此功能。

  • 语法

    表达式.ActivePDF.PlayMode

    表达式:文档类型应用对象

    取值如下:

    • true:进入播放。

    • false:退出播放。

    • start:从第一页开始播放。

    • active:从当前页开始播放。

  • 示例

    async function example() {
      await instance.ready();
      
      const app = instance.Application;
    
      
      const pdf = await app.ActivePDF;
      
      //设置播放状态
      pdf.PlayMode = "start";
    
      //获取播放状态
      const mode = await pdf.PlayMode;
      console.log(mode);
    
    }

ActivePDF.DragMode

通过DragMode属性,您可以设置或获取拖拽模式。

重要

JS-SDK V1.1.10以上版本支持此功能。

  • 语法

    表达式.ActivePDF.DragMode

    表达式:文档类型应用对象

    取值如下:

    • true:进入拖拽。

    • false:退出拖拽。

  • 示例

    async function example() {
      await instance.ready();
      
      const app = instance.Application;
    
      
      const pdf = await app.ActivePDF;
      
      //设置进入拖拽模式
      pdf.DragMode = true;
    
      //获取拖拽模式
      const mode = await pdf.DragMode;
      console.log(mode);
    
    }

ActivePDF.ShowPages

通过ShowPages属性,您可以获取可视区域内的所有页面索引。

重要

JS-SDK V1.1.12以上版本支持此功能。

  • 语法

    表达式.ActivePDF.ShowPages

    表达式:文档类型应用对象

  • 返回值

    返回Array类型的可视区域内的所有页面索引。

  • 示例

    async function example() {
      await instance.ready();
      
      const app = instance.Application;
    
      
      const pdf = await app.ActivePDF;
      
      //获取视区域内的所有页面索引
      const pages = await pdf.ShowPages;
      console.log(pages);
    
    }

ActivePDF.ShowPagesTextData

通过ShowPagesTextData属性,您可以获取可视区域内的所有页面的文本数据。

重要

JS-SDK V1.1.12以上版本支持此功能。

  • 语法

    表达式.ActivePDF.ShowPagesTextData

    表达式:文档类型应用对象

  • 返回值

    返回Array类型的可视区域内的所有页面的文本数据。

    属性

    数据类型

    描述

    pg

    Number

    当前页数。

    content

    String

    文本数据。

  • 示例

    async function example() {
      await instance.ready();
      
      const app = instance.Application;
    
      
      const pdf = await app.ActivePDF;
      
      //获取可视区域内的所有页面的文本数据
      const result = await pdf.ShowPagesTextData;
      console.log(result);
    
    }

ActivePDF.ReadOnly

通过ReadOnly属性,您可以查看当前文档是否只读。

重要

JS-SDK V1.1.14以上版本支持此功能。

  • 语法

    表达式.ActivePDF.ReadOnly

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //查看当前文档是否只读
      const ReadOnly = await app.ActivePDF.ReadOnly;
    }

ActivePDF.ReadOnlyComment

通过ReadOnlyComment属性,您可以查看当前文档是否只读可评论。

重要

JS-SDK V1.1.15以上版本支持此功能。

  • 语法

    表达式.ActivePDF.ReadOnlyComment

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //查看当前文档是否只读可评论
      const ReadOnlyComment = await app.ActivePDF.ReadOnlyComment;
    }

ActivePDF.SupportReadOnlyComment

通过SupportReadOnlyComment属性,您可以查看当前文档是否支持只读可评论。

重要

JS-SDK V1.1.15以上版本支持此功能。

  • 语法

    表达式.ActivePDF.SupportReadOnlyComment

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //查看当前文档是否支持只读可评论
      const SupportReadOnlyComment = await app.ActivePDF.SupportReadOnlyComment;
    }
  • 本页导读 (1)