WPS 加载项开发 > 表格 API 参考 > Workbook > 属性 > Workbook.CustomDocumentProperties 属性
返回或设置一个 DocumentProperties 集合,该集合表示指定工作簿的所有自定义文档属性。

语法

表达式.CustomDocumentProperties

表达式   一个代表 Workbook 对象的变量。

说明

本属性返回的是自定义文档属性的整个集合。通过指定属性的名称或集合索引号(数字),用 Item 方法可返回集合中的单个成员(一个 DocumentProperty 对象)。

由于 Item 方法是 DocumentProperties 集合的默认方法,所以下列语句是相同的:

CustomDocumentProperties.Item("Complete")

CustomDocumentProperties("Complete")

使用 BuiltinDocumentProperties 属性可返回内置文档属性的集合。

msoPropertyTypeString 类型的属性长度不能超过 255 个字符。

示例

本示例在第一个工作表中列表显示自定义文档属性的名称和值。

示例代码
let rw = 1
Worksheets.Item(1).Activate()
for(let p = 1; p <=  ActiveWorkbook.CustomDocumentProperties.Count; p++) {
    Cells.Item(rw, 1).Value2 = ActiveWorkbook.CustomDocumentProperties.Item(p).Name
    Cells.Item(rw, 2).Value2 = ActiveWorkbook.CustomDocumentProperties.Item(p).Value
    rw = rw + 1
}

Find out which custom document properties have been defined?


请参阅