Document

Document

ActiveDocument

当前文档。

语法：表达式.ActiveDocument，其中表达式为文档类型应用对象。

方法

ActiveDocument.BuiltinDocumentProperties()

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

• 语法：表达式.ActiveDocument.BuiltinDocumentProperties({Name})

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

• 参数

  属性	数据类型	是否必填	描述
  Name	string	是	内置属性，包含如下选项： Title：标题。 Security：安全值。 Size：大小。 Author：作者。 CorpId：企业编号。 Guid：安全文档编号。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取Title属性
    const title = await app.ActiveDocument.BuiltinDocumentProperties('Title');
    console.log(Title);
  }

ActiveDocument.ExportAsFixedFormat()

通过ExportAsFixedFormat()方法，您可以将当前文字文档导出为对应的PDF或者IMG图片，并获取导出文件的URL。

• 语法

  表达式.ActiveDocument.ExportAsFixedFormat({ OutputFileName, ExportFormat })

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

• 参数

  属性	数据类型	是否必填	描述
  OutputFileName	String	否	导出的文件名称。当前版本不支持。
  ExportFormat	Enum	否	导出的文件类型，目前仅支持导出图片和PDF。更多信息，请参见WdExportFormat。
  OpenAfterExport	Boolean	否	导出内容后打开新文件。当前版本不支持。
  OptimizeFor	Enum	否	指定是针对屏幕显示还是打印进行优化。当前版本不支持。更多信息，请参见WdExportOptimizeFor。
  Range	Enum	否	指定导出区域范围。更多信息，请参见WdExportRange。
  From	Number	否	当Range参数设值为wdExportFromTo时，指定起始页码。
  To	Number	否	当Range参数设值为wdExportFromTo时，指定结束页码。
  Item	Enum	否	指定导出文档是否带标记。更多信息，请参见WdExportItem。
  IncludeDocProps	Boolean	否	指定在最新导出的文件中是否包括文档属性。取值范围如下： true（默认）：是。 false：否。
  KeepIRM	Boolean	否	如果在源文档具有IRM保护，指定是否将IRM权限复制到XPS文档。当前版本不支持。取值范围如下： true（默认）：是 false：否。
  CreateBookmarks	Enum	否	指定是否导出书签和要导出的书签的类型。当前版本不支持。更多信息，请参见WdExportCreateBookmarks。
  DocStructureTags	Boolean	否	指定是否包含额外数据来帮助屏幕阅读器，例如有关的流和逻辑组织的内容的信息。取值范围如下： true（默认）：是。 false：否。
  BitmapMissingFonts	Boolean	否	指定是否包含文本的位图。当前版本不支持。取值范围如下： true（默认）：不允许在PDF文件中嵌入某一字体。 false：引用该字体，如果编写的一个不可用，会替换合适的字体。
  UseISO19005_1	Boolean	否	指定是否将PDF的使用限制为ISO 19005-1标准的PDF子集。当前版本不支持。取值范围如下： false（默认）：否。 true：是。由于受到格式的限制，可能会更大或显示更多的视觉瑕疵。
  FixedFormatExtClassPtr	Enum	否	指定一个指针以指向一个允许对代码的备用实现进行调用的加载项。代码的备用实现将对应用程序生成的EMF和EMF+页面描述进行解释，以生成其自身的PDF或XPS。当前版本不支持。
  Dpi	Number	否	导出图片的DPI，默认值为92。
  Combine2LongPic	Boolean	否	是否输出为长图。取值范围如下： false（默认）：否。 true：是。
  ImgFormat	Enum	否	导出图片的格式。更多信息，请参见WdExportImgFormat。
  WaterMark	Boolean	否	是否带水印。取值范围如下： false（默认）：否。 true：是。

• 返回值

  返回导出文件的URL。

• 示例

  • 导出为PDF

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //导出为PDF，并获取导出后的URL
      const pdfUrl = await app.ActiveDocument.ExportAsFixedFormat(); //默认导出PDF
      console.log(pdfUrl);
    }

  • 导出为图片

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //导出为图片，并获取导出后的URL
      const imgUrl = await app.ActiveDocument.ExportAsFixedFormat({ ExportFormat: app.Enum.WdExportFormat.wdExportFormatIMG }); //或者传递参数19
      console.log(imgUrl);
    }

ActiveDocument.GetAtList()

通过GetAtList()方法，您可以获取文本中@人的列表。

• 语法

  表达式.ActiveDocument.GetAtList()

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

• 返回值

  返回对应的@人列表数组，包含uuid字段。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取文本中@人列表
    const atInfo = await app.ActiveDocument.GetAtList();
    console.log(atInfo);
  }

ActiveDocument.GetAtPos()

通过GetAtPos()方法，您可以根据UUID获取@的Range对象。

• 语法

  表达式.ActiveDocument.GetAtPos({ Uuid })

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

• 参数

  传入一个@的UUID

  属性	数据类型	是否必填	描述
  Uuid	string	是	UUID。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //根据UUID获取@的Range对象
    const range = await app.ActiveDocument.GetAtPos();
    console.log(range);
  }

ActiveDocument.GetContainerAttributes()

通过GetContainerAttributes()方法，您可以获取正文容器的尺寸信息。

• 语法

  表达式.ActiveDocument.GetContainerAttributes()

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

• 返回值

  属性	数据类型	描述
  Width	Number	宽度。
  Height	Number	高度。
  OffsetLeft	Number	元素的左外边框至offsetParent元素的左内边框之间的像素距离。
  OffsetTop	Number	元素的上外边框至offsetParent元素的上内边框之间的像素距离。
  ClientWidth	Number	元素的内部宽度。
  ClientHeight	Number	元素的内部高度。
  OffsetWidth	Number	元素的布局宽度。
  OffsetHeight	Number	元素的布局高度。
  ScrollTop	Number	元素的内容顶部到视口可见内容顶部的距离。
  ScrollLeft	Number	元素的内容顶部到视口可见内容左侧的距离。
  ScrollHeight	Number	元素的内容高度。
  ScrollWidth	Number	元素的内容宽度。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取正文容器的尺寸信息
    const info = await app.ActiveDocument.GetContainerAttributes();
    console.log(info);
  }

ActiveDocument.GetDocumentRange()

通过GetDocumentRange()方法，您可以获取全文的范围。

• 语法

  表达式.ActiveDocument.GetDocumentRange()

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

• 返回值

  返回Range表示全文的区域范围。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取全文范围
    const range = await app.ActiveDocument.GetDocumentRange();
    console.log(range);
  }

ActiveDocument.GetOperatorsInfo()

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

• 语法

  表达式.ActiveDocument.GetOperatorsInfo()

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

• 返回值

  属性	数据类型	描述
  type	String	请求类型。
  response	Object	用户信息列表。

  response说明

  属性	数据类型	描述
  id	String	用户ID。
  avatar_url	Object	用户头像。
  logined	Object	用户登录状态。
  name	Object	用户姓名。

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取当前登录操作者信息
    const operatorsInfo = await app.ActiveDocument.GetOperatorsInfo();
    console.log(operatorsInfo);
  }

ActiveDocument.GetOnlineCooperatorList()

通过GetOnlineCooperatorList()方法，您可以获取在线协作用户的列表。

• 语法

  表达式.ActiveDocument.GetOnlineCooperatorList()

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

• 返回值

  Array.<Object>

  属性	数据类型	描述
  Avatar	String	用户头像地址。
  UserName	String	用户名称。

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取在线协作用户的列表
    const operatorsInfo = await app.ActiveDocument.GetOnlineCooperatorList();
    console.log(operatorsInfo);
  }

ActiveDocument.GetViewMode()

通过GetViewMode()方法，您可以获取当前页面版式。

• 语法

  表达式.ActiveDocument.GetViewMode()

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

• 返回值

  返回web为连页模式，返回pages为分页模式。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取当前页面版式
    const mode = await app.ActiveDocument.GetViewMode();
    console.log(mode);
  }

ActiveDocument.GetWatermark()

通过GetWatermark()方法，您可以在安全文档中获取水印。

• 语法

  表达式.ActiveDocument.GetWatermark()

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //在安全文档中获取水印
    const watermarkInfo = await app.ActiveDocument.GetWatermark();
    console.log(watermarkInfo);
  }

ActiveDocument.ImportDataIntoFields()

通过ImportDataIntoFields()方法，您可以通过根据传入数据及配置匹配文档中的内容部件并替换内容。

• 语法

  表达式.ActiveDocument.ImportDataIntoFields({ Data, Options })

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

• 参数

  传入一个@的UUID

  属性	数据类型	是否必填	描述
  Data	Object	是	包含单项、多项或嵌套字段，多项字段复制粘贴后统一进行替换，嵌套字段会对key进行拼接。 重要 目前仅支持Data: { content: value }形式。
  Options	Object	否	导入配置。目前仅支持Options: { keyword: 1}。

• 示例

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

ActiveDocument.ReplaceText()

通过ReplaceText()方法，您可以根据传入数组全文匹配并替换文本。

• 语法

  表达式.ActiveDocument.ReplaceText(Array.<Object>)

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

• 参数

  • 传入一个数组，表示需要替换的文本列表。

    属性	数据类型	是否必填	描述
    list	Array.<Object>	是	要替换的文本列表。

  • list说明

    属性	数据类型	是否必填	描述
    key	String	是	被替换的文本。
    value	String	是	替换的文本。
    options	Object	否	替换配置。

  • options说明

    属性	数据类型	是否必填	描述
    isWildcardMatched	Boolean	否	是否使用通配符。支持星号（*）和问号（?）两种通配符。 星号（*）：代表任意字符串。 问号（?）：代表任意单个字符，且此字符必须存在。 取值范围如下： true：是。 false（默认）：否。
    isCaseSensitive	Boolean	否	是否区分大小写。取值范围如下： true（默认）：是。 false：否。
    isWholeWordMatched	Boolean	否	是否全字匹配。取值范围如下： true（默认）：是。 false：否。
    isWidthIgnored	Boolean	否	是否忽略全角/半角。取值范围如下： true（默认）：是。 false：否。

• 返回值

  返回true表示替换成功，返回false表示替换失败。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //替换文本
    const isSuccess = await app.ActiveDocument.ReplaceText([
      {
        key: 'Aliyun',
        value: 'js-sdk',
      },
    ]);
    console.log(isSuccess); // true
  }

ActiveDocument.Save()

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

• 语法

  表达式.ActiveDocument.Save()

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

• 返回值

  属性	数据类型	描述
  result	String	保存状态。
  size	Number	文件大小，单位为字节。
  version	Number	版本。

  保存状态说明

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

• 示例

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

ActiveDocument.SetReadOnly()

通过SetReadOnly()方法，您可以将打开的文档临时设置为只读。

• 语法

  表达式.ActiveDocument.SetReadOnly({ Value })

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

• 参数

  属性	数据类型	是否必填	描述
  Value	Boolean	是	是否设置为只读。取值范围如下： true：是。 false：否。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //设置为只读
    await app.ActiveDocument.SetReadOnly({
      Value: true,
    });
  }

ActiveDocument.ScrollTo()

通过ScrollTo()方法，您可以滚动正文容器到指定位置。

• 语法

  表达式.ActiveDocument.ScrollTo({ ScrollLeft, ScrollTop })

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

• 参数

  属性	数据类型	是否必填	描述
  ScrollLeft	Number	是	横向滚动距离。
  ScrollTop	Number	是	纵向滚动距离。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //滚动正文容器到指定位置
    await app.ActiveDocument.ScrollTo({ ScrollLeft: 0, ScrollTop: 20 });
  }

ActiveDocument.SetCommentEnabled()

通过SetCommentEnabled()方法，您可以设置是否隐藏评论相关功能（当前仅移动端有效）。

• 语法

  表达式.ActiveDocument.SetCommentEnabled({ Enable })

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

• 参数

  属性	数据类型	是否必填	描述
  Enable	Boolean	是	是否隐藏。取值范围如下： true：是。 false：否。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //设置为隐藏
    await app.ActiveDocument.SetCommentEnabled({
      Enable: true,
    });
  }

ActiveDocument.SetWatermark()

通过SetWatermark()方法，您可以在文档中设置水印。

• 语法

  表达式.ActiveDocument.SetWatermark({ Type, Value, FillStyle, Font, Rotate, Horizontal, Vertical })

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

• 参数

  属性	数据类型	是否必填	描述
  Type	Number	是	是否有水印。取值范围如下： 1：有水印。 0：无水印。
  Value	String	是	水印文字。
  FillStyle	Object	否	水印填充样式。
  Font	Object	否	水印字体。
  Rotate	Number	否	水印旋转角度。
  Horizontal	Number	否	水平间距。
  Vertical	Number	否	垂直间距。

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //在安全文档中设置水印
    await app.ActiveDocument.SetWatermark({
      Type: 1,
      Value: 'WebOffice',
      FileStyle: 'rgba(192, 192, 192, 0.6)',
      Font: 'bold 20px Serif',
      Rotate: -45 * Math.PI / 180,
      Horizontal: 50,
      Vertical: 100,
    });
  }

ActiveDocument.SwitchFileName()

通过SwitchFileName()方法，您可以设置是否显示文件名栏。

• 语法

  表达式. ActiveDocument.SwitchFileName(Boolean)

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

• 参数

  Boolean为true表示显示文件名栏，false表示隐藏文件名栏。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //切换为连页模式
    await app.ActiveDocument.SwitchTypoMode(true);
  
    //隐藏文件名栏
    await app.ActiveDocument.SwitchFileName(false);
  }

ActiveDocument.SwitchTypoMode()

通过SwitchTypoMode()方法，您可以切换分页或连页模式。

• 语法

  表达式.ActiveDocument.SwitchTypoMode(Boolean)

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

• 参数

  Boolean为true表示切换到连页模式，false表示切换到分页模式。

• 返回值

  Boolean为true表示切换成功，false表示切换失败。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //切换为分页模式
    await app.ActiveDocument.SwitchTypoMode(false);
  }

ActiveDocument.GetMissingFontList()

通过GetMissingFontList()方法，您可以获取所有缺失的字体列表。

• 语法

  表达式.ActiveDocument.GetMissingFontList()

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

• 返回值

  缺失的字体列表。

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    const list = await app.ActiveDocument.GetMissingFontList();
    console.log('list: ', list);
  }

ActiveDocument.Protect({ Password })

通过Protect()方法，您可以开启限制编辑。

• 语法

  表达式.ActiveDocument.Protect({ Password })

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

• 参数

  属性	数据类型	是否必填	描述
  Password	String	否	设置的密码。

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //开启限制编辑
    await app.ActiveDocument.Protect('test');
  
    //停止限制编辑
    await app.ActiveDocument.Unprotect('test');
  }

ActiveDocument.Unprotect({ Password })

通过UnProtect()方法，您可以停止限制编辑。

• 语法

  表达式.ActiveDocument.Unprotect({ Password })

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

• 参数

  属性	数据类型	是否必填	描述
  Password	String	否	设置的密码。

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //开启限制编辑
    await app.ActiveDocument.Protect('test');
  
    //停止限制编辑
    await app.ActiveDocument.Unprotect('test');
  }

ActiveDocument.SetContentControlAuthority({ DefaultPermission, Permissions })

通过方法SetContentControlAuthority()方法，您可以设置内容控件只读权限。

• 语法

  表达式.ActiveDocument.SetContentControlAuthority({ DefaultPermission, Permissions })

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

• 参数

  属性	数据类型	是否必填	描述
  DefaultPermission	String	否	默认文档内容控件权限，取值范围如下： read：只读权限。 edit：编辑权限。
  Permissions	Array.<Object>	否	单个内容控件权限列表。

  Permissions说明

  属性	数据类型	是否必填	描述
  tag	String	是	内容控件Tag。
  access	String	是	内容控件权限，取值范围如下： read：只读权限。 edit：编辑权限。

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //开启限制编辑
    await app.ActiveDocument.Protect();
  
    //文档内容控件开启只读权限，Tag为test的控件设置为编辑权限
    await app.ActiveDocument.SetContentControlAuthority('read', [{ tag: 'test', access: 'edit' }]);
  }

ActiveDocument.SetScrollBarStyle({ BackgroundColor, HoverBackgroundColor, ScrollBarWidth, BorderRadius })

通过方法SetScrollBarStyle()方法，您可以设置正文滚动条样式。

• 语法

  表达式.ActiveDocument.SetScrollBarStyle({ BackgroundColor, HoverBackgroundColor, ScrollBarWidth, BorderRadius })

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

• 参数

  传入一个对象，表示需要设置的滚动条样式。

  属性	数据类型	是否必填	描述
  BackgroundColor	String	否	滚动条背景色。
  HoverBackgroundColor	String	否	滚动条hover背景色。
  ScrollBarWidth	Number	否	滚动条宽度，有效范围为0~100。
  BorderRadius	Number	否	滚动条圆角值，负值无效。

• 示例

  //@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 });
  }

ActiveDocument.CustomDocumentProperties.Add()

通过Add()方法，您可以创建新的自定义文档属性。

• 语法

  表达式.ActiveDocument.CustomDocumentProperties.Add({ Name, Value })

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

• 参数

  属性	数据类型	是否必填	描述
  Name	String	是	文档名称。
  Value	Object	否	文档值。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取自定义文档属性
    const DocumentProperties = await app.ActiveDocument.DocumentProperties;
  
    //创建新的自定义文档属性
    await DocumentProperties.Add({
      Name: 'Aliyun',
      Value: 'test_id',
    })
  }

ActiveDocument.CustomDocumentProperties.CalcDocumentId()

通过CalcDocumen()方法，您可以自定义公文标识计算。

• 语法

  表达式.ActiveDocument.CustomDocumentProperties.CalcDocumentId({ FileOId, OrganizationCode, SubDepartment, DocYear, DocumentType, SerialNumber })

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

• 参数

  属性	数据类型	是否必填	描述
  FileOId	String	否	文件的OID。
  OrganizationCode	String	是	机构代码，长度不超过18个字符。
  SubDepartment	String	是	内属单位，长度不超过3个字符。
  DocYear	Number	是	文档发文年份。
  DocumentType	String	是	代字编码。取值范围为01~0F，默认值为01。
  SerialNumber	String	是	流水号，长度不超过5个字符。

• 返回值

  返回计算后的公文标识。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取自定义文档属性
    const DocumentProperties = await app.ActiveDocument.DocumentProperties;
  
    //自定义公文标识计算
    await DocumentProperties.CalcDocumentId({
      FileOId: '1.0.0',
      OrganizationCode: 'Aliyun_Test_Code',
      SubDepartment: '001',
      DocYear: new Date().getFullYear(),
      DocumentType: '01',
      SerialNumber: '00001'
    });
  }

ActiveDocument.Find.Execute()

通过Find.Execute()方法，您可以搜索并高亮文本。

• 语法

  表达式.ActiveDocument.Find.Execute()

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

• 参数

  属性	数据类型	是否必填	描述
  Text	String	否	查找文本。
  ShowHighlight	Boolean	否	是否高亮显示搜索结果。取值范围如下： true（默认）：是。 false：否。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //搜索并高亮文本
    app.ActiveDocument.Find.Execute('test', true);
  }

ActiveDocument.Find.ClearHitHighlight()

通过Find.ClearHitHighlight()方法，您可以取消搜索结果高亮。

• 语法

  表达式.ActiveDocument.Find.ClearHitHighlight()

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //取消搜索结果高亮
    app.ActiveDocument.Find.ClearHitHighlight();
  }

属性

ActiveDocument.Content

通过Content属性，您可获取一个Range对象，该对象代表主文档文章。

• 语法

  表达式.ActiveDocument.Content

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个Range对象
    const Range = await app.ActiveDocument.Content;
  
    //获取Range内文本内容信息
    const text = await Range.Text;
  }

ActiveDocument.CustomDocumentProperties

通过CustomDocumentProperties属性，您可以获取指定文档的所有自定义文档属性。

• 语法

  表达式.ActiveDocument.CustomDocumentProperties

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取自定义文档属性
    const CustomDocumentProperties = await app.ActiveDocument.CustomDocumentProperties;
  }

ActiveDocument.DocumentFields

返回一个DocumentFields集合，该集合代表文档中的所有公文域。此为只读属性。

• 语法

  表达式.ActiveDocument.DocumentFields

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个DocumentFields对象
    const DocumentFields = await app.ActiveDocument.DocumentFields;
  }

ActiveDocument.Fields

返回一个Fields集合，该集合代表文档中的所有域。此为只读属性。

• 语法

  表达式.ActiveDocument.Fields

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个Fields对象
    const Fields = await app.ActiveDocument.Fields;
  }

ActiveDocument.Hyperlinks

返回一个Hyperlinks集合，该集合代表指定文档中的所有超链接。此为只读属性。

• 语法

  表达式.ActiveDocument.Hyperlinks

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个Hyperlinks对象
    const Hyperlinks = await app.ActiveDocument.Hyperlinks;
  }

ActiveDocument.InlineShapes

返回一个InlineShapes集合，该集合代表文档中的所有InlineShape对象。此为只读属性。

• 语法

  表达式.ActiveDocument.InlineShapes

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个InlineShapes对象
    const InlineShapes = await app.ActiveDocument.InlineShapes;
  }

ActiveDocument.PageSetup

返回一个PageSetup对象，该对象与指定文档相关联。

• 语法

  表达式.ActiveDocument.PageSetup

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个PageSetup对象
    const PageSetup = await app.ActiveDocument.PageSetup;
  }

ActiveDocument.ReadOnly

通过ReadOnly属性，您可以设置文档为只读属性。

• 语法

  表达式.ActiveDocument.ReadOnly

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //设置文档为只读属性
    const ReadOnly = await app.ActiveDocument.ReadOnly;
  }

ActiveDocument.ReadOnlyComment

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

• 语法

  表达式.ActiveDocument.ReadOnlyComment

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const ReadOnlyComment = await app.ActiveDocument.ReadOnlyComment;
  }

ActiveDocument.SupportReadOnlyComment

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

• 语法

  表达式.ActiveDocument.SupportReadOnlyComment

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const SupportReadOnlyComment = await app.ActiveDocument.SupportReadOnlyComment;
  }

ActiveDocument.Revisions

返回一个Revisions集合，该集合代表区域或文档中标有修订标记的更改。此为只读属性。

• 语法

  表达式.ActiveDocument.Revisions

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个Revisions对象
    const Revisions = await app.ActiveDocument.Revisions;
  }

ActiveDocument.Sections

返回一个Section集合，该集合代表指定文档中的各个节。此为只读属性。

• 语法

  表达式.ActiveDocument.Sections

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个Sections对象
    const Sections = await app.ActiveDocument.Sections;
  }

ActiveDocument.Shapes

返回一个Shapes集合，该集合代表文档中的所有Shape对象。此为只读属性。

• 语法

  表达式.ActiveDocument.Shapes

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个Shapes对象
    const Shapes = await app.ActiveDocument.Shapes;
  }

ActiveDocument.Tables

返回一个Table集合，该集合代表指定文档中的所有表格。此为只读属性。

• 语法

  表达式.ActiveDocument.Tables

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个Tables对象
    const Tables = await app.ActiveDocument.Tables;
  }

ActiveDocument.TrackRevisions

通过TrackRevisions属性，您可以切换当前文档状态为编辑模式或修订模式。

• 语法

  表达式.ActiveDocument.TrackRevisions = Boolean

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

• 参数

  Boolean值为true表示切换为修订模式，false表示切换为编辑模式。

• 示例

  • 切换修订模式和编辑模式

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //将当前文档的编辑状态切换为修订模式
    app.ActiveDocument.TrackRevisions = true;
  }

  • 查看当前页面是否处于修订模式

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //查看当前页面是否处于修订模式
    const TrackRevisions = await app.ActiveDocument.TrackRevisions;
    console.log(TrackRevisions);
  }

ActiveDocument.ActiveWindows

返回一个Windows集合，该集合代表指定文档的所有窗口。此为只读属性。

• 语法

  表达式.ActiveDocument.ActiveWindows

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //返回一个Windows对象
    const Windows = await app.ActiveDocument.ActiveWindows;
  }

ActiveDocument.Words

通过Words属性，您可以获取一个Words集合，该集合代表文档中的所有单词。

• 语法

  • 表达式.ActiveDocument.Words

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取文档中的所有单词
    const Words = await app.ActiveDocument.Words;
  }

ActiveDocument.Words.Count

通过Count属性，您可以获取文档中所有单词的个数。

• 语法

  表达式.ActiveDocument.Words.Count

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

• 返回值

  属性	数据类型	描述
  wordCount	Number	总个数。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取文档中的所有单词个数
    const count = await app.ActiveDocument.Words.Count;
    console.log(count);
  }

ActiveDocument.Find

通过Find属性，您可以查找对象。Find对象的属性和方法对应于查找和替换对话框中的选项。

• 语法

  表达式.ActiveDocument.Find

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //查找对象
    const Find = await app.ActiveDocument.Find;
  }