Represents meta information of PDF document. More...

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

Public Member Functions

System::String get_Title ()
 Gets document title. More...
 
void set_Title (System::String value)
 Sets document title. More...
 
System::String get_Creator ()
 Gets document creator. More...
 
System::String get_Author ()
 Gets document author. More...
 
void set_Author (System::String value)
 Sets document author. More...
 
System::String get_Subject ()
 Gets the subject of the document. More...
 
void set_Subject (System::String value)
 Sets the subject of the document. More...
 
System::String get_Keywords ()
 Gets or set the keywords of the document. More...
 
void set_Keywords (System::String value)
 Gets or set the keywords of the document. More...
 
System::String get_Producer ()
 Gets the document producer. More...
 
System::DateTime get_CreationDate ()
 Gets the date of document creation. More...
 
void set_CreationDate (System::DateTime value)
 Sets the date of document creation. More...
 
System::TimeSpan get_CreationTimeZone ()
 Time zone of creation date. More...
 
void set_CreationTimeZone (System::TimeSpan value)
 Time zone of creation date. More...
 
System::TimeSpan get_ModTimeZone ()
 Time zone of modification date. More...
 
void set_ModTimeZone (System::TimeSpan value)
 Time zone of modification date. More...
 
System::DateTime get_ModDate ()
 Gets the date of document modification. More...
 
void set_ModDate (System::DateTime value)
 Sets the date of document modification. More...
 
System::String get_Trapped ()
 Gets the trapped flag. More...
 
void set_Trapped (System::String value)
 Sets the trapped flag. More...
 
 DocumentInfo (System::SharedPtr< Document > document)
 Initialize DocumentInfo instance. More...
 
void Clear ()
 Clears the document info. More...
 
void Add (System::String const &key, System::String const &value)
 Adds an element with the specified key and value into the collection. More...
 
void Remove (System::String key)
 Removes the element with the specified key from the collection. More...
 
System::String idx_get (System::String const &key)
 Gets the value associated with the specified key. More...
 
void idx_set (System::String const &key, System::String value)
 Sets the value associated with the specified key. More...
 
void ClearCustomData ()
 Clears custom data only, leaves all other predefined values (Title, Author, etc.). More...
 
- Public Member Functions inherited from System::Collections::Generic::Dictionary< System::String, System::String >
 Dictionary ()
 Creates empty dictionary. More...
 
 Dictionary (const map_t &map)
 
 Dictionary (int capacity)
 
 Dictionary (const SharedPtr< IDictionary< System::String, System::String > > &src)
 
 Dictionary (const SharedPtr< IDictionary< System::String, System::String > > &src, const SharedPtr< IEqualityComparer< System::String > > &comparer)
 
 Dictionary (const SharedPtr< IEqualityComparer< System::String > > &comparer)
 
 Dictionary (int capacity, const SharedPtr< IEqualityComparer< System::String > > &comparer)
 
virtual IEnumeratorPtr GetEnumerator () override
 
KVPairIterator< KVPair, map_tbegin () noexcept
 
KVPairIterator< KVPair, map_tend () noexcept
 
- 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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...
 
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)
 

Static Public Member Functions

static 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Protected Member Functions

void set_Creator (System::String value)
 Sets document creator. More...
 
void set_Producer (System::String value)
 Sets the document producer. More...
 
- Protected Member Functions inherited from System::Collections::Generic::Dictionary< System::String, System::String >
SharedPtr< KeyCollectionget_KeysInternal () const override
 
SharedPtr< ValueCollectionget_ValuesInternal () const override
 

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 >, typename System::Details::CollectionHelpers::MapPointerMode< System::String, System::String >::allocator_type > 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...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Detailed Description

Represents meta information of PDF document.

Constructor & Destructor Documentation

◆ DocumentInfo()

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

Initialize DocumentInfo instance.

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

Member Function Documentation

◆ Add()

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

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()

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

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

◆ get_Author()

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

Gets document author.

◆ get_CreationDate()

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

Gets the date of document creation.

◆ get_CreationTimeZone()

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

Time zone of creation date.

◆ get_Creator()

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

Gets document creator.

◆ get_Keywords()

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

Gets or set the keywords of the document.

◆ get_ModDate()

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

Gets the date of document modification.

◆ get_ModTimeZone()

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

Time zone of modification date.

◆ get_Producer()

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

Gets the document producer.

◆ get_Subject()

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

Gets the subject of the document.

◆ get_Title()

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

Gets document title.

◆ get_Trapped()

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

Gets the trapped flag.

◆ idx_get()

System::String Aspose::Pdf::DocumentInfo::idx_get ( System::String const &  key)

Gets the value associated with the specified key.

Parameters
keyThe key whose value to get or set.
Returns

◆ idx_set()

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

Sets the value associated with the specified key.

Parameters
keyThe key whose value to get or set.
value

◆ IsPredefinedKey()

static 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()

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()

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

Sets document author.

◆ set_CreationDate()

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

Sets the date of document creation.

◆ set_CreationTimeZone()

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

Time zone of creation date.

◆ set_Creator()

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

Sets document creator.

◆ set_Keywords()

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

Gets or set the keywords of the document.

◆ set_ModDate()

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

Sets the date of document modification.

◆ set_ModTimeZone()

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

Time zone of modification date.

◆ set_Producer()

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

Sets the document producer.

◆ set_Subject()

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

Sets the subject of the document.

◆ set_Title()

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

Sets document title.

◆ set_Trapped()

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

Sets the trapped flag.