Класс Aspose::Words::Properties::CustomDocumentProperties

CustomDocumentProperties class

Коллекция пользовательских свойств документа. Чтобы узнать больше, посетите статью документации Work with Document Properties.

class CustomDocumentProperties : public Aspose::Words::Properties::DocumentPropertyCollection

Методы

МетодОписание
Add(const System::String&, const System::String&)Создаёт новое пользовательское свойство документа типа данных String.
Add(const System::String&, int32_t)Создаёт новое пользовательское свойство документа типа данных Number.
Add(const System::String&, System::DateTime)Создаёт новое пользовательское свойство документа типа данных DateTime.
Add(const System::String&, bool)Создаёт новое пользовательское свойство документа типа данных Boolean.
Add(const System::String&, double)Создаёт новое пользовательское свойство документа типа данных Double.
AddLinkToContent(const System::String&, const System::String&)Создает новое пользовательское свойство документа, связанное с содержимым.
Clear()Удаляет все свойства из коллекции.
Contains(const System::String&)Возвращает true, если в коллекции существует свойство с указанным именем.
get_Count()Получает количество элементов в коллекции.
GetEnumerator() overrideВозвращает объект‑перечислитель, который можно использовать для перебора всех элементов в коллекции.
GetType() const override
virtual idx_get(System::String)Возвращает объект DocumentProperty по имени свойства.
idx_get(int32_t)Возвращает объект DocumentProperty по индексу.
IndexOf(const System::String&)Получает индекс свойства по имени.
Is(const System::TypeInfo&) const override
Remove(const System::String&)Удаляет из коллекции свойство с указанным именем.
RemoveAt(int32_t)Удаляет свойство по указанному индексу.
static Type()

Примечания

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

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

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

Примеры

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

auto doc = System::MakeObject<Aspose::Words::Document>(get_MyDir() + u"Properties.docx");

// Каждый документ содержит коллекцию пользовательских свойств, которые, как и встроенные свойства, представляют собой пары ключ‑значение.
// Документ имеет фиксированный список встроенных свойств. Пользователь создает все пользовательские свойства.
ASSERT_EQ(u"Value of custom document property", System::ObjectExt::ToString(doc->get_CustomDocumentProperties()->idx_get(u"CustomProperty")));

doc->get_CustomDocumentProperties()->Add(u"CustomProperty2", System::String(u"Value of custom document property #2"));

std::cout << "Custom Properties:" << std::endl;
for (auto&& customDocumentProperty : System::IterateOver(doc->get_CustomDocumentProperties()))
{
    std::cout << customDocumentProperty->get_Name() << std::endl;
    std::cout << System::String::Format(u"\tType:\t{0}", customDocumentProperty->get_Type()) << std::endl;
    std::cout << System::String::Format(u"\tValue:\t\"{0}\"", customDocumentProperty->get_Value()) << std::endl;
}

См. также