活动文档(ActiveDocument) #

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

  const app = instance.Application

  const ReadOnly = await app.ActiveDocument.ReadOnly
}

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

  const app = instance.Application

  const ReadOnlyComment = await app.ActiveDocument.ReadOnlyComment
}

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

  const app = instance.Application

  const SupportReadOnlyComment = await app.ActiveDocument.SupportReadOnlyComment
}

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

  const app = instance.Application

  // 将当前文档的编辑状态切换成修订模式
  app.ActiveDocument.TrackRevisions = true
}

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

  const app = instance.Application

  // 获取页面是否处于修订模式
  const TrackRevisions = await app.ActiveDocument.TrackRevisions
  console.log(TrackRevisions)
}

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

  const app = instance.Application

  // 返回一个 PageSetup 对象
  const PageSetup = await app.ActiveDocument.PageSetup
}

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

  const app = instance.Application

  // 返回一个 Windows 对象
  const Windows = await app.ActiveDocument.ActiveWindows
}

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

  const app = instance.Application

  // 返回一个 Range 对象
  const Range = await app.ActiveDocument.Content

  // 获取 range 内文本内容信息
  const text = await Range.Text
}

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

  const app = instance.Application

  // 返回一个 Range 对象
  const Range = await app.ActiveDocument.Range
}

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

  const app = instance.Application

  // 返回一个 Sections 对象
  const Sections = await app.ActiveDocument.Sections
}

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

  const app = instance.Application

  // 返回一个 ContentControls 对象
  const ContentControls = await app.ActiveDocument.ContentControls
}

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

  const app = instance.Application

  // CustomDocumentProperties 对象
  const CustomDocumentProperties = await app.ActiveDocument
    .CustomDocumentProperties
}

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

  const app = instance.Application

  // 返回一个 Bookmarks 对象
  const Bookmarks = await app.ActiveDocument.Bookmarks
}

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

  const app = instance.Application

  // 返回一个 Comments 对象
  const Comments = await app.ActiveDocument.Comments
}

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

  const app = instance.Application

  // 返回一个 DocumentFields 对象
  const DocumentFields = await app.ActiveDocument.DocumentFields
}

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

  const app = instance.Application

  // 返回一个 Fields 对象
  const Fields = await app.ActiveDocument.Fields
}

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

  const app = instance.Application

  // 返回一个 Hyperlinks 对象
  const Hyperlinks = await app.ActiveDocument.Hyperlinks
}

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

  const app = instance.Application

  // 返回一个 Shapes 对象
  const Shapes = await app.ActiveDocument.Shapes
}

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

  const app = instance.Application

  // 返回一个 InlineShapes 对象
  const InlineShapes = await app.ActiveDocument.InlineShapes
}

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

  const app = instance.Application

  // 返回一个 Revisions 对象
  const Revisions = await app.ActiveDocument.Revisions
}

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

  const app = instance.Application

  // 返回一个 Tables 对象
  const Tables = await app.ActiveDocument.Tables
}

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

  const app = instance.Application

  // 返回一个 Words 对象
  const Words = await app.ActiveDocument.Words
}

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

  const app = instance.Application

  // 获取限制编辑模式
  const mode = await app.ActiveDocument.RestrictEditMode
}

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

  const app = instance.Application

  // 获取第 1 个代表已修订过的文档的单个审阅者
  const ActiveDocument =
    await app.ActiveDocument.ActiveWindow.View.Reviewers.Item(1)

  // 控制接受文档中指定审阅者的所有修订
  ActiveDocument.Visible = true

  // 接受文档中指定审阅者的所有修订
  await app.ActiveDocument.AcceptAllRevisionsShown()
}

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

  const app = instance.Application

  // 删除文档内的所有评论
  await app.ActiveDocument.DeleteAllComments()
}

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

  const app = instance.Application

  // 获取第 1 个代表已修订过的文档的单个审阅者
  const ActiveDocument =
    await app.ActiveDocument.ActiveWindow.View.Reviewers.Item(1)

  // 控制删除文档中指定审阅者的所有评论
  ActiveDocument.Visible = true

  // 删除文档中指定审阅者的所有评论
  await app.ActiveDocument.DeleteAllCommentsShown()
}

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

  const app = instance.Application

  // 导出 PDF，并获取导出后的 url
  const pdfUrl = await app.ActiveDocument.ExportAsFixedFormat() // 默认导出 PDF，所以可以不传参
  console.log(pdfUrl)
}

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

  const app = instance.Application

  // 导出 PDF，并获取导出后的 url
  const pdfUrl = await app.ActiveDocument.ExportAsFixedFormat({
    ExportFormat: app.Enum.WdExportFormat.wdExportFormatIMG
  }) // 或者传参 19
  console.log(pdfUrl)
}

async function example() {
  await instance.ready()

  const app = instance.Application

  // 提供获取文本中 @ 人列表
  const atInfo = await app.ActiveDocument.GetAtList()
  console.log(atInfo)
}

async function example() {
  await instance.ready()

  const app = instance.Application

  // 通过 UUID 获取 @ 的 Range 对象
  const range = await app.ActiveDocument.GetAtPos()
  console.log(range)
}

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

  const app = instance.Application

  // 获取全文评论
  const operatorsInfo = await app.ActiveDocument.GetComments({
    Offset: 0,
    Limit: 20
  })
  console.log(operatorsInfo)
}

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

  const app = instance.Application

  // 获取正文容器的尺寸信息
  const info = await app.ActiveDocument.GetContainerAttributes()
  console.log(info)
}

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

  const app = instance.Application

  // 获取全文范围
  const range = await app.ActiveDocument.GetDocumentRange()
  console.log(range)
}

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

  const app = instance.Application

  const list = await app.ActiveDocument.GetMissingFontList()
  console.log('list: ', list)
}

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

  const app = instance.Application

  // 获取在线协作用户的列表
  const operatorsInfo = await app.ActiveDocument.GetOnlineCooperatorList()
  console.log(operatorsInfo)
}

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

  const app = instance.Application

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

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

  const app = instance.Application

  // 获取当前页面版式
  const mode = await app.ActiveDocument.GetViewMode()
  console.log(mode)
}

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

  const app = instance.Application

  // 安全文档中获取水印
  const watermarkInfo = await app.ActiveDocument.GetWatermark()
  console.log(watermarkInfo)
}

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

  const app = instance.Application

  // 安全文档中设置水印
  await app.ActiveDocument.SetWatermark({
    Type: 1,
    Value: 'WebOffice',
    FillStyle: 'rgba(192, 192, 192, 0.6)',
    Font: 'bold 20px Serif',
    Rotate: (-45 * Math.PI) / 180,
    Horizontal: 50,
    Vertical: 100
  })
}

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

  const app = instance.Application

  // 是否有评论
  const hasComments = await app.ActiveDocument.HasComments()
  console.log(hasComments) // true|false
}

async function example() {
  await instance.ready()

  const app = instance.Application

  // 根据传入数据及配置匹配文档中的内容部件并替换内容
  // 如果找不到该内容，则往文末插入文本
  // 这里假设有一个 Title 为 jssdk 的内容控件
  await app.ActiveDocument.ImportDataIntoFields({
    Data: {
      jssdk: 'jssdk2'
    },
    Options: {
      keyword: 1
    }
  })
}

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

  const app = instance.Application

  // 开启限制编辑
  await app.ActiveDocument.Protect('test')

  // 停止限制编辑
  await app.ActiveDocument.Unprotect('test')
}

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

  const app = instance.Application

  // 获取第 1 个代表已修订过的文档的单个审阅者
  const ActiveDocument =
    await app.ActiveDocument.ActiveWindow.View.Reviewers.Item(1)

  // 控制拒绝文档中指定审阅者的所有修订
  ActiveDocument.Visible = true

  // 拒绝文档中指定审阅者的所有修订
  await app.ActiveDocument.RejectAllRevisionsShown()
}

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

  const app = instance.Application

  const isSuccess = await app.ActiveDocument.ReplaceText([
    {
      key: 'WebOffice',
      value: 'JSSDK'
    }
  ])
  console.log(isSuccess) // true
}

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

  const app = instance.Application

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

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

  const app = instance.Application

  // 滚动正文容器到指定位置
  await app.ActiveDocument.ScrollTo({ ScrollLeft: 0, ScrollTop: 20 })
}

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

  const app = instance.Application

  // 设置为隐藏
  await app.ActiveDocument.SetCommentEnabled({
    Enable: true
  })
}

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

  const app = instance.Application

  // 开启限制编辑，建议调用一次，多次调用易出错，可配合Unprotect()使用
  await app.ActiveDocument.Protect()

  // 文档内容控件开启只读权限,Tag为test的控件设置为编辑权限，需要开启配置 __CONFIG__.wps.enableContentControlACL【设置内容控件只读权限】
  await app.ActiveDocument.SetContentControlAuthority('read', [
    { tag: 'test', access: 'edit' }
  ])
}

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

  const app = instance.Application

  // 设置为只读
  await app.ActiveDocument.SetReadOnly({
    Value: true
  })
}

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

  const app = instance.Application

  // 设置滚动条样式
  await app.ActiveDocument.SetScrollBarStyle({
    BackgroundColor: '#FFFFFF',
    HoverBackgroundColor: '#ffffff',
    ScrollBarWidth: 6,
    BorderRadius: 6
  })
}

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

  const app = instance.Application

  // 分页/连页模式切换
  await app.ActiveDocument.SwitchTypoMode(true)

  // 显示/不显示文件名栏
  await app.ActiveDocument.SwitchFileName(false)
}

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

  const app = instance.Application

  // 分页/连页模式切换
  await app.ActiveDocument.SwitchTypoMode(false)
}

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

  const app = instance.Application

  // 开启限制编辑
  await app.ActiveDocument.Protect('test')

  // 停止限制编辑
  await app.ActiveDocument.Unprotect('test')
}