Describes the XMP extension schema which is provided by PDF/A-1. More...

#include "XmpPdfAExtensionSchema.h"

Inherits System::Object.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< XmpPdfAExtensionSchemaDescriptionget_Description () const
 Gets the schema description. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XmpPdfAExtensionObject > > > get_Objects () const
 Gets the list of objects (properties, value types). More...
 
ASPOSE_PDF_SHARED_API XmpPdfAExtensionSchema (System::SharedPtr< XmpPdfAExtensionSchemaDescription > description)
 Initializes new object. More...
 
ASPOSE_PDF_SHARED_API void Add (System::SharedPtr< XmpPdfAExtensionObject > obj)
 Adds new object into schema. More...
 
ASPOSE_PDF_SHARED_API bool Contains (System::SharedPtr< XmpPdfAExtensionObject > obj)
 Determines whether obj exists in schema. More...
 
ASPOSE_PDF_SHARED_API void Remove (System::SharedPtr< XmpPdfAExtensionObject > obj)
 Removes the object from schema. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Xml::XmlElementGetSchemaXml (System::SharedPtr< System::Xml::XmlDocument > xmlDocument)
 Returns the xml element (tag - li) that represents schema in xml tree. More...
 
ASPOSE_PDF_SHARED_API void GetValuesXml (System::SharedPtr< System::Xml::XmlDocument > xmlDocument, System::SharedPtr< System::Xml::XmlElement > rootElement)
 Gets the values of properties as xml tree representation. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< XmpPdfAExtensionPropertyGetProperty (System::String name)
 Returns PDF/A property by its name. 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 void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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 Attributes

static const ASPOSE_PDF_SHARED_API System::String DefaultExtensionNamespacePrefix
 Default extension namespace prefix. More...
 
static const ASPOSE_PDF_SHARED_API System::String DefaultExtensionNamespaceUri
 Default extension namespace uri. More...
 
static const ASPOSE_PDF_SHARED_API System::String DefaultSchemaNamespacePrefix
 Default schema namespace prefix. More...
 
static const ASPOSE_PDF_SHARED_API System::String DefaultSchemaNamespaceUri
 Default schema namespace uri. More...
 
static const ASPOSE_PDF_SHARED_API System::String DefaultPropertyNamespacePrefix
 Default property namespace prefix. More...
 
static const ASPOSE_PDF_SHARED_API System::String DefaultPropertyNamespaceUri
 Default property namespace uri. More...
 
static const ASPOSE_PDF_SHARED_API System::String DefaultValueTypeNamespacePrefix
 Default valie type namespace prefix. More...
 
static const ASPOSE_PDF_SHARED_API System::String DefaultValueNamespaceUri
 Default value namespace uri. More...
 
static const ASPOSE_PDF_SHARED_API System::String DefaultFieldNamespacePrefix
 Default field namespace prefix. More...
 
static const ASPOSE_PDF_SHARED_API System::String DefaultFieldNamespaceUri
 Default extension namespace uri. More...
 
static const ASPOSE_PDF_SHARED_API System::String RdfPrefix
 Default rdf namespace prefix. More...
 
static const ASPOSE_PDF_SHARED_API System::String RdfNamespaceURI
 Default rdf namespace uri. More...
 

Protected Member Functions

int32_t GetPropertyIndex (System::String name)
 Returns index of property with given name. More...
 

Static Protected Member Functions

static bool IsPdfAExtensionPrefix (System::String localName)
 Determines whether prefix value is a part of pdf-a extension. More...
 
static System::SharedPtr< Collections::AsposeHashDictionary< System::String, System::SharedPtr< XmpPdfAExtensionSchema > > > CreateSchemasElement (System::SharedPtr< System::Xml::XmlNode > rootNode)
 Creates the list of schemas elements from xml tree. More...
 
static void InitializeSchemaValue (System::SharedPtr< System::Xml::XmlNode > node, System::SharedPtr< XmpPdfAExtensionSchema > schema)
 Initializes the value of property. More...
 
static System::SharedPtr< System::Xml::XmlElementCreateDescriptionValueXml (System::SharedPtr< System::Xml::XmlDocument > xmlDocument)
 Creates the description xml element for the block of properties values. More...
 
static System::SharedPtr< System::Xml::XmlElementCreateDescriptionXml (System::SharedPtr< System::Xml::XmlDocument > xmlDocument)
 Creates the description xml element for the all schemas. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer 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

Describes the XMP extension schema which is provided by PDF/A-1.

Constructor & Destructor Documentation

◆ XmpPdfAExtensionSchema()

ASPOSE_PDF_SHARED_API Aspose::Pdf::XmpPdfAExtensionSchema::XmpPdfAExtensionSchema ( System::SharedPtr< XmpPdfAExtensionSchemaDescription description)

Initializes new object.

Parameters
descriptionThe schema description.

Member Function Documentation

◆ Add()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XmpPdfAExtensionSchema::Add ( System::SharedPtr< XmpPdfAExtensionObject obj)

Adds new object into schema.

Parameters
objThe new object.

◆ Contains()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::XmpPdfAExtensionSchema::Contains ( System::SharedPtr< XmpPdfAExtensionObject obj)

Determines whether obj exists in schema.

Parameters
objThe obj to find.
Returns
True - object exists in schema; otherwise, false.

◆ CreateDescriptionValueXml()

static System::SharedPtr<System::Xml::XmlElement> Aspose::Pdf::XmpPdfAExtensionSchema::CreateDescriptionValueXml ( System::SharedPtr< System::Xml::XmlDocument xmlDocument)
staticprotected

Creates the description xml element for the block of properties values.

Parameters
xmlDocumentThe source xml document.
Returns
The description xml element.

◆ CreateDescriptionXml()

static System::SharedPtr<System::Xml::XmlElement> Aspose::Pdf::XmpPdfAExtensionSchema::CreateDescriptionXml ( System::SharedPtr< System::Xml::XmlDocument xmlDocument)
staticprotected

Creates the description xml element for the all schemas.

Parameters
xmlDocumentThe source xml document.
Returns
The description xml element.

◆ CreateSchemasElement()

static System::SharedPtr<Collections::AsposeHashDictionary<System::String, System::SharedPtr<XmpPdfAExtensionSchema> > > Aspose::Pdf::XmpPdfAExtensionSchema::CreateSchemasElement ( System::SharedPtr< System::Xml::XmlNode rootNode)
staticprotected

Creates the list of schemas elements from xml tree.

Parameters
rootNodeThe root node for schemas elements.
Returns
The dictionary of schemas elements in format (key, value): schema_prefix, schema value.

◆ get_Description()

ASPOSE_PDF_SHARED_API System::SharedPtr<XmpPdfAExtensionSchemaDescription> Aspose::Pdf::XmpPdfAExtensionSchema::get_Description ( ) const

Gets the schema description.

◆ get_Objects()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<XmpPdfAExtensionObject> > > Aspose::Pdf::XmpPdfAExtensionSchema::get_Objects ( ) const

Gets the list of objects (properties, value types).

◆ GetProperty()

ASPOSE_PDF_SHARED_API System::SharedPtr<XmpPdfAExtensionProperty> Aspose::Pdf::XmpPdfAExtensionSchema::GetProperty ( System::String  name)

Returns PDF/A property by its name.

Parameters
nameProperty name.
Returns
The property.

◆ GetPropertyIndex()

int32_t Aspose::Pdf::XmpPdfAExtensionSchema::GetPropertyIndex ( System::String  name)
protected

Returns index of property with given name.

Parameters
nameProperty name.
Returns
Index of property within Objects List,

◆ GetSchemaXml()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Xml::XmlElement> Aspose::Pdf::XmpPdfAExtensionSchema::GetSchemaXml ( System::SharedPtr< System::Xml::XmlDocument xmlDocument)

Returns the xml element (tag - li) that represents schema in xml tree.

Parameters
xmlDocumentThe source xml document.
Returns
The xml element.

◆ GetValuesXml()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XmpPdfAExtensionSchema::GetValuesXml ( System::SharedPtr< System::Xml::XmlDocument xmlDocument,
System::SharedPtr< System::Xml::XmlElement rootElement 
)

Gets the values of properties as xml tree representation.

Parameters
xmlDocumentThe source xml document.
rootElementThe root node of properties values list.

◆ InitializeSchemaValue()

static void Aspose::Pdf::XmpPdfAExtensionSchema::InitializeSchemaValue ( System::SharedPtr< System::Xml::XmlNode node,
System::SharedPtr< XmpPdfAExtensionSchema schema 
)
staticprotected

Initializes the value of property.

Parameters
nodeThe current node that stores property value.
schemaThe schema that contains property definition.

◆ IsPdfAExtensionPrefix()

static bool Aspose::Pdf::XmpPdfAExtensionSchema::IsPdfAExtensionPrefix ( System::String  localName)
staticprotected

Determines whether prefix value is a part of pdf-a extension.

Parameters
localNameThe prefix value to validate.
Returns
True - prefix is a part of pdf-a extension; otherwise, false.

◆ Remove()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XmpPdfAExtensionSchema::Remove ( System::SharedPtr< XmpPdfAExtensionObject obj)

Removes the object from schema.

Parameters
objThe object to remove.

Member Data Documentation

◆ DefaultExtensionNamespacePrefix

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::DefaultExtensionNamespacePrefix
static

Default extension namespace prefix.

◆ DefaultExtensionNamespaceUri

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::DefaultExtensionNamespaceUri
static

Default extension namespace uri.

◆ DefaultFieldNamespacePrefix

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::DefaultFieldNamespacePrefix
static

Default field namespace prefix.

◆ DefaultFieldNamespaceUri

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::DefaultFieldNamespaceUri
static

Default extension namespace uri.

◆ DefaultPropertyNamespacePrefix

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::DefaultPropertyNamespacePrefix
static

Default property namespace prefix.

◆ DefaultPropertyNamespaceUri

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::DefaultPropertyNamespaceUri
static

Default property namespace uri.

◆ DefaultSchemaNamespacePrefix

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::DefaultSchemaNamespacePrefix
static

Default schema namespace prefix.

◆ DefaultSchemaNamespaceUri

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::DefaultSchemaNamespaceUri
static

Default schema namespace uri.

◆ DefaultValueNamespaceUri

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::DefaultValueNamespaceUri
static

Default value namespace uri.

◆ DefaultValueTypeNamespacePrefix

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::DefaultValueTypeNamespacePrefix
static

Default valie type namespace prefix.

◆ RdfNamespaceURI

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::RdfNamespaceURI
static

Default rdf namespace uri.

◆ RdfPrefix

const ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XmpPdfAExtensionSchema::RdfPrefix
static

Default rdf namespace prefix.