Skip to content

工作簿

Workbook

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

返回一个表示活动窗口中的工作簿的工作簿对象

语法

表达式.ActiveWorkbook

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 活动工作簿
  const activeWorkbook = await app.ActiveWorkbook
}

ActiveSheet

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

活动工作簿中的活动工作表,使用方法可参考 ActiveSheet

语法

表达式.ActiveWorkbook.ActiveSheet

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 活动工作簿
  const activeWorkbook = await app.ActiveWorkbook

  // 活动工作表
  const activeSheet = await activeWorkbook.ActiveSheet
}

Names

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

工作簿名称的集合,使用方法可参考 名称管理器

语法

表达式.ActiveWorkbook.Names

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 活动工作簿
  const activeWorkbook = await app.ActiveWorkbook

  // 工作簿名称集合
  const names = await activeWorkbook.Names
}

ReadOnly

JSSDK: v1.1.14+、WebOffice v3.3.1+ 支持

返回一个值,表示文档是否只读,此属性为只读属性。

语法

表达式.ActiveWorkbook.ReadOnly

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  const ReadOnly = await app.ActiveWorkbook.ReadOnly
}

ReadOnlyComment

JSSDK: v1.1.15+、WebOffice v4.2.1+ 支持

返回一个值,表示文档是否只读可评论的权限,此属性为只读属性。

语法

表达式.ActiveWorkbook.ReadOnlyComment

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

示例

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  const ReadOnlyComment = await app.ActiveWorkbook.ReadOnlyComment
}

Sheets

工作表对象

语法

表达式.ActiveWorkbook.Sheets

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 工作表对象
  const sheets = await app.ActiveWorkbook.Sheets
}

SupportReadOnlyComment

JSSDK: v1.1.15+、WebOffice v4.2.1+ 支持

返回一个值,表示文档是否支持只读可评论权限,此属性为只读属性。

语法

表达式.ActiveWorkbook.SupportReadOnlyComment

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

示例

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  const SupportReadOnlyComment = await app.ActiveWorkbook.SupportReadOnlyComment
}

BuiltinDocumentProperties()

获取安全文档信息

语法

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

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

参数

属性数据类型默认值必填说明
Name
string
标题 Title、安全值 Security、大小 Size、作者 Author、企业编号 CorpId、安全文档编号 Guid

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  const title = await app.ActiveWorkbook.BuiltinDocumentProperties('Title')
    .Value
  console.log('title: ', title)
}

ClearTransactions()

JSSDK: v1.1.12+、WebOffice v2.5.1+ 支持

清除撤销记录

语法

表达式.ActiveWorkbook.ClearTransactions()

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 清除撤销记录
  await app.ActiveWorkbook.ClearTransactions()
}

CloseDropdownPanels()

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

通知所有打开的下拉面板关闭

语法

表达式.ActiveWorkbook.CloseDropdownPanels()

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 通知所有打开的下拉面板关闭
  await app.ActiveWorkbook.CloseDropdownPanels()
}

CloseFilterTips()

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

关闭筛选 hover 提示

语法

表达式.ActiveWorkbook.CloseFilterTips()

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 关闭筛选hover提示
  await app.ActiveWorkbook.CloseFilterTips()
}

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

通知超链接关闭

语法

表达式.ActiveWorkbook.CloseHyperLink()

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 通知超链接关闭
  await app.ActiveWorkbook.CloseHyperLink()
}

CopySheetFromBook()

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

将另一个文件中的工作表复制到当前文件

语法

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

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

参数

属性数据类型默认值必填说明
FromBookFileId
String
目标文件的 id
FromBookFileName
String
目标文件的名称
FromeSheetName
String
目标文件的工作表名称
DestSheetName
String
需要拷贝到当前文件的工作表名称

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 活动工作簿
  const activeWorkbook = await app.ActiveWorkbook

  // 复制 ID 为 100161090439 命名为 “工作簿” 的工作表中的 Sheet1,到当前工作簿的 Sheet6 工作表上
  const result = await activeWorkbook.CopySheetFromBook(
    '100161090439',
    '工作簿',
    'Sheet1',
    'Sheet6'
  )
  console.log(result)
}

CustomDocumentProperties()

获取安全文档信息

语法

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

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

参数

属性数据类型默认值必填说明
Name
string
AT_txt、AT_date、AT_boolean、AT_number

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  const txt = await app.ActiveWorkbook.CustomDocumentProperties('AT_txt').Value
  console.log('txt: ', txt)
}

ExportAsFixedFormat()

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

导出整个表格为对应的 PDF 或者 Img 图片,并获取导出后的 url

语法

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

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

参数

属性数据类型默认值必填说明
Type
Enum
可选
导出的类型,详细可参考 Enum.XlFixedFormatType,目前仅支持导出图片和导出 PDF

返回值

属性数据类型说明
url
string
导出后的 url

示例 1:导出 PDF

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 导出整个表格
  const workbookPdfUrl = await app.ActiveWorkbook.ExportAsFixedFormat()
  console.log(workbookPdfUrl)
}

示例 2:导出图片

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 导出整个表格
  const workbookPdfUrl = await app.ActiveWorkbook.ExportAsFixedFormat({
    Type: app.Enum.XlFixedFormatType.xlTypeIMG
  })
  console.log(workbookPdfUrl)
}

GetComments()

JSSDK: v1.1.14+、WebOffice v3.4.1+ 支持

获取整个 Workbook 的评论

语法

表达式.ActiveWorkbook.GetComments()

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

返回值

属性数据类型说明
CellComments
Array<Object>
评论信息集合
PosInfo
String
单元格信息
SheetName
String
Sheet 名称
UserIds
Array<String>
用户 id 集合

评论信息集合

属性数据类型说明
DateTime
String
时间戳
Text
String
评论文本
Time
String
转换后的时间
UserId
String
用户 id

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取整个 Workbook 的评论
  const comments = await app.ActiveWorkbook.GetComments()
  console.log(comments)
}

GetOperatorsInfo()

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

获取当前登录操作者信息

语法

表达式.ActiveWorkbook.GetOperatorsInfo()

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

返回值

Object object

属性数据类型说明
type
String
请求类型
response
Object
用户信息列表

response 结构

属性数据类型说明
id
String
用户 id
avatar_url
Object
用户头像
logined
Object
用户登录状态
name
Object
用户姓名

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取当前登录操作者信息
  const operatorsInfo = await app.ActiveWorkbook.GetOperatorsInfo()
  console.log(operatorsInfo)
}

GetWatermark()

获取水印

语法

表达式.ActiveWorkbook.GetWatermark()

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  await app.ActiveWorkbook.GetWatermark()
}

HasTransactions()

JSSDK: v1.1.12+、WebOffice v2.5.1+ 支持

判断是否含有撤销记录

语法

表达式.ActiveWorkbook.HasTransactions()

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 判断是否含有撤销记录
  await app.ActiveWorkbook.HasTransactions()
}

QuitCellEdit()

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

退出编辑

语法

表达式.ActiveWorkbook.QuitCellEdit()

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 退出编辑
  await app.ActiveWorkbook.QuitCellEdit()
}

Save()

JSSDK: v1.1.9+、WebOffice v2.3.1+ 支持

保存文件的改动

语法

表达式.ActiveWorkbook.Save()

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

返回值

属性数据类型说明
result
String
保存状态
size
Number
文件大小,单位 byte
version
Number
版本

保存状态说明

保存状态说明
ok
版本保存成功,可在历史版本中查看
nochange
文档无更新,无需保存版本
SavedEmptyFile
暂不支持保存空文件 触发场景:内核保存完后文件为空
SpaceFull
空间已满
QueneFull
保存中请勿频繁操作 触发场景:服务端处理保存队列已满,正在排队
fail
保存失败

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 保存文件的改动
  const saveResult = await app.ActiveWorkbook.Save()
  console.log(saveResult)
}

SetCalcOptions()

JSSDK: v1.1.12+、WebOffice v2.5.1+ 支持

配置迭代计算

语法

表达式.ActiveWorkbook.SetCalcOptions()

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

参数

属性数据类型默认值必填说明
EnableIterate
bool
迭代计算
IterateCount
number
最多迭代次数
IterateDelta
number
最大误差
FullPrecision
bool
计算已显示精度为准
CalcMode
Enum
重新计算模式 更多可看 Enum.XlCalcModeType
Callback
func
回调函数

示例

//@file=base.xlsx
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)
  })
}

SetFilterShared()

开关多人同步筛选

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

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

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

参数

属性数据类型默认值必填说明
Checked
Boolean
开启 true,关闭 false

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 活动工作簿
  const activeWorkbook = await app.ActiveWorkbook

  // 开启多人同步筛选
  const result = await activeWorkbook.SetFilterShared()
}

SetWatermark()

设置水印

语法

表达式.ActiveWorkbook.SetWatermark()

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

参数

属性数据类型默认值必填说明
Type
number
有无水印, 1 有, 0 无
Value
string
水印文字
FillStyle
string
填充样式
Font
string
水印字体
Rotate
number
旋转度
Horizontal
number
水平间距
Vertical
number
垂直间距

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  await app.ActiveWorkbook.SetWatermark({
    Type: 1,
    Value: 'WPS WebOffice \n 测试水印测试水印测试水印',
    FillStyle: 'rgba(192, 192, 192, 0.6)',
    Font: 'bold 20px Serif',
    Rotate: (-45 * Math.PI) / 180,
    Horizontal: 50,
    Vertical: 100
  })
}

SkipAtCell()

JSSDK: v1.1.12+、WebOffice v3.1.1+ 支持

跳转到@所在单元格

语法

表达式.ActiveWorkbook.SkipAtCell()

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

参数

属性数据类型默认值必填说明
AtId
string
-
@id

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 跳转到@所在单元格
  await app.ActiveWorkbook.SkipAtCell(AtId)
}

SwitchCardView()

JSSDK: v1.1.10+、WebOffice v2.3.1+ 支持

切换卡片视图面板

语法

表达式.ActiveWorkbook.SwitchCardView()

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

参数

传入一个布尔值,表明打开或者关闭卡片视图面板。

属性数据类型默认值必填说明
Status
Boolean
-
目前仅支持打开面板

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 切换卡片视图面板-打开
  await app.ActiveWorkbook.SwitchCardView(true)
}