---
product: Chilkat
product_version: 11.7.0
language: csharp
language_label: C#
class: Xmp
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/csXmpRef.html
---
# Chilkat Xmp — C# — v11.7.0

> Chilkat 11.7.0 · language=csharp · class=Xmp
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Xmp.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/csharp/guide.md`.

## Purpose

**Read, modify, add, remove, and save XMP metadata in JPG and TIFF files.**

`Chilkat.Xmp` is a legacy class for working with embedded XMP metadata in `JPG` and `TIFF` image files. It can load image files or image data from memory, locate embedded XMP documents, return XMP metadata as `Chilkat.Xml`, create new XMP documents, add or update simple string and integer properties, manage arrays and structured properties, add namespace mappings, remove selected XMP properties or entire embedded XMP documents, and save the updated image back to a file or byte buffer.

**Legacy class:** `Chilkat.Xmp` is maintained for existing JPG/TIFF XMP workflows, but it is not planned to be extended to support additional file types.

**Load JPG or TIFF metadata**

Load a `JPG` or `TIFF` file from disk or memory and inspect how many embedded XMP documents were found.

**Access XMP as XML**

Retrieve embedded XMP documents as `Chilkat.Xml` objects for inspection, editing, or direct XML-level processing.

**Add simple properties**

Add or update namespace-qualified string and integer properties such as `dc:subject`, `photoshop:Credit`, or `tiff:XResolution`.

**Arrays and structures**

Work with XMP arrays such as `bag`, `seq`, and `alt`, and manage structured property values.

**Namespaces**

Use built-in namespace mappings or add custom namespace-to-URI mappings for application-specific XMP properties.

**Remove and save**

Remove properties, arrays, structures, or embedded XMP documents, then persist changes to a file or return the updated image as a byte buffer.

**Common pattern:** Load a JPG or TIFF with `LoadAppFile` or `LoadFromBuffer`, retrieve an embedded XMP document with `GetEmbedded` or create one with `NewXmp`, modify it using the add/remove property methods, then call `SaveAppFile` or `SaveToBuffer` to persist the updated image metadata.

**Persistence note:** Changes made to the XMP XML object are not written back to the image file until `SaveAppFile` is called. For memory workflows, use `SaveToBuffer` to obtain the updated JPG or TIFF bytes.

## Object creation, unlocking and error handling

**Object Creation**

```csharp
Chilkat.Xmp obj = new Chilkat.Xmp();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in C#.

Minimal complete program:

```csharp
// Required once per process. Any string unlocks a 30-day trial; use your purchased code in production.
Chilkat.Global glob = new Chilkat.Global();
if (!glob.UnlockBundle("Anything for 30-day trial"))
{
    Console.WriteLine(glob.LastErrorText);
    return;
}

Chilkat.Xmp xmp = new Chilkat.Xmp();

bool success = xmp.LoadAppFile("<filename>");
if (!success)
{
    Console.WriteLine(xmp.LastErrorText);   // full diagnostic of what went wrong
    return;
}
```

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `public string DebugLogFilePath {get; set; }` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `public string LastErrorHtml {get; }` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `public string LastErrorText {get; }` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `public string LastErrorXml {get; }` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `public bool LastMethodSuccess {get; set; }` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `public bool VerboseLogging {get; set; }` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `public string Version {get; }` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `NumEmbedded` | property, read-only | `public int NumEmbedded {get; }` |
| `StructInnerDescrip` | property, read/write | `public bool StructInnerDescrip {get; set; }` |
| `UncommonOptions` | property, read/write | `public string UncommonOptions {get; set; }` |
| `AddArray` | method | `public bool AddArray(Xml xml, string arrType, string propName, StringArray values);` |
| `AddNsMapping` | method | `public void AddNsMapping(string ns, string uri);` |
| `AddSimpleInt` | method | `public bool AddSimpleInt(Xml iXml, string propName, int propVal);` |
| `AddSimpleStr` | method | `public bool AddSimpleStr(Xml iXml, string propName, string propVal);` |
| `AddStructProp` | method | `public bool AddStructProp(Xml iChilkatXml, string structName, string propName, string propValue);` |
| `Append` | method | `public bool Append(Xml iXml);` |
| `GetArray` | method | `public StringArray GetArray(Xml iXml, string propName);` |
| `GetEmbedded` | method | `public Xml GetEmbedded(int index);` |
| `GetProperty` | method | `public Xml GetProperty(Xml iXml, string propName);` |
| `GetSimpleInt` | method | `public int GetSimpleInt(Xml iXml, string propName);` |
| `GetSimpleStr` | method | `public string GetSimpleStr(Xml iXml, string propName);` |
| `GetStructPropNames` | method | `public StringArray GetStructPropNames(Xml iXml, string structName);` |
| `GetStructValue` | method | `public string GetStructValue(Xml iXml, string structName, string propName);` |
| `LoadAppFile` | method | `public bool LoadAppFile(string filename);` |
| `LoadFromBuffer` | method | `public bool LoadFromBuffer(byte[] fileData, string ext);` |
| `NewXmp` | method | `public Xml NewXmp();` |
| `RemoveAllEmbedded` | method | `public bool RemoveAllEmbedded();` |
| `RemoveArray` | method | `public bool RemoveArray(Xml iXml, string propName);` |
| `RemoveEmbedded` | method | `public bool RemoveEmbedded(int index);` |
| `RemoveNsMapping` | method | `public void RemoveNsMapping(string ns);` |
| `RemoveSimple` | method | `public bool RemoveSimple(Xml iXml, string propName);` |
| `RemoveStruct` | method | `public bool RemoveStruct(Xml iXml, string structName);` |
| `RemoveStructProp` | method | `public bool RemoveStructProp(Xml iXml, string structName, string propName);` |
| `SaveAppFile` | method | `public bool SaveAppFile(string filename);` |
| `SaveToBuffer` | method | `public byte[] SaveToBuffer();` |

## Properties

### Xmp.NumEmbedded

`Chilkat 11.7.0 · csharp · Xmp · NumEmbedded · property · read-only`

```csharp
public int NumEmbedded {get; }
```

The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.

### Xmp.StructInnerDescrip

`Chilkat 11.7.0 · csharp · Xmp · StructInnerDescrip · property · read/write`

```csharp
public bool StructInnerDescrip {get; set; }
```

Determines whether structures are stored with rdf:parseType=`Resource`, or within an `rdf:Description` sub-node.

### Xmp.UncommonOptions

`Chilkat 11.7.0 · csharp · Xmp · UncommonOptions · property · read/write · since 9.5.0.80`

```csharp
public string UncommonOptions {get; set; }
```

A property to be used for future uncommon needs. The default value is the empty string.

## Methods

### Xmp.AddArray

`Chilkat 11.7.0 · csharp · Xmp · AddArray · method`

```csharp
public bool AddArray(Xml xml, string arrType, string propName, StringArray values);
```

Adds or replaces an XMP property array. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The 2nd argument specifies the array type, which can be `bag`, `seq`, or `alt`. The property name should be prefixed with the namespace, such as `dc:subject`.

Returns true for success, false for failure.

### Xmp.AddNsMapping

`Chilkat 11.7.0 · csharp · Xmp · AddNsMapping · method`

```csharp
public void AddNsMapping(string ns, string uri);
```

Adds a namespace to URI mapping. When a property is added via AddSimpleString or any of the other methods, the property name is namespace qualified. When adding the first property in a namespace, the rdf:Description is automatically added and the URI is obtained from the namespace-to-URI mappings. The standard (and commonly used) namespace mappings are defined by default. This is only used if the namespace is custom or not already handled.

### Xmp.AddSimpleInt

`Chilkat 11.7.0 · csharp · Xmp · AddSimpleInt · method`

```csharp
public bool AddSimpleInt(Xml iXml, string propName, int propVal);
```

Adds or updates an XMP integer property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as `tiff:XResolution`.

Returns true for success, false for failure.

### Xmp.AddSimpleStr

`Chilkat 11.7.0 · csharp · Xmp · AddSimpleStr · method`

```csharp
public bool AddSimpleStr(Xml iXml, string propName, string propVal);
```

Adds or updates a simple XMP string property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as `photoshop:Credit`.

Returns true for success, false for failure.

### Xmp.AddStructProp

`Chilkat 11.7.0 · csharp · Xmp · AddStructProp · method`

```csharp
public bool AddStructProp(Xml iChilkatXml, string structName, string propName, string propValue);
```

Adds or updates an XMP structured property value. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The structure name should be prefixed with the namespace, such as `Iptc4xmpCore:CreatorContactInfo`. The property name within the structure should also be prefixed with the namespace, such as `Iptc4xmpCore:CiAdrCity`.

Returns true for success, false for failure.

### Xmp.Append

`Chilkat 11.7.0 · csharp · Xmp · Append · method`

```csharp
public bool Append(Xml iXml);
```

Appends a new XMP metadata file to the XMP object. Any XMPs appended via this method will be present in the file when SaveAppFile is called. Files containing XMP metadata typically only include a single XMP document, so this method is usually only called when adding XMP metadata to a file for the first time.

Returns true for success, false for failure.

### Xmp.GetArray

`Chilkat 11.7.0 · csharp · Xmp · GetArray · method`

```csharp
public StringArray GetArray(Xml iXml, string propName);
```

Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as `dc:subject`.

Returns `null` on failure

### Xmp.GetEmbedded

`Chilkat 11.7.0 · csharp · Xmp · GetEmbedded · method`

```csharp
public Xml GetEmbedded(int index);
```

Returns the Nth embedded XMP document as a Chilkat XML object.

Returns `null` on failure

### Xmp.GetProperty

`Chilkat 11.7.0 · csharp · Xmp · GetProperty · method`

```csharp
public Xml GetProperty(Xml iXml, string propName);
```

To be documented soon...

Returns `null` on failure

### Xmp.GetSimpleInt

`Chilkat 11.7.0 · csharp · Xmp · GetSimpleInt · method`

```csharp
public int GetSimpleInt(Xml iXml, string propName);
```

Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as `tiff:ResolutionUnit`.

### Xmp.GetSimpleStr

`Chilkat 11.7.0 · csharp · Xmp · GetSimpleStr · method`

```csharp
public string GetSimpleStr(Xml iXml, string propName);
```

Finds and returns an XMP simple string property. The property name should be prefixed with the namespace, such as `photoshop:Source`.

Returns `null` on failure

### Xmp.GetStructPropNames

`Chilkat 11.7.0 · csharp · Xmp · GetStructPropNames · method`

```csharp
public StringArray GetStructPropNames(Xml iXml, string structName);
```

Returns the property names used by an exsting structure within an XMP document. The contents of the structure can be retrieved by calling GetStructValue for each property name returned by GetStructPropNames.

Returns `null` on failure

### Xmp.GetStructValue

`Chilkat 11.7.0 · csharp · Xmp · GetStructValue · method`

```csharp
public string GetStructValue(Xml iXml, string structName, string propName);
```

Returns the value of a single item within an XMP structure property. Property names should always be prefixed with the namespace.

Returns `null` on failure

### Xmp.LoadAppFile

`Chilkat 11.7.0 · csharp · Xmp · LoadAppFile · method`

```csharp
public bool LoadAppFile(string filename);
```

Loads a TIFF or JPG file into the XMP object.

Returns true for success, false for failure.

### Xmp.LoadFromBuffer

`Chilkat 11.7.0 · csharp · Xmp · LoadFromBuffer · method`

```csharp
public bool LoadFromBuffer(byte[] fileData, string ext);
```

Loads a JPG or TIFF from an byte buffer containing the image file data.

### Xmp.NewXmp

`Chilkat 11.7.0 · csharp · Xmp · NewXmp · method`

```csharp
public Xml NewXmp();
```

Creates and returns a new/empty XMP metadata document as a Chilkat XML object.

Returns `null` on failure

### Xmp.RemoveAllEmbedded

`Chilkat 11.7.0 · csharp · Xmp · RemoveAllEmbedded · method`

```csharp
public bool RemoveAllEmbedded();
```

Removes all XMP metadata documents from an XMP object. After calling this method, call SaveAppFile to rewrite the JPG or TIFF file with the XMP metadata removed.

Returns true for success, false for failure.

### Xmp.RemoveArray

`Chilkat 11.7.0 · csharp · Xmp · RemoveArray · method`

```csharp
public bool RemoveArray(Xml iXml, string propName);
```

Removes an XMP array property from the XMP document.

Returns true for success, false for failure.

### Xmp.RemoveEmbedded

`Chilkat 11.7.0 · csharp · Xmp · RemoveEmbedded · method`

```csharp
public bool RemoveEmbedded(int index);
```

Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist the changes to disk.

Returns true for success, false for failure.

### Xmp.RemoveNsMapping

`Chilkat 11.7.0 · csharp · Xmp · RemoveNsMapping · method`

```csharp
public void RemoveNsMapping(string ns);
```

Removes a namespace-to-URI mapping.

### Xmp.RemoveSimple

`Chilkat 11.7.0 · csharp · Xmp · RemoveSimple · method`

```csharp
public bool RemoveSimple(Xml iXml, string propName);
```

Removes a simple XMP property from the XMP document.

Returns true for success, false for failure.

### Xmp.RemoveStruct

`Chilkat 11.7.0 · csharp · Xmp · RemoveStruct · method`

```csharp
public bool RemoveStruct(Xml iXml, string structName);
```

Removes an XMP structure property from the XMP document.

Returns true for success, false for failure.

### Xmp.RemoveStructProp

`Chilkat 11.7.0 · csharp · Xmp · RemoveStructProp · method`

```csharp
public bool RemoveStructProp(Xml iXml, string structName, string propName);
```

Removes a single member from an XMP structured property.

Returns true for success, false for failure.

### Xmp.SaveAppFile

`Chilkat 11.7.0 · csharp · Xmp · SaveAppFile · method`

```csharp
public bool SaveAppFile(string filename);
```

Persists all changes made to the XMP document(s) by saving the XMP object to a file. Changes made by adding, updating, or removing properties are not persisted to the filesystem until this is called.

Returns true for success, false for failure.

### Xmp.SaveToBuffer

`Chilkat 11.7.0 · csharp · Xmp · SaveToBuffer · method`

```csharp
public byte[] SaveToBuffer();
```

Saves a JPG or TIFF image with updated XMP to a byte buffer.

Returns an empty byte array on failure

## Related classes

[`StringArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/csharp/classes/StringArray.md), [`Xml`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/csharp/classes/Xml.md)