Aspose::Words::Properties::CustomDocumentProperties Class Reference

A collection of custom document properties. More...

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

Inherits Aspose::Words::Properties::DocumentPropertyCollection.

Public Member Functions

System::SharedPtr< Aspose::Words::Properties::DocumentPropertyAdd (System::String name, System::String value)
 Creates a new custom document property of the PropertyType.String data type. More...
 
System::SharedPtr< Aspose::Words::Properties::DocumentPropertyAdd (System::String name, int32_t value)
 Creates a new custom document property of the PropertyType.Number data type. More...
 
System::SharedPtr< Aspose::Words::Properties::DocumentPropertyAdd (System::String name, System::DateTime value)
 Creates a new custom document property of the PropertyType.DateTime data type. More...
 
System::SharedPtr< Aspose::Words::Properties::DocumentPropertyAdd (System::String name, bool value)
 Creates a new custom document property of the PropertyType.Boolean data type. More...
 
System::SharedPtr< Aspose::Words::Properties::DocumentPropertyAdd (System::String name, double value)
 Creates a new custom document property of the PropertyType.Float data type. More...
 
System::SharedPtr< Aspose::Words::Properties::DocumentPropertyAddLinkToContent (System::String name, System::String linkSource)
 Creates a new linked to content custom document property. More...
 
- Public Member Functions inherited from Aspose::Words::Properties::DocumentPropertyCollection
int32_t get_Count ()
 Gets number of items in the collection. More...
 
virtual System::SharedPtr< Aspose::Words::Properties::DocumentPropertyidx_get (System::String name)
 Returns a Aspose::Words::Properties::DocumentProperty object by the name of the property. More...
 
System::SharedPtr< Aspose::Words::Properties::DocumentPropertyidx_get (int32_t index)
 Returns a Aspose::Words::Properties::DocumentProperty object by index. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Words::Properties::DocumentProperty > > > GetEnumerator ()
 Returns an enumerator object that can be used to iterate over all items in the collection. More...
 
bool Contains (System::String name)
 Returns true if a property with the specified name exists in the collection. More...
 
int32_t IndexOf (System::String name)
 Gets the index of a property by name. More...
 
void Remove (System::String name)
 Removes a property with the specified name from the collection. More...
 
void RemoveAt (int32_t index)
 Removes a property at the specified index. More...
 
void Clear ()
 Removes all properties from the collection. 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...
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Properties::DocumentProperty > >
typedef IEnumerator< System::SharedPtr< Aspose::Words::Properties::DocumentProperty > > IEnumeratorType
 Enumerator type. More...
 
- 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)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

A collection of custom document properties.

Each Aspose::Words::Properties::DocumentProperty object represents a custom property of a container document.

See also
Aspose::Words::Document, Aspose::Words::Document::get_BuiltInDocumentProperties, Aspose::Words::Document::get_CustomDocumentProperties

The names of the properties are case-insensitive.

The properties in the collection are sorted alphabetically by name.

Member Function Documentation

◆ Add() [1/5]

System::SharedPtr<Aspose::Words::Properties::DocumentProperty> Aspose::Words::Properties::CustomDocumentProperties::Add ( System::String  name,
bool  value 
)

Creates a new custom document property of the PropertyType.Boolean data type.

Parameters
nameThe name of the property.
valueThe value of the property.
Returns
The newly created property object.

◆ Add() [2/5]

System::SharedPtr<Aspose::Words::Properties::DocumentProperty> Aspose::Words::Properties::CustomDocumentProperties::Add ( System::String  name,
double  value 
)

Creates a new custom document property of the PropertyType.Float data type.

Parameters
nameThe name of the property.
valueThe value of the property.
Returns
The newly created property object.

◆ Add() [3/5]

System::SharedPtr<Aspose::Words::Properties::DocumentProperty> Aspose::Words::Properties::CustomDocumentProperties::Add ( System::String  name,
int32_t  value 
)

Creates a new custom document property of the PropertyType.Number data type.

Parameters
nameThe name of the property.
valueThe value of the property.
Returns
The newly created property object.

◆ Add() [4/5]

System::SharedPtr<Aspose::Words::Properties::DocumentProperty> Aspose::Words::Properties::CustomDocumentProperties::Add ( System::String  name,
System::DateTime  value 
)

Creates a new custom document property of the PropertyType.DateTime data type.

Parameters
nameThe name of the property.
valueThe value of the property.
Returns
The newly created property object.

◆ Add() [5/5]

System::SharedPtr<Aspose::Words::Properties::DocumentProperty> Aspose::Words::Properties::CustomDocumentProperties::Add ( System::String  name,
System::String  value 
)

Creates a new custom document property of the PropertyType.String data type.

Parameters
nameThe name of the property.
valueThe value of the property.
Returns
The newly created property object.

◆ AddLinkToContent()

System::SharedPtr<Aspose::Words::Properties::DocumentProperty> Aspose::Words::Properties::CustomDocumentProperties::AddLinkToContent ( System::String  name,
System::String  linkSource 
)

Creates a new linked to content custom document property.

Parameters
nameThe name of the property.
linkSourceThe source of the property.
Returns
The newly created property object or null when the linkSource is invalid.