Class XmpMetadata

Class XmpMetadata

Namespace: Aspose.Page.EPS.XMP
Assembly: Aspose.Page.dll (25.1.2)

Provides access to XMP metadata stream.

public sealed class XmpMetadata : IDictionary<string, xmpvalue="">, ICollection<keyvaluepair<string, xmpvalue="">&gt;, IEnumerable<keyvaluepair<string, xmpvalue="">&gt;, IEnumerable

Inheritance

objectXmpMetadata

Implements

IDictionary<string, xmpvalue="">, ICollection<keyvaluepair<string, xmpvalue="">&gt;, IEnumerable<keyvaluepair<string, xmpvalue="">&gt;, IEnumerable

Inherited Members

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Properties

Count

Gets count of elements in the collection.

public int Count { get; }

Property Value

int

IsFixedSize

Checks if colleciton has fixed size.

public bool IsFixedSize { get; }

Property Value

bool

IsReadOnly

Checks if collection is read-only.

public bool IsReadOnly { get; }

Property Value

bool

IsSynchronized

Checks if collection is synchronized.

public bool IsSynchronized { get; }

Property Value

bool

Keys

Gets collection of metadata keys.

public ICollection<string> Keys { get; }

Property Value

ICollection<string&gt;

NamespaceManager

Gets namespace manager.

public XmlNamespaceManager NamespaceManager { get; }

Property Value

XmlNamespaceManager

SyncRoot

Gets collection synchronization object.

public object SyncRoot { get; }

Property Value

object

Values

Gets values in the metadata.

public ICollection<xmpvalue> Values { get; }

Property Value

ICollection<XmpValue&gt;

this[string]

Gets or sets data from metadata.

public XmpValue this[string key] { get; set; }

Property Value

XmpValue

Methods

Add(string, XmpValue)

Adds value to metadata.

public void Add(string key, XmpValue value)

Parameters

key string

The key to add.

value XmpValue

Value which will be added.

Add(string, object)

Adds value to metadata.

public void Add(string key, object value)

Parameters

key string

The key to add.

value object

Value which will be added.

Add(KeyValuePair<string, xmpvalue="">)

Adds pair with key and value into the dictionary.

public void Add(KeyValuePair<string, xmpvalue=""> item)

Parameters

item KeyValuePair<string, XmpValue&gt;

Item to be added.

AddArrayItem(string, XmpValue)

Adds value into an array. The value will be added at the end of the array.

public void AddArrayItem(string arrayKey, XmpValue value)

Parameters

arrayKey string

Key of the array to search in the dictionary.

value XmpValue

Value to add into the array.

AddArrayItem(string, int, XmpValue)

Adds value into an array by specified index.

public void AddArrayItem(string arrayKey, int index, XmpValue value)

Parameters

arrayKey string

Key of the array to search in the dictionary.

index int

Index of new value in the array.

value XmpValue

Value to add into the array.

AddNamedValue(string, string, XmpValue)

Adds named value into a structure.

public void AddNamedValue(string structureKey, string valueKey, XmpValue value)

Parameters

structureKey string

Key of the structure to search in the dictionary.

valueKey string

Name of the value to add into the struture.

value XmpValue

Value to add into the struture.

Clear()

Clears metadata.

public void Clear()

Contains(string)

Checks does key is contained in metadata.

public bool Contains(string key)

Parameters

key string

The key of entry to find.

Returns

bool

True if key is contained in the metadata.

Contains(KeyValuePair<string, xmpvalue="">)

Checks does specified key-value pair is contained in the dictionary.

public bool Contains(KeyValuePair<string, xmpvalue=""> item)

Parameters

item KeyValuePair<string, XmpValue&gt;

Key-value pair.

Returns

bool

true if this pauir was found.

ContainsKey(string)

Determines does this dictionary contasins specified key.

public bool ContainsKey(string key)

Parameters

key string

Key to search in the dictionary.

Returns

bool

true if key is found.

CopyTo(KeyValuePair<string, xmpvalue="">[], int)

Copies elements of the collection into array.

public void CopyTo(KeyValuePair<string, xmpvalue="">[] array, int index)

Parameters

array KeyValuePair<string, XmpValue&gt;[]

Destination array.

index int

Starting index.

GetEnumerator()

Returns dictionary enumerator.

public IEnumerator<keyvaluepair<string, xmpvalue="">&gt; GetEnumerator()

Returns

IEnumerator<KeyValuePair<string, XmpValue&gt;&gt;

Enumerator.

GetNamespaceUriByPrefix(string)

Returns namespace URI by prefix.

public string GetNamespaceUriByPrefix(string prefix)

Parameters

prefix string

The value of prefix.

Returns

string

The value of namespace URI.

GetPrefixByNamespaceUri(string)

Returns prefix by namespace URI.

public string GetPrefixByNamespaceUri(string namespaceUri)

Parameters

namespaceUri string

Namespace URI.

Returns

string

The value of prefix.

RegisterNamespaceUri(string, string)

Registers namespace URI.

public void RegisterNamespaceUri(string prefix, string namespaceUri)

Parameters

prefix string

The value of prefix.

namespaceUri string

The value of namespace URI.

RegisterNamespaceUri(string, string, string)

Registers namespace URI.

public void RegisterNamespaceUri(string prefix, string namespaceUri, string schemaDescription)

Parameters

prefix string

The value of prefix.

namespaceUri string

The value of namespace URI.

schemaDescription string

The value of schema description.

Remove(string)

Removes entry from metadata.

public bool Remove(string key)

Parameters

key string

The key of entry to remove.

Returns

bool

True - if key removed; otherwise, false.

Remove(KeyValuePair<string, xmpvalue="">)

Removes key/value pair from the colleciton.

public bool Remove(KeyValuePair<string, xmpvalue=""> item)

Parameters

item KeyValuePair<string, XmpValue&gt;

Key/value pair to be removed.

Returns

bool

true if pair was found and removed.

SetArrayItem(string, int, XmpValue)

Sets value in an array. Previous value will be replaced with new one.

public void SetArrayItem(string arrayKey, int index, XmpValue value)

Parameters

arrayKey string

Key of the array to search in the dictionary.

index int

Index of new value in the array.

value XmpValue

Value to set in the array.

SetNamedValue(string, string, XmpValue)

Sets named value into a structure. Previous named value, if already exists, will be replaced with new one.

public void SetNamedValue(string structureKey, string valueKey, XmpValue value)

Parameters

structureKey string

Key of the structure to search in the dictionary.

valueKey string

Name of the value to set into the struture.

value XmpValue

Value to set into the struture.

TryGetValue(string, out XmpValue)

Tries to find key in the dictionary and retreives value if found.

public bool TryGetValue(string key, out XmpValue value)

Parameters

key string

Key to search in the dictionary.

value XmpValue

Retreived value.

Returns

bool

true if key was found. </string,></string,></keyvaluepair<string,></string,></string,></string,></string,></string,></string,></keyvaluepair<string,></keyvaluepair<string,></string,></keyvaluepair<string,></keyvaluepair<string,></string,>

 English