CustomDocumentProperties

CustomDocumentProperties class

Коллекция пользовательских свойств документа.

Чтобы узнать больше, посетитеРабота со свойствами документа статья документации.

public class CustomDocumentProperties : DocumentPropertyCollection

Характеристики

ИмяОписание
Count { get; }Получает количество элементов в коллекции.
Item { get; }ВозвращаетDocumentProperty объект по индексу.
virtual Item { get; }ВозвращаетDocumentProperty объект по имени свойства.

Методы

ИмяОписание
Add(string, bool)Создает новое пользовательское свойство документаBoolean тип данных.
Add(string, DateTime)Создает новое пользовательское свойство документаDateTime тип данных.
Add(string, double)Создает новое пользовательское свойство документаDouble тип данных.
Add(string, int)Создает новое пользовательское свойство документаNumber тип данных.
Add(string, string)Создает новое пользовательское свойство документаString тип данных.
AddLinkToContent(string, string)Создает новое свойство пользовательского документа, связанное с содержимым.
Clear()Удаляет все свойства из коллекции.
Contains(string)Возвращаетистинный если свойство с указанным именем существует в коллекции.
GetEnumerator()Возвращает объект перечислителя, который можно использовать для перебора всех элементов коллекции.
IndexOf(string)Получает индекс свойства по имени.
Remove(string)Удаляет свойство с указанным именем из коллекции.
RemoveAt(int)Удаляет свойство по указанному индексу.

Примечания

КаждыйDocumentProperty объект представляет собой пользовательское свойство документа-контейнера.

Имена свойств не чувствительны к регистру.

Свойства в коллекции отсортированы в алфавитном порядке по имени.

Примеры

Показывает, как работать с настраиваемыми свойствами документа.

Document doc = new Document(MyDir + "Properties.docx");

// Каждый документ содержит коллекцию пользовательских свойств, которые, как и встроенные свойства, представляют собой пары ключ-значение.
 // Документ имеет фиксированный список встроенных свойств. Пользователь создает все настраиваемые свойства.
Assert.AreEqual("Value of custom document property", doc.CustomDocumentProperties["CustomProperty"].ToString());

doc.CustomDocumentProperties.Add("CustomProperty2", "Value of custom document property #2");

Console.WriteLine("Custom Properties:");
foreach (var customDocumentProperty in doc.CustomDocumentProperties)
{
    Console.WriteLine(customDocumentProperty.Name);
    Console.WriteLine($"\tType:\t{customDocumentProperty.Type}");
    Console.WriteLine($"\tValue:\t\"{customDocumentProperty.Value}\"");
}

Смотрите также

BuiltInDocumentProperties Class DocumentProperty Class