文档

Workbook

更新时间:

本文介绍与表格文档Workbook相关的API。

Workbook

Workbook

获取活动窗口中的活动工作簿。

重要

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

  • 语法

    表达式.ActiveWorkbook

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取活动工作簿
      const activeWorkbook = await app.ActiveWorkbook;
    }

方法

ActiveWorkbook.CopySheetFromBook()

通过CopySheetFromBook()方法,您可以将指定活动工作簿中的活动工作表复制到当前活动工作簿。

重要

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

  • 语法

    表达式.ActiveWorkbook.CopySheetFromBook({ FromBookFileId, FromBookFileName, FromeSheetName, DestSheetName })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    FromBookFileId

    String

    目标活动工作簿的ID

    FromBookFileName

    String

    目标活动工作簿的名称。

    FromeSheetName

    String

    目标活动工作簿中活动工作表名称。

    DestSheetName

    String

    需要复制到当前活动工作簿的活动工作表名称。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取活动工作簿
      const activeWorkbook = await app.ActiveWorkbook;
    
      //将ID为“100161090439”,名称为“工作簿”的活动工作簿中名称为“Sheet”的活动工作表复制到当前活工作簿中名称为“Sheet6”的活动工作表
      const result = await activeWorkbook.CopySheetFromBook('100161090439', '工作簿', 'Sheet1', 'Sheet6');
      console.log(result);
    }

ActiveWorkbook.ExportAsFixedFormat()

通过ExportAsFixedFormat()方法,您可以将当前活动工作簿导出为对应的PDF或IMG图片,并获取导出文件的URL。

重要

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

  • 语法

    表达式.ActiveWorkbook.ExportAsFixedFormat({ Type })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Type

    Enum

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

  • 返回值

    属性

    数据类型

    描述

    url

    String

    导出文件的URL。

  • 示例

    • 导出为PDF

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        //导出为PDF,并获取导出文件的URL
        const workbookPdfUrl = await app.ActiveWorkbook.ExportAsFixedFormat();
        console.log(workbookPdfUrl);
      }
      
    • 导出为图片

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        //导出为图片,并获取导出文件的URL
        const workbookImgUrl = await app.ActiveWorkbook.ExportAsFixedFormat({
          Type: app.Enum.XlFixedFormatType.xlTypeIMG,
        });
        console.log(workbookImgUrl);
      }

ActiveWorkbook.GetOperatorsInfo()

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

重要

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

  • 语法

    表达式.ActiveWorkbook.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.ActiveWorkbook.GetOperatorsInfo();
      console.log(operatorsInfo);
    }

ActiveWorkbook.SetFilterShared()

通过SetFilterShared()方法,您可以开启或关闭多人同步筛选。

重要

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

  • 语法

    表达式.ActiveWorkbook.SetFilterShared({ Checked })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Checked

    Boolean

    是否开启多人同步筛选。取值范围如下:

    • true:开启。

    • false:关闭。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取活动工作簿
      const activeWorkbook = await app.ActiveWorkbook;
    
      //开启多人同步筛选
      const result = await activeWorkbook.SetFilterShared(true);
    }

ActiveWorkbook.Save()

通过Save()方法,您可以保存活动工作簿的改动。

重要

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

  • 语法

    表达式.ActiveWorkbook.Save()

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

  • 返回值

    属性

    数据类型

    描述

    result

    String

    保存状态。取值范围如下:

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

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

    • SavedEmptyFile:保存空文件,暂不支持。

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

    • SpaceFull:空间已满。

    • QueneFull:保存中请勿频繁操作。

      触发场景:服务端处理保存队列已满,正在排队。

    • fail:保存失败。

    size

    Number

    文件大小,单位为字节。

    version

    Number

    版本。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //保存活动工作簿的改动
      const saveResult = await app.ActiveWorkbook.Save();
      console.log(saveResult);
    }

ActiveWorkbook.SwitchCardView()

通过SwitchCardView()方法,您可以打开或关闭卡片视图面板。

重要

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

  • 语法

    表达式.ActiveWorkbook.SwitchCardView()

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Status

    Boolean

    打开或关闭卡片视图面板。取值范围如下:

    • true:打开。

    • false:关闭,暂不支持。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //打开卡片视图面板
      await app.ActiveWorkbook.SwitchCardView(true);
    }

ActiveWorkbook.QuitCellEdit()

通过QuitCellEdit()方法,您可以退出编辑。

重要

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

  • 语法

    表达式.ActiveWorkbook.QuitCellEdit()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //退出编辑
      await app.ActiveWorkbook.QuitCellEdit();
    }

ActiveWorkbook.CloseDropdownPanels()

通过CloseDropdownPanels()方法,您可以关闭所有打开的下拉面板。

重要

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

  • 语法

    表达式.ActiveWorkbook.CloseDropdownPanels()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //关闭所有打开的下拉面板
      await app.ActiveWorkbook.CloseDropdownPanels();
    }

ActiveWorkbook.CloseHyperLink()

通过CloseHyperLink()方法,您可以关闭超链接。

重要

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

  • 语法

    表达式.ActiveWorkbook.CloseHyperLink()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //关闭超链接
      await app.ActiveWorkbook.CloseHyperLink();
    }

ActiveWorkbook.CloseFilterTips()

通过CloseFilterTips()方法,您可以关闭筛选hover提示。

重要

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

  • 语法

    表达式.ActiveWorkbook.CloseFilterTips()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //关闭筛选hover提示
      await app.ActiveWorkbook.CloseFilterTips();
    }

ActiveWorkbook.SetCalcOptions()

通过SetCalcOptions()方法,您可以配置迭代计算。

重要

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

  • 语法

    表达式.ActiveWorkbook.SetCalcOptions()

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    EnableIterate

    Boolean

    是否启用迭代计算。取值范围如下:

    • true:是。

    • false(默认):否。

    IterateCount

    Number

    最多迭代次数。取值范围为1~32767,默认值为100。

    IterateDelta

    Number

    最大误差。取值范围为大于等于0。默认值为0.001。

    FullPrecision

    Boolean

    计算是否以显示精度为准。取值范围如下:

    • true:是。

    • false(默认):否。

    CalcMode

    Enum

    迭代计算模式。更多信息,请参见XlCalcModeType

    Callback

    Function

    回调函数。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //配置迭代计算
      await app.ActiveWorkbook.SetCalcOptions({
        EnableIterate: false, 
        IterateCount: 300,
        IterateDelta: 0.1, 
        FullPrecision: false, 
        CalcMode: 'automatic',
        Callback:(res)=>console.error('回调函数',res)
      })
    }

ActiveWorkbook.ClearTransactions()

通过ClearTransactions()方法,您可以清除撤销记录。

重要

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

  • 语法

    表达式.ActiveWorkbook.ClearTransactions()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //清除撤销记录
      await app.ActiveWorkbook.ClearTransactions()
    }

ActiveWorkbook.HasTransactions()

通过HasTransactions()方法,您可以判断是否含有撤销记录。

重要

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

  • 语法

    表达式.ActiveWorkbook.HasTransactions()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //判断是否含有撤销记录
      await app.ActiveWorkbook.HasTransactions()
    }

ActiveWorkbook.GetComments()

通过GetComments()方法,您可以获取整个活动工作簿的评论。

重要

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

  • 语法

    表达式.ActiveWorkbook.GetComments()

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

  • 返回值

    属性

    数据类型

    描述

    CellComments

    Array<Object>

    评论信息集合。

    PosInfo

    String

    单元格信息。

    SheetName

    String

    工作表名称。

    UserIds

    Array<String>

    用户ID集合。

  • 评论信息集合

    属性

    数据类型

    描述

    DateTime

    String

    时间戳。

    Text

    String

    评论文本。

    Time

    String

    转换后的时间。

    UserId

    String

    用户ID。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取整个活动工作簿的评论
      const comments = await app.ActiveWorkbook.GetComments();
      console.log(comments);
    }

ActiveWorkbook.SkipAtCell()

通过SkipAtCell()方法,您可以跳转到@所在的单元格。

重要

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

  • 语法

    表达式.ActiveWorkbook.SkipAtCell()

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    AtId

    String

    @的ID。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //跳转到@所在单元格
      await app.ActiveWorkbook.SkipAtCell(AtId)
    }

ActiveWorkbook.SetWatermark()

通过SetWatermark()方法,您可以设置水印。

  • 语法

    表达式.ActiveWorkbook.SetWatermark()

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Type

    Number

    是否有水印。取值范围如下:

    • 1:有。

    • 0:无。

    Value

    String

    水印文字。

    FillStyle

    String

    填充样式。

    Font

    String

    水印字体。

    Rotate

    Number

    旋转度。

    Horizontal

    Number

    水平间距。

    Vertical

    Number

    垂直间距。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //设置水印
      await app.ActiveWorkbook.SetWatermark({
        Type: 1,
        Value: "测试水印",
        FillStyle: 'rgba(192, 192, 192, 0.6)',
        Font: "bold 20px Serif",
        Rotate: -45 * Math.PI / 180,
        Horizontal: 50,
        Vertical: 100,
      });
    }

ActiveWorkbook.GetWatermark()

通过GetWatermark()方法,您可以获取水印。

  • 语法

    表达式.ActiveWorkbook.GetWatermark()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取水印
      await app.ActiveWorkbook.GetWatermark();
    }

ActiveWorkbook.BuiltinDocumentProperties()

通过BuiltinDocumentProperties()方法,您可以获取活动工作簿的内置属性。

  • 语法

    表达式.ActiveWorkbook.BuiltinDocumentProperties({ Name })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Name

    String

    内置属性,包含如下选项:

    • Title:标题。

    • Security:安全值。

    • Size:大小。

    • Author:作者。

    • CorpId:企业编号。

    • Guid:安全文档编号。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取活动工作簿的内置属性
      const title = await app.ActiveWorkbook.BuiltinDocumentProperties('Title').Value;
      console.log('title: ', title);
    }

ActiveWorkbook.CustomDocumentProperties()

通过CustomDocumentProperties()属性,您可以获取活动工作簿的自定义文档属性。

  • 语法

    表达式.ActiveWorkbook.CustomDocumentProperties({ Name })

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取活动工作簿的自定义文档属性
      const txt = await app.ActiveWorkbook.CustomDocumentProperties('AT_txt').Value;
      console.log('txt: ', txt);
    }

属性

ActiveWorkbook.Names

通过Names属性,您可以获取活动工作簿名称的集合。

  • 语法

    表达式.ActiveWorkbook.Names

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取活动工作簿
      const activeWorkbook = await app.ActiveWorkbook;
    
      //获取工作簿名称集合
      const names = await activeWorkbook.Names;
    }

ActiveWorkbook.Sheets

通过Sheets方法,您可以获取活动工作簿中的所有工作表。

  • 语法

    表达式.ActiveWorkbook.Sheets

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取所有工作表
      const sheets = await app.ActiveWorkbook.Sheets;
    }

ActiveWorkbook.ReadOnly

通过ReadOnly属性,您可以查看活动工作簿是否只读。

重要

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

  • 语法

    表达式.ActiveWorkbook.ReadOnly

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //查看活动工作簿是否只读
      const ReadOnly = await app.ActiveWorkbook.ReadOnly;
    }

ActiveWorkbook.ReadOnlyComment

通过ReadOnlyComment属性,您可以查看活动工作簿是否只读可评论。

重要

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

  • 语法

    表达式.ActiveWorkbook.ReadOnlyComment

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //查看活动工作簿是否只读可评论
      const ReadOnlyComment = await app.ActiveWorkbook.ReadOnlyComment;
    }

ActiveWorkbook.SupportReadOnlyComment

通过SupportReadOnlyComment属性,您可以查看活动工作簿是否支持只读可评论。

重要

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

  • 语法

    表达式.ActiveWorkbook.SupportReadOnlyComment

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //查看活动工作簿是否支持只读可评论
      const SupportReadOnlyComment = await app.ActiveWorkbook.SupportReadOnlyComment;
    }