XmpPackage Class

Summary: Represents base abstraction for XMP package.

Module: aspose.imaging.xmp

Full Name: aspose.imaging.xmp.XmpPackage

Inheritance: IXmlValue

Properties

NameTypeAccessDescription
countintrGets the XMP key count.
namespace_uristringrGets the namespace URI.
prefixstringrGets the prefix.
xml_namespacestringrGets the XML namespace.

Methods

NameDescription
add_value(key, value)Adds the value to the specified key.
add_value(key, value)Adds the value to the specified key.
clear()Clears this instance.
contains_key(key)Determines whether this collection specified 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_value(key, value)Sets the value.
set_xmp_type_value(key, value)Sets the XMP type value.
try_get_value(key, value)Gets the value by the key.

Method: add_value(key, value)

 add_value(key, value) 

Adds the value to the specified key.

Parameters:

ParameterTypeDescription
keystringThe string representation of key that is identified with added value.
valuestringThe value to add to.

Method: add_value(key, value)

 add_value(key, value) 

Adds the value to the specified key.

Parameters:

ParameterTypeDescription
keystringThe string representation of key that is identified with added value.
valueobjectThe value to add to.

Method: contains_key(key)

 contains_key(key) 

Determines whether this collection specified key.

Parameters:

ParameterTypeDescription
keystringThe key to be checked.

Returns

TypeDescription
boolTrue if the contains the specified key; otherwise, False.

Method: get_prop_value(key)

 get_prop_value(key) 

Gets the object with the specified key.

Parameters:

ParameterTypeDescription
keystringThe key that identifies value.

Returns

TypeDescription
objectReturns the object with the specified key.

Method: get_xml_value()

 get_xml_value() 

Converts XMP value to the XML representation.

Returns

TypeDescription
stringReturns the XMP value converted to the XML representation.

Method: remove(key)

 remove(key) 

Remove the value with the specified key.

Parameters:

ParameterTypeDescription
keystringThe string representation of key that is identified with removed value.

Returns

TypeDescription
boolReturns 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:

ParameterTypeDescription
keystringThe key that identifies value.
valueobjectThe object with the specified key.

Method: set_value(key, value)

 set_value(key, value) 

Sets the value.

Parameters:

ParameterTypeDescription
keystringThe string representation of key that is identified with added value.
valueIXmlValueThe value to add to.

Method: set_value(key, value)

 set_value(key, value) 

Sets the value.

Parameters:

ParameterTypeDescription
keystringThe string representation of key that is identified with added value.
valueIXmpTypeThe value to add to.

Method: set_xmp_type_value(key, value)

 set_xmp_type_value(key, value) 

Sets the XMP type value.

Parameters:

ParameterTypeDescription
keystringThe string representation of key that is identified with set value.
valueXmpTypeBaseThe value to set to.

Method: try_get_value(key, value)

 try_get_value(key, value) 

Gets the value by the key.

Parameters:

ParameterTypeDescription
keystringThe XMP element key.
valueObjectThe XMP value.

Returns

TypeDescription
boolTrue, if the contains the key; otherwise, False.