Aspose::Words::Properties::DocumentProperty class
Contents
[
Hide
]DocumentProperty class
Represents a custom or built-in document property. To learn more, visit the Work with Document Properties documentation article.
class DocumentProperty : public System::Object
Methods
Method | Description |
---|---|
get_IsLinkToContent() | Shows whether this property is linked to content or not. |
get_LinkSource() const | Gets the source of a linked custom document property. |
get_Name() const | Returns the name of the property. |
get_Type() const | Gets the data type of the property. |
get_Value() | Gets or sets the value of the property. |
GetType() const override | |
Is(const System::TypeInfo&) const override | |
set_Value(const System::SharedPtr<System::Object>&) | Setter for Aspose::Words::Properties::DocumentProperty::get_Value. |
ToBool() | Returns the property value as bool. |
ToByteArray() | Returns the property value as byte array. |
ToDateTime() | Returns the property value as DateTime in UTC. |
ToDouble() | Returns the property value as double. |
ToInt() | Returns the property value as integer. |
ToString() const override | Returns the property value as a string formatted according to the current locale. |
static Type() |
Examples
Shows how to work with built-in document properties.
auto doc = System::MakeObject<Aspose::Words::Document>(get_MyDir() + u"Properties.docx");
// The "Document" object contains some of its metadata in its members.
std::cout << System::String::Format(u"Document filename:\n\t \"{0}\"", doc->get_OriginalFileName()) << std::endl;
// The document also stores metadata in its built-in properties.
// Each built-in property is a member of the document's "BuiltInDocumentProperties" object.
std::cout << "Built-in Properties:" << std::endl;
for (auto&& docProperty : System::IterateOver(doc->get_BuiltInDocumentProperties()))
{
std::cout << docProperty->get_Name() << std::endl;
std::cout << System::String::Format(u"\tType:\t{0}", docProperty->get_Type()) << std::endl;
// Some properties may store multiple values.
if (System::ObjectExt::Is<System::Collections::Generic::ICollection<System::SharedPtr<System::Object>>>(docProperty->get_Value()))
{
for (auto&& value : System::IterateOver(System::AsCast<System::Collections::Generic::ICollection<System::SharedPtr<System::Object>>>(docProperty->get_Value())))
{
std::cout << System::String::Format(u"\tValue:\t\"{0}\"", value) << std::endl;
}
}
else
{
std::cout << System::String::Format(u"\tValue:\t\"{0}\"", docProperty->get_Value()) << std::endl;
}
}
See Also
- Namespace Aspose::Words::Properties
- Library Aspose.Words for C++