XmpColorantBase class

XmpColorantBase class

A structure containing the characteristics of a colorant (swatch) used in a document.

Inheritance: XmpColorantBase → XmpComplexType → XmpMetadataContainer → CustomPackage → MetadataPackage

The XmpColorantBase type exposes the following members:

Properties

Property Description
metadata_type Gets the metadata type.
keys Gets a collection of the metadata property names.
property_descriptors Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
count Gets the number of metadata properties.
prefixes Gets the namespace prefixes that are used in the XmpComplexType instance.
namespace_uris Gets the namespace URIs that are used in the XmpComplexType instance.
mode Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB.
swatch_name Gets or sets the name of the swatch.
color_type Gets or sets the type of color.

Methods

Method Description
contains(self, property_name) Determines whether the package contains a metadata property with the specified name.
find_properties(self, specification) Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.
update_properties(self, specification, value) Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.
remove_properties(self, specification) Removes metadata properties satisfying a specification.
add_properties(self, specification, value) Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
set_properties(self, specification, value) Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.
sanitize(self) Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.
get_xmp_representation(self) Returns string contained value in XMP format.
get_namespace_uri(self, prefix) Gets the namespace URI associated with the specified prefix.

See Also

XmpBoolean class XmpColorantCmyk class