XmpPackage Class

Summary: Represents base abstraction for XMP package.

Module: aspose.imaging.xmp

Full Name: aspose.imaging.xmp.XmpPackage

Inheritance: IXmlValue

Properties

Name	Type	Access	Description
namespace_uri	string	r	Gets the namespace URI.
prefix	string	r	Gets the prefix.
xml_namespace	string	r	Gets the XML namespace.

Methods

Name	Description
add_value(key, value)	Adds the value.
clear()	Clears this instance.
contains_key(key)	Determines whether the specified key contains key.
get_prop_value(key)	Gets the object with the specified key.
get_xml_value()	Converts XMP value to the XML representation.
remove(key)	Remove the value with the specified key.
set_prop_value(key, value)	Gets or sets the object with the specified key.
set_value(key, value)	Sets the value.
set_xmp_type_value(key, value)	Sets the XMP type value.

Method: add_value(key, value)

 add_value(key, value) 

Adds the value.

Parameters:

Parameter	Type	Description
key	string	The string representation of key that is identified with added value.
value	string	The value to add to.

Method: contains_key(key)

 contains_key(key) 

Determines whether the specified key contains key.

Parameters:

Parameter	Type	Description
key	string	The key to be checked.

Returns

Type	Description
bool	Returns true if the specified key contains key.

Method: get_prop_value(key)

 get_prop_value(key) 

Gets the object with the specified key.

Parameters:

Parameter	Type	Description
key	string	The key that identifies value.

Returns

Type	Description
object	Returns the object with the specified key.

Method: get_xml_value()

 get_xml_value() 

Converts XMP value to the XML representation.

Returns

Type	Description
string	Returns the XMP value converted to the XML representation.

Method: remove(key)

 remove(key) 

Remove the value with the specified key.

Parameters:

Parameter	Type	Description
key	string	The string representation of key that is identified with removed value.

Returns

Type	Description
bool	Returns true if the value with the specified key was removed.

Method: set_prop_value(key, value)

 set_prop_value(key, value) 

Gets or sets the object with the specified key.

Parameters:

Parameter	Type	Description
key	string	The key that identifies value.
value	object	The object with the specified key.

Method: set_value(key, value)

 set_value(key, value) 

Sets the value.

Parameters:

Parameter	Type	Description
key	string	The string representation of key that is identified with added value.
value	IXmlValue	The value to add to.

Method: set_xmp_type_value(key, value)

 set_xmp_type_value(key, value) 

Sets the XMP type value.

Parameters:

Parameter	Type	Description
key	string	The string representation of key that is identified with set value.
value	XmpTypeBase	The value to set to.