Aspose::Words::Properties::DocumentProperty Class Reference

Represents a custom or built-in document property. More...

#include "Aspose.Words.Cpp/Model/Properties/DocumentProperty.h"

Inherits System::Object.

Public Member Functions

System::String get_Name () const
 Returns the name of the property. More...
 
System::SharedPtr< System::Objectget_Value ()
 Gets or sets the value of the property. More...
 
void set_Value (System::SharedPtr< System::Object > value)
 Setter for Aspose::Words::Properties::DocumentProperty::get_Value. More...
 
Aspose::Words::Properties::PropertyType get_Type () const
 Gets the data type of the property. More...
 
System::String get_LinkSource () const
 Gets the source of a linked custom document property. More...
 
bool get_IsLinkToContent ()
 Shows whether this property is linked to content or not. More...
 
virtual System::String ToString () const
 Returns the property value as a string formatted according to the current locale. More...
 
int32_t ToInt ()
 Returns the property value as integer. More...
 
double ToDouble ()
 Returns the property value as double. More...
 
System::DateTime ToDateTime ()
 Returns the property value as DateTime in UTC. More...
 
bool ToBool ()
 Returns the property value as bool. More...
 
System::ArrayPtr< uint8_t > ToByteArray ()
 Returns the property value as byte array. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 

Detailed Description

Represents a custom or built-in document property.

See also
Aspose::Words::Properties::DocumentPropertyCollection

Member Function Documentation

◆ get_IsLinkToContent()

bool Aspose::Words::Properties::DocumentProperty::get_IsLinkToContent ( )

Shows whether this property is linked to content or not.

◆ get_LinkSource()

System::String Aspose::Words::Properties::DocumentProperty::get_LinkSource ( ) const

Gets the source of a linked custom document property.

◆ get_Name()

System::String Aspose::Words::Properties::DocumentProperty::get_Name ( ) const

Returns the name of the property.

Cannot be null and cannot be an empty string.

◆ get_Type()

Aspose::Words::Properties::PropertyType Aspose::Words::Properties::DocumentProperty::get_Type ( ) const

Gets the data type of the property.

◆ get_Value()

System::SharedPtr<System::Object> Aspose::Words::Properties::DocumentProperty::get_Value ( )

Gets or sets the value of the property.

Cannot be null.

◆ set_Value()

void Aspose::Words::Properties::DocumentProperty::set_Value ( System::SharedPtr< System::Object value)

◆ ToBool()

bool Aspose::Words::Properties::DocumentProperty::ToBool ( )

Returns the property value as bool.

Throws an exception if the property type is not Aspose::Words::Properties::PropertyType::Boolean.

◆ ToByteArray()

System::ArrayPtr<uint8_t> Aspose::Words::Properties::DocumentProperty::ToByteArray ( )

Returns the property value as byte array.

Throws an exception if the property type is not Aspose::Words::Properties::PropertyType::ByteArray.

◆ ToDateTime()

System::DateTime Aspose::Words::Properties::DocumentProperty::ToDateTime ( )

Returns the property value as DateTime in UTC.

Throws an exception if the property type is not Aspose::Words::Properties::PropertyType::DateTime.

Microsoft Word stores only the date part (no time) for custom date properties.

◆ ToDouble()

double Aspose::Words::Properties::DocumentProperty::ToDouble ( )

Returns the property value as double.

Throws an exception if the property type is not Aspose::Words::Properties::PropertyType::Number.

◆ ToInt()

int32_t Aspose::Words::Properties::DocumentProperty::ToInt ( )

Returns the property value as integer.

Throws an exception if the property type is not Aspose::Words::Properties::PropertyType::Number.

◆ ToString()

virtual System::String Aspose::Words::Properties::DocumentProperty::ToString ( ) const
virtual

Returns the property value as a string formatted according to the current locale.

Converts a boolean property into "Y" or "N". Converts a date property into a short date string. For all other types converts a property using Object.ToString().