文档属性(DocumentProperties)

DocumentProperty 对象的集合，每个 DocumentProperty 对象均代表容器文档的一个内置属性或自定义属性

方法列表

方法	说明
Add()	创建新的自定义文档属性
CalcDocumentId()	自定义公文标识计算

Add()

创建新的自定义文档属性

该操作用户无感知，在 WPS 客户端的「文件」-「文档加密」-「属性」-「自定义」可以查看

语法

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

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

参数

属性	数据类型	默认值	必填	说明
Name	String		是	文档名称
Value	Object		否	文档值。可以是 String/Boolean/Number 类型

示例

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

  const app = instance.Application

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

  // 创建新的自定义文档属性
  await DocumentProperties.Add({
    Name: 'WebOffice',
    Value: 'test_id'
  })
}

CalcDocumentId()

自定义公文标识计算

该操作用户无感知，在 WPS 客户端的「文件」-「文档加密」-「属性」-「自定义」可以查看，一般在「公文标识」上计算。该 API 会返回如下图一样计算出来的公文标识

语法

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

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

参数

属性	数据类型	默认值	必填	说明
FileOId	String	1.2.156.10	否	文件 OID
OrganizationCode	String		是	机构代码，限长 18 个字符
SubDepartment	String		是	内属单位，限长 3 个字符
DocYear	Number	new Date().getFullYear()	是	文档发文年份，0000~9999 名称
DocumentType	String	01	是	代字编码，01~0F
SerialNumber	String		是	流水号，限长 5 个字符

返回值

返回计算后的公文标识

示例

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

  const app = instance.Application

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

  // 自定义公文标识计算
  await DocumentProperties.CalcDocumentId({
    FileOId: '1.0.0',
    OrganizationCode: 'WebOffice_Test_Code',
    SubDepartment: '001',
    DocYear: new Date().getFullYear(),
    DocumentType: '01',
    SerialNumber: '00001'
  })
}