Represents meta information of PDF document. More...

#include "DocumentInfo.h"

Inherits System::Collections::Generic::Dictionary< System::String, System::String >.

Public Member Functions

ASPOSE_PDF_SHARED_API System::String get_Title ()
 Gets document title. More...
 
ASPOSE_PDF_SHARED_API void set_Title (System::String value)
 Sets document title. More...
 
ASPOSE_PDF_SHARED_API System::String get_Creator ()
 Gets document creator. More...
 
ASPOSE_PDF_SHARED_API void set_Creator (System::String value)
 Sets document creator. More...
 
ASPOSE_PDF_SHARED_API System::String get_Author ()
 Gets document author. More...
 
ASPOSE_PDF_SHARED_API void set_Author (System::String value)
 Sets document author. More...
 
ASPOSE_PDF_SHARED_API System::String get_Subject ()
 Gets the subject of the document. More...
 
ASPOSE_PDF_SHARED_API void set_Subject (System::String value)
 Sets the subject of the document. More...
 
ASPOSE_PDF_SHARED_API System::String get_Keywords ()
 Gets or set the keywords of the document. More...
 
ASPOSE_PDF_SHARED_API void set_Keywords (System::String value)
 Gets or set the keywords of the document. More...
 
ASPOSE_PDF_SHARED_API System::String get_Producer ()
 Gets the document producer. More...
 
ASPOSE_PDF_SHARED_API void set_Producer (System::String value)
 Sets the document producer. More...
 
ASPOSE_PDF_SHARED_API System::DateTime get_CreationDate ()
 Gets the date of document creation. More...
 
ASPOSE_PDF_SHARED_API void set_CreationDate (System::DateTime value)
 Sets the date of document creation. More...
 
ASPOSE_PDF_SHARED_API System::TimeSpan get_CreationTimeZone ()
 Time zone of creation date. More...
 
ASPOSE_PDF_SHARED_API void set_CreationTimeZone (System::TimeSpan value)
 Time zone of creation date. More...
 
ASPOSE_PDF_SHARED_API System::TimeSpan get_ModTimeZone ()
 Time zone of modification date. More...
 
ASPOSE_PDF_SHARED_API void set_ModTimeZone (System::TimeSpan value)
 Time zone of modification date. More...
 
ASPOSE_PDF_SHARED_API System::DateTime get_ModDate ()
 Gets the date of document modification. More...
 
ASPOSE_PDF_SHARED_API void set_ModDate (System::DateTime value)
 Sets the date of document modification. More...
 
ASPOSE_PDF_SHARED_API System::String get_Trapped ()
 Gets the trapped flag. More...
 
ASPOSE_PDF_SHARED_API void set_Trapped (System::String value)
 Sets the trapped flag. More...
 
ASPOSE_PDF_SHARED_API DocumentInfo (System::SharedPtr< Document > document)
 Initialize DocumentInfo instance. More...
 
ASPOSE_PDF_SHARED_API void Clear () override
 Clears the document info. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::String &key, const System::String &value) override
 Adds an element with the specified key and value into the collection. More...
 
ASPOSE_PDF_SHARED_API void Remove (System::String key)
 Removes the element with the specified key from the collection. More...
 
ASPOSE_PDF_SHARED_API System::String idx_get (const System::String &key) const override
 Gets the value associated with the specified key. More...
 
ASPOSE_PDF_SHARED_API void idx_set (const System::String &key, System::String value) override
 Sets the value associated with the specified key. More...
 
ASPOSE_PDF_SHARED_API void ClearCustomData ()
 Clears custom data only, leaves all other predefined values (Title, Author, etc.). More...
 
ASPOSE_PDF_SHARED_API void SetTemplateWeakPtr (uint32_t argument) override
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
- Public Member Functions inherited from System::Collections::Generic::Dictionary< System::String, System::String >
 Dictionary ()
 Creates empty dictionary. More...
 
 Dictionary (const map_t &map)
 Copies data from map. More...
 
 Dictionary (int capacity)
 Overload which corresponds to creating pre-allocated dictionary; does no allocation, actually. More...
 
 Dictionary (const SharedPtr< IDictionary< System::String, System::String > > &src)
 Copy constructor. More...
 
 Dictionary (const SharedPtr< IDictionary< System::String, System::String > > &src, const SharedPtr< IEqualityComparer< System::String > > &comparer)
 Copy constructor. More...
 
 Dictionary (const SharedPtr< IEqualityComparer< System::String > > &comparer)
 Creates empty dictionary. More...
 
 Dictionary (int capacity, const SharedPtr< IEqualityComparer< System::String > > &comparer)
 Creates empty dictionary. More...
 
virtual IEnumeratorPtr GetEnumerator () override
 Creates enumerator object. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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 reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Static Public Member Functions

static ASPOSE_PDF_SHARED_API bool IsPredefinedKey (System::String key)
 Determines if the key is predefined (Title, Author, etc.), not custom. 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 ()
 Implements C# typeof(System.Object) construct. More...
 

Protected Member Functions

void UpdateVersion (double version)
 
virtual ASPOSE_PDF_SHARED_API ~DocumentInfo ()
 
- Protected Member Functions inherited from System::Collections::Generic::Dictionary< System::String, System::String >
 ~Dictionary () override
 Destructor. More...
 
SharedPtr< KeyCollectionget_KeysInternal () const override
 Implementation of internal keys collection accessor. More...
 
SharedPtr< ValueCollectionget_ValuesInternal () const override
 Implementation of internal value collection accessor. More...
 

Protected Attributes

bool _creatorUpdated
 
bool _producerUpdated
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::Dictionary< System::String, System::String >
typedef ICollection< System::StringKeyCollection
 Collection of keys to extract. More...
 
typedef ICollection< System::StringValueCollection
 Collection of values to extract. More...
 
typedef std::unordered_map< System::String, System::String, EqualityComparerHashAdapter< System::String >, EqualityComparerAdapter< System::String >, ASPOSE_MAP_ALLOCATOR_TYPE(System::String, System::String)> map_t
 Underlying data type. More...
 
typedef SharedPtr< Dictionary< System::String, System::String > > Ptr
 Pointer type. More...
 
typedef KeyValuePair< System::String, System::StringKVPair
 Key-value pair type. More...
 
typedef SharedPtr< IEnumerable< KVPair > > IEnumerablePtr
 Pointer to enumerable interface. More...
 
typedef SharedPtr< IEnumerator< KVPair > > IEnumeratorPtr
 Pointer to enumerator. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

Represents meta information of PDF document.

Constructor & Destructor Documentation

◆ DocumentInfo()

ASPOSE_PDF_SHARED_API Aspose::Pdf::DocumentInfo::DocumentInfo ( System::SharedPtr< Document document)

Initialize DocumentInfo instance.

Parameters
documentThe info of this document will be used for initialization.

◆ ~DocumentInfo()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::DocumentInfo::~DocumentInfo ( )
protectedvirtual

Member Function Documentation

◆ Add()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::Add ( const System::String key,
const System::String value 
)
override

Adds an element with the specified key and value into the collection.

Parameters
keyThe key of the element to add.
valueThe value of the element to add. The value can be null.

◆ Clear()

◆ ClearCustomData()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::ClearCustomData ( )

Clears custom data only, leaves all other predefined values (Title, Author, etc.).

◆ get_Author()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::DocumentInfo::get_Author ( )

Gets document author.

◆ get_CreationDate()

ASPOSE_PDF_SHARED_API System::DateTime Aspose::Pdf::DocumentInfo::get_CreationDate ( )

Gets the date of document creation.

◆ get_CreationTimeZone()

ASPOSE_PDF_SHARED_API System::TimeSpan Aspose::Pdf::DocumentInfo::get_CreationTimeZone ( )

Time zone of creation date.

◆ get_Creator()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::DocumentInfo::get_Creator ( )

Gets document creator.

◆ get_Keywords()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::DocumentInfo::get_Keywords ( )

Gets or set the keywords of the document.

◆ get_ModDate()

ASPOSE_PDF_SHARED_API System::DateTime Aspose::Pdf::DocumentInfo::get_ModDate ( )

Gets the date of document modification.

◆ get_ModTimeZone()

ASPOSE_PDF_SHARED_API System::TimeSpan Aspose::Pdf::DocumentInfo::get_ModTimeZone ( )

Time zone of modification date.

◆ get_Producer()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::DocumentInfo::get_Producer ( )

Gets the document producer.

◆ get_Subject()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::DocumentInfo::get_Subject ( )

Gets the subject of the document.

◆ get_Title()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::DocumentInfo::get_Title ( )

Gets document title.

◆ get_Trapped()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::DocumentInfo::get_Trapped ( )

Gets the trapped flag.

◆ idx_get()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::DocumentInfo::idx_get ( const System::String key) const
override

Gets the value associated with the specified key.

Parameters
keyThe key whose value to get or set.
Returns

◆ idx_set()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::idx_set ( const System::String key,
System::String  value 
)
override

Sets the value associated with the specified key.

Parameters
keyThe key whose value to get or set.
value

◆ IsPredefinedKey()

static ASPOSE_PDF_SHARED_API bool Aspose::Pdf::DocumentInfo::IsPredefinedKey ( System::String  key)
static

Determines if the key is predefined (Title, Author, etc.), not custom.

Parameters
keySelected key
Returns
True in case the key is predefined.

◆ Remove()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::Remove ( System::String  key)

Removes the element with the specified key from the collection.

Parameters
keyThe key of the element to remove.

◆ set_Author()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_Author ( System::String  value)

Sets document author.

◆ set_CreationDate()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_CreationDate ( System::DateTime  value)

Sets the date of document creation.

◆ set_CreationTimeZone()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_CreationTimeZone ( System::TimeSpan  value)

Time zone of creation date.

◆ set_Creator()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_Creator ( System::String  value)

Sets document creator.

◆ set_Keywords()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_Keywords ( System::String  value)

Gets or set the keywords of the document.

◆ set_ModDate()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_ModDate ( System::DateTime  value)

Sets the date of document modification.

◆ set_ModTimeZone()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_ModTimeZone ( System::TimeSpan  value)

Time zone of modification date.

◆ set_Producer()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_Producer ( System::String  value)

Sets the document producer.

◆ set_Subject()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_Subject ( System::String  value)

Sets the subject of the document.

◆ set_Title()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_Title ( System::String  value)

Sets document title.

◆ set_Trapped()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::set_Trapped ( System::String  value)

Sets the trapped flag.

◆ SetTemplateWeakPtr()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DocumentInfo::SetTemplateWeakPtr ( uint32_t  argument)
overridevirtual

Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.

Parameters
argumentIndex of template argument to treat as weak poiner.

Reimplemented from System::Object.

◆ UpdateVersion()

void Aspose::Pdf::DocumentInfo::UpdateVersion ( double  version)
protected

Member Data Documentation

◆ _creatorUpdated

bool Aspose::Pdf::DocumentInfo::_creatorUpdated
protected

◆ _producerUpdated

bool Aspose::Pdf::DocumentInfo::_producerUpdated
protected