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 через «Файл» -> gt; «Свойства» > «Дополнительные свойства» > "Обычай".
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