Aspose::Pdf::Facades::PdfXmpMetadata Class Referencefinal

Class for manipulation with XMP metadata. More...

#include "PdfXmpMetadata.h"

Inherits Aspose::Pdf::Facades::SaveableFacade, and System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IDictionary< System::String, System::SharedPtr< XmpPdfAExtensionSchema > > > get_ExtensionFields ()
 Gets the dictionary of extension fields. More...
 
ASPOSE_PDF_SHARED_API bool get_IsFixedSize () const
 Returns true is collection has fixed size. More...
 
ASPOSE_PDF_SHARED_API bool get_IsReadOnly () const override
 Returns true if collection is read-only. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Count () const override
 Gets count if items in the collection. More...
 
ASPOSE_PDF_SHARED_API bool get_IsSynchronized ()
 Returns true if collection is synchronized. More...
 
ASPOSE_PDF_SHARED_API PdfXmpMetadata ()
 Constructor for PdfXmpMetadata. More...
 
ASPOSE_PDF_SHARED_API PdfXmpMetadata (System::SharedPtr< Aspose::Pdf::Document > document)
 Initializes new PdfXmpMetadata object on base of the document . More...
 
ASPOSE_PDF_SHARED_API void RegisterNamespaceURI (System::String prefix, System::String namespaceURI)
 Registers the namespace URI. More...
 
ASPOSE_PDF_SHARED_API System::String GetNamespaceURIByPrefix (System::String prefix)
 Gets namespace URI by prefix. More...
 
ASPOSE_PDF_SHARED_API System::String GetPrefixByNamespaceURI (System::String namespaceURI)
 Gets the prefix by namespace URI. More...
 
ASPOSE_PDF_SHARED_API void Add (const DefaultMetadataProperties &key, const System::SharedPtr< XmpValue > &value)
 Adds value to XMP metadata. More...
 
ASPOSE_PDF_SHARED_API void Add (System::SharedPtr< XmpPdfAExtensionObject > xmpPdfAExtensionObject, System::String namespacePrefix, System::String namespaceUri, System::String schemaDescription)
 Adds extension field into metadata. More...
 
ASPOSE_PDF_SHARED_API void Clear () override
 Removes all elements from the object. More...
 
ASPOSE_PDF_SHARED_API void Remove (DefaultMetadataProperties key)
 Removes element with specified key. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::String &key, const System::SharedPtr< XmpValue > &value) override
 Adds new element to the dictionary object. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::String &key, const System::SharedPtr< System::Object > &value)
 Adds new element to the dictionary object. More...
 
ASPOSE_PDF_SHARED_API bool Contains (const System::String &key) const
 Checks if dictionary contains the specified key. More...
 
ASPOSE_PDF_SHARED_API bool Contains (const DefaultMetadataProperties &property) const
 Checks if dictionary contains the specified property. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IEnumerator< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XmpValue > > > > GetEnumerator () override
 Gets enumerator object of the dictionary. More...
 
ASPOSE_PDF_SHARED_API bool Remove (const System::String &key) override
 Removes key from the dictionary. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< XmpValueidx_get (const System::String &key) const override
 Gets value by key. More...
 
ASPOSE_PDF_SHARED_API void idx_set (const System::String &key, System::SharedPtr< XmpValue > value) override
 Sets value by key. More...
 
ASPOSE_PDF_SHARED_API void CopyTo (System::ArrayPtr< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XmpValue >>> array, int32_t index) override
 Copy metadata into array. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< XmpValueidx_get (const DefaultMetadataProperties &key) const
 Gets value of XMP metadata by key. More...
 
ASPOSE_PDF_SHARED_API void idx_set (const DefaultMetadataProperties &key, System::SharedPtr< XmpValue > value)
 Gets value of XMP metadata by key. More...
 
ASPOSE_PDF_SHARED_API System::ArrayPtr< uint8_t > GetXmpMetadata ()
 Get the XmpMetadata of the input pdf in a xml format. More...
 
ASPOSE_PDF_SHARED_API System::ArrayPtr< uint8_t > GetXmpMetadata (System::String name)
 Get a part of the XmpMetadata of the input pdf according to a meta name. More...
 
ASPOSE_PDF_SHARED_API bool ContainsKey (const System::String &key) const override
 Determines does this dictionary contasins specified key. More...
 
ASPOSE_PDF_SHARED_API bool TryGetValue (const System::String &key, System::SharedPtr< XmpValue > &value) const override
 Tries to find key in the dictionary and retreives value if found. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XmpValue >> &item) override
 Adds pair with key and value into the dictionary. More...
 
ASPOSE_PDF_SHARED_API bool Contains (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XmpValue >> &item) const override
 Checks does specified key-value pair is contained in the dictionary. More...
 
ASPOSE_PDF_SHARED_API bool Remove (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XmpValue >> &item) override
 Removes key/value pair from the collection. 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 Aspose::Pdf::Facades::SaveableFacade
ASPOSE_PDF_SHARED_API void Save (System::String destFile) override
 Saves the PDF document to the specified file. More...
 
ASPOSE_PDF_SHARED_API void Save (System::SharedPtr< System::IO::Stream > destStream) override
 Saves the PDF document to the specified stream. More...
 
- Public Member Functions inherited from Aspose::Pdf::Facades::Facade
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Documentget_Document () const
 Gets the document facade is working on. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::String srcFile) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< System::IO::Stream > srcStream) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< Aspose::Pdf::Document > srcDoc) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void Close () override
 Disposes Aspose.Pdf.Document bound with a facade. More...
 
ASPOSE_PDF_SHARED_API void Dispose () override
 Disposes the facade. More...
 
- Public Member Functions inherited from Aspose::Pdf::Facades::IFacade
virtual void BindPdf (System::SharedPtr< Document > srcDoc)=0
 Binds PDF document for editing. 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...
 
- Public Member Functions inherited from System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >
virtual SharedPtr< ICollection< System::String > > get_Keys () const
 Accesses key collection. More...
 
virtual SharedPtr< ICollection< System::SharedPtr< Aspose::Pdf::XmpValue > > > get_Values () const
 Accesses value collection. More...
 
bool get_IsFixedSize () const
 Checks if collection size is fixed. More...
 
bool get_IsSynchronized () const
 Checks if container is thread-safe. More...
 
virtual void CopyTo (ArrayPtr< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >> arr, int index) override
 Copies dictionary contents into existing array elements. More...
 
virtual System::SharedPtr< Aspose::Pdf::XmpValueGetValueOrDefault (const System::String &key) const
 Returns value if found; or Value() otherwise. More...
 
virtual System::SharedPtr< Aspose::Pdf::XmpValueGetValueOrDefault (const System::String &key, const System::SharedPtr< Aspose::Pdf::XmpValue > &defaultValue) const
 Returns value if found; or defaultValue otherwise. More...
 
virtual System::SharedPtr< Aspose::Pdf::XmpValueGetValueOrNull (const System::String &key) const
 Returns value if found; or null otherwise, make sense only for reference types. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > >
virtual void Add (const KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > &item)=0
 Adds element into collection. More...
 
virtual bool Contains (const KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > &item) const=0
 Checks if element is present in collection. More...
 
virtual bool Remove (const KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > &item)=0
 Deletes element from collection. More...
 
virtual void CopyTo (System::ArrayPtr< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > array, int arrayIndex)=0
 Copies all collection elements to existing array elements. More...
 
ICollectionoperator= (ICollection &&) noexcept
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&) noexcept
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
SharedPtr< Objectget_SyncRoot () const
 Gets the object the collection is being synchronized through. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > >
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > LINQ_First ()
 Returns the first element of a sequence. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > LINQ_First (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > LINQ_FirstOrDefault (std::function< bool(KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > LINQ_Last ()
 Returns the last element of a sequence. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > > LINQ_Where (std::function< bool(KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > > LINQ_OrderBy (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > > LINQ_OrderByDescending (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > > LINQ_Concat (SharedPtr< IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > > > > LINQ_GroupBy (System::Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin ()
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end ()
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator end () const
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. More...
 

Protected Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::ICollection< System::String > > get_KeysInternal () const
 Implementation of get_Keys() method. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< XmpValue > > > get_ValuesInternal () const
 Implementation of get_Values() method. More...
 
virtual ASPOSE_PDF_SHARED_API ~PdfXmpMetadata ()
 
- Protected Member Functions inherited from Aspose::Pdf::Facades::SaveableFacade
ASPOSE_PDF_SHARED_API SaveableFacade ()
 The constructor. More...
 
ASPOSE_PDF_SHARED_API SaveableFacade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
 The constructor. More...
 
- Protected Member Functions inherited from Aspose::Pdf::Facades::Facade
bool get__IsObjectLicensed ()
 Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. More...
 
ASPOSE_PDF_SHARED_API Facade ()
 The constructor. More...
 
ASPOSE_PDF_SHARED_API Facade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
 The constructor. More...
 
virtual ASPOSE_PDF_SHARED_API void BindPdf (System::String srcFile, System::String password)
 Initializes the facade. More...
 
virtual ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< System::IO::Stream > srcStream, System::String password)
 Initializes the facade. More...
 
virtual ASPOSE_PDF_SHARED_API void AssertDocument () const
 Asserts if the facade is initialized. More...
 
virtual ASPOSE_PDF_SHARED_API ~Facade ()
 
- Protected Member Functions inherited from System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >
 ~IDictionary () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Public Types inherited from System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >
typedef ICollection< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > BaseType
 Base interface type. More...
 
typedef KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > KeyValuePairType
 Key value pair type. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > >
typedef KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > ValueType
 Value type name. More...
 
typedef ICollection< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > >
typedef IEnumerator< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > > IEnumeratorType
 Enumerator type. More...
 
using ValueType = KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >
 
using iterator = System::Details::VirtualizedIterator< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >
 Inner iterator element type. 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...
 

Detailed Description

Class for manipulation with XMP metadata.

Constructor & Destructor Documentation

◆ PdfXmpMetadata() [1/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfXmpMetadata::PdfXmpMetadata ( )

Constructor for PdfXmpMetadata.

◆ PdfXmpMetadata() [2/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfXmpMetadata::PdfXmpMetadata ( System::SharedPtr< Aspose::Pdf::Document document)

Initializes new PdfXmpMetadata object on base of the document .

Parameters
documentPdf document.

◆ ~PdfXmpMetadata()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfXmpMetadata::~PdfXmpMetadata ( )
protectedvirtual

Member Function Documentation

◆ Add() [1/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::Add ( const DefaultMetadataProperties key,
const System::SharedPtr< XmpValue > &  value 
)

Adds value to XMP metadata.

Parameters
keyThe key name.
valueValue which will be added.

◆ Add() [2/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::Add ( System::SharedPtr< XmpPdfAExtensionObject xmpPdfAExtensionObject,
System::String  namespacePrefix,
System::String  namespaceUri,
System::String  schemaDescription 
)

Adds extension field into metadata.

Parameters
xmpPdfAExtensionObjectThe pdf extension object to add.
namespacePrefixThe prefix of schema.
namespaceUriThe namespace uri of schema.
schemaDescriptionThe optional description of schema.

◆ Add() [3/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::Add ( const System::String key,
const System::SharedPtr< XmpValue > &  value 
)
overridevirtual

Adds new element to the dictionary object.

Parameters
keyKey of new element.
valueValue of the element.

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >.

◆ Add() [4/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::Add ( const System::String key,
const System::SharedPtr< System::Object > &  value 
)

Adds new element to the dictionary object.

Parameters
keyKey of new element.
valueValue of the element.

◆ Add() [5/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::Add ( const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XmpValue >> &  item)
override

Adds pair with key and value into the dictionary.

Parameters
itemItem to be added.

◆ Clear()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::Clear ( )
overridevirtual

◆ Contains() [1/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfXmpMetadata::Contains ( const System::String key) const

Checks if dictionary contains the specified key.

Parameters
keyKey which will be checked.
Returns
True - if the dictionary contains the specified key; otherwise, false.

◆ Contains() [2/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfXmpMetadata::Contains ( const DefaultMetadataProperties property) const

Checks if dictionary contains the specified property.

Parameters
propertyProperty which will be checked.
Returns
True - if the dictionary contains the specified property; otherwise, false.

◆ Contains() [3/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfXmpMetadata::Contains ( const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XmpValue >> &  item) const
override

Checks does specified key-value pair is contained in the dictionary.

Parameters
itemKey-value pair.
Returns
true if this pauir was found.

◆ ContainsKey()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfXmpMetadata::ContainsKey ( const System::String key) const
overridevirtual

Determines does this dictionary contasins specified key.

Parameters
keyKey to search in the dictionary.
Returns
true if key is found.

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >.

◆ CopyTo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::CopyTo ( System::ArrayPtr< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XmpValue >>>  array,
int32_t  index 
)
override

Copy metadata into array.

Parameters
arrayThe destination array.
indexThe starting index.

◆ get_Count()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfXmpMetadata::get_Count ( ) const
overridevirtual

◆ get_ExtensionFields()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IDictionary<System::String, System::SharedPtr<XmpPdfAExtensionSchema> > > Aspose::Pdf::Facades::PdfXmpMetadata::get_ExtensionFields ( )

Gets the dictionary of extension fields.

◆ get_IsFixedSize()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfXmpMetadata::get_IsFixedSize ( ) const

Returns true is collection has fixed size.

◆ get_IsReadOnly()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfXmpMetadata::get_IsReadOnly ( ) const
overridevirtual

◆ get_IsSynchronized()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfXmpMetadata::get_IsSynchronized ( )

Returns true if collection is synchronized.

◆ get_KeysInternal()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::ICollection<System::String> > Aspose::Pdf::Facades::PdfXmpMetadata::get_KeysInternal ( ) const
protectedvirtual

◆ get_ValuesInternal()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<XmpValue> > > Aspose::Pdf::Facades::PdfXmpMetadata::get_ValuesInternal ( ) const
protectedvirtual

◆ GetEnumerator()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::Collections::Generic::KeyValuePair<System::String, System::SharedPtr<XmpValue> > > > Aspose::Pdf::Facades::PdfXmpMetadata::GetEnumerator ( )
overridevirtual

Gets enumerator object of the dictionary.

Returns
The enumerator object.

Implements System::Collections::Generic::IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > > >.

◆ GetNamespaceURIByPrefix()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfXmpMetadata::GetNamespaceURIByPrefix ( System::String  prefix)

Gets namespace URI by prefix.

Parameters
prefixThe prefix.
Returns
Namespace URI.

◆ GetPrefixByNamespaceURI()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfXmpMetadata::GetPrefixByNamespaceURI ( System::String  namespaceURI)

Gets the prefix by namespace URI.

Parameters
namespaceURINamespace URI.
Returns
The prefix value.

◆ GetXmpMetadata() [1/2]

ASPOSE_PDF_SHARED_API System::ArrayPtr<uint8_t> Aspose::Pdf::Facades::PdfXmpMetadata::GetXmpMetadata ( )

Get the XmpMetadata of the input pdf in a xml format.

Returns
The bytes of the XmpMetadata.

◆ GetXmpMetadata() [2/2]

ASPOSE_PDF_SHARED_API System::ArrayPtr<uint8_t> Aspose::Pdf::Facades::PdfXmpMetadata::GetXmpMetadata ( System::String  name)

Get a part of the XmpMetadata of the input pdf according to a meta name.

Parameters
nameMetadata name.
Returns
Bytes of metadata.

◆ idx_get() [1/2]

ASPOSE_PDF_SHARED_API System::SharedPtr<XmpValue> Aspose::Pdf::Facades::PdfXmpMetadata::idx_get ( const System::String key) const
overridevirtual

Gets value by key.

Parameters
keyThe key name to get/set.
Returns
Object by key

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >.

◆ idx_get() [2/2]

ASPOSE_PDF_SHARED_API System::SharedPtr<XmpValue> Aspose::Pdf::Facades::PdfXmpMetadata::idx_get ( const DefaultMetadataProperties key) const

Gets value of XMP metadata by key.

Parameters
keyKey of the value.
Returns
Value from XMP metadata.

◆ idx_set() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::idx_set ( const System::String key,
System::SharedPtr< XmpValue value 
)
overridevirtual

Sets value by key.

Parameters
keyThe key name to get/set.
valueObject by key

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >.

◆ idx_set() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::idx_set ( const DefaultMetadataProperties key,
System::SharedPtr< XmpValue value 
)

Gets value of XMP metadata by key.

Parameters
keyKey of the value.
valueValue from XMP metadata.

◆ RegisterNamespaceURI()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::RegisterNamespaceURI ( System::String  prefix,
System::String  namespaceURI 
)

Registers the namespace URI.

Parameters
prefixThe prefix.
namespaceURIThe namespace URI.

◆ Remove() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::Remove ( DefaultMetadataProperties  key)

Removes element with specified key.

Parameters
keyKey of the element which will be deleted.

◆ Remove() [2/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfXmpMetadata::Remove ( const System::String key)
overridevirtual

Removes key from the dictionary.

Parameters
keyKey which will be removed.
Returns
True - if key removed; otherwise, false.

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >.

◆ Remove() [3/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfXmpMetadata::Remove ( const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XmpValue >> &  item)
override

Removes key/value pair from the collection.

Parameters
itemKey/value pair to be removed.
Returns
true if pair was found and removed.

◆ SetTemplateWeakPtr()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfXmpMetadata::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.

◆ TryGetValue()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfXmpMetadata::TryGetValue ( const System::String key,
System::SharedPtr< XmpValue > &  value 
) const
overridevirtual

Tries to find key in the dictionary and retreives value if found.

Parameters
keyKey to search in the dictionary.
valueRetreived value.
Returns
true if key was found.

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XmpValue > >.