DocumentPropertyCollection

DocumentPropertyCollection class

的基类BuiltInDocumentProperties和CustomDocumentProperties收藏.

要了解更多信息，请访问使用文档属性文档文章。

public abstract class DocumentPropertyCollection : IEnumerable<DocumentProperty>

特性

姓名描述
Count { get; }获取集合中的项目数。
Item { get; }返回一个DocumentProperty按索引的对象.
virtual Item { get; }返回一个DocumentProperty对象的属性名称。

方法

姓名描述
Clear()从集合中删除所有属性。
Contains(string)返回真的如果集合中存在具有指定名称的属性。
GetEnumerator()返回一个枚举器对象，可用于迭代集合中的所有项目。
IndexOf(string)按名称获取属性的索引。
Remove(string)从集合中删除具有指定名称的属性。
RemoveAt(int)删除指定索引处的属性。

评论

属性的名称不区分大小写。

集合中的属性按名称字母顺序排序。

例子

展示如何使用文档的自定义属性。

Document doc = new Document();
CustomDocumentProperties properties = doc.CustomDocumentProperties;

Assert.AreEqual(0, properties.Count);

// 自定义文档属性是我们可以添加到文档中的键值对。
properties.Add("Authorized", true);
properties.Add("Authorized By", "John Doe");
properties.Add("Authorized Date", DateTime.Today);
properties.Add("Authorized Revision", doc.BuiltInDocumentProperties.RevisionNumber);
properties.Add("Authorized Amount", 123.45);

// 该集合按字母顺序对自定义属性进行排序。
Assert.AreEqual(1, properties.IndexOf("Authorized Amount"));
Assert.AreEqual(5, properties.Count);

// 打印文档中的每个自定义属性。
using (IEnumerator<DocumentProperty> enumerator = properties.GetEnumerator())
{
    while (enumerator.MoveNext())
        Console.WriteLine($"Name: \"{enumerator.Current.Name}\"\n\tType: \"{enumerator.Current.Type}\"\n\tValue: \"{enumerator.Current.Value}\"");
}

// 使用 DOCPROPERTY 字段显示自定义属性的值。
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocProperty field = (FieldDocProperty)builder.InsertField(" DOCPROPERTY \"Authorized By\"");
field.Update();

Assert.AreEqual("John Doe", field.Result);

// 我们可以通过“文件”-> 在 Microsoft Word 中找到这些自定义属性“属性”> “高级属性”> “风俗”。
doc.Save(ArtifactsDir + "DocumentProperties.DocumentPropertyCollection.docx");

// 以下是从文档中删除自定义属性的三种方法。
// 1 - 按索引删除：
properties.RemoveAt(1);

Assert.False(properties.Contains("Authorized Amount"));
Assert.AreEqual(4, properties.Count);

// 2 - 按名称删除：
properties.Remove("Authorized Revision");

Assert.False(properties.Contains("Authorized Revision"));
Assert.AreEqual(3, properties.Count);

// 3 - 立即清空整个集合：
properties.Clear();

Assert.AreEqual(0, properties.Count);

也可以看看

DocumentProperty Class DocumentSecurity Enum