Aspose::Words::Properties::DocumentPropertyCollection::idx_get method

DocumentPropertyCollection::idx_get(int32_t) method

Returns a DocumentProperty object by index.

System::SharedPtr<Aspose::Words::Properties::DocumentProperty> Aspose::Words::Properties::DocumentPropertyCollection::idx_get(int32_t index)
ParameterTypeDescription
indexint32_tZero-based index of the DocumentProperty to retrieve.

Examples

Shows how to work with custom document properties.

auto doc = MakeObject<Document>(MyDir + u"Properties.docx");

// Every document contains a collection of custom properties, which, like the built-in properties, are key-value pairs.
// The document has a fixed list of built-in properties. The user creates all of the custom properties.
ASSERT_EQ(u"Value of custom document property", System::ObjectExt::ToString(doc->get_CustomDocumentProperties()->idx_get(u"CustomProperty")));

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

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

See Also

DocumentPropertyCollection::idx_get(System::String) method

Returns a DocumentProperty object by the name of the property.

virtual System::SharedPtr<Aspose::Words::Properties::DocumentProperty> Aspose::Words::Properties::DocumentPropertyCollection::idx_get(System::String name)
ParameterTypeDescription
nameSystem::StringThe case-insensitive name of the property to retrieve.

Remarks

Returns null if a property with the specified name is not found.

Examples

Shows how to create a custom document property which contains a date and time.

auto doc = MakeObject<Document>();

doc->get_CustomDocumentProperties()->Add(u"AuthorizationDate", System::DateTime::get_Now());

std::cout << "Document authorized on " << doc->get_CustomDocumentProperties()->idx_get(u"AuthorizationDate")->ToDateTime() << std::endl;

See Also

Aspose::Words::Properties::DocumentPropertyCollection::GetType method Aspose::Words::Properties::DocumentPropertyCollection::IndexOf method