IXmpMeta
IXmpMeta Public interface
Description
This class represents the set of XMP metadata as a DOM representation. It has methods to read and modify all kinds of properties, create an iterator over all properties and Serialize the metadata to a String, byte-array or ...
Diagram
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph iTextSharp.xmp
iTextSharp.xmp.IXmpMeta[[IXmpMeta]]
class iTextSharp.xmp.IXmpMeta interfaceStyle;
end
subgraph System
System.ICloneable[[ICloneable]]
end
System.ICloneable --> iTextSharp.xmp.IXmpMeta
Members
Properties
Public properties
| Type | Name | Methods |
|---|---|---|
string | ObjectNameThis correlates to the about-attribute, returns the empty String if no name is set. | get, set |
string | PacketHeader | get |
Methods
Public methods
| Returns | Name |
|---|---|
void | AppendArrayItem(...) |
int | CountArrayItems(string schemaNs, string arrayName)Returns the number of items in the array. |
void | DeleteArrayItem(string schemaNs, string arrayName, int itemIndex)Deletes the given XMP subtree rooted at the given array item. It is not an error if the array item does not exist. |
void | DeleteProperty(string schemaNs, string propName)Deletes the given XMP subtree rooted at the given property. It is not an error if the property does not exist. |
void | DeleteQualifier(string schemaNs, string propName, string qualNs, string qualName)Deletes the given XMP subtree rooted at the given qualifier. It is not an error if the qualifier does not exist. |
void | DeleteStructField(string schemaNs, string structName, string fieldNs, string fieldName)Deletes the given XMP subtree rooted at the given struct field. It is not an error if the field does not exist. |
bool | DoesArrayItemExist(string schemaNs, string arrayName, int itemIndex)Tells if the array item exists. |
bool | DoesPropertyExist(string schemaNs, string propName)Returns whether the property exists. |
bool | DoesQualifierExist(string schemaNs, string propName, string qualNs, string qualName)DoesQualifierExist tells if the qualifier exists. |
bool | DoesStructFieldExist(string schemaNs, string structName, string fieldNs, string fieldName)DoesStructFieldExist tells if the struct field exists. |
string | DumpObject()Renders this node and the tree unter this node in a human readable form. |
IXmpProperty | GetArrayItem(string schemaNs, string arrayName, int itemIndex)Provides access to items within an array. The index is passed as an integer, you need not worry about the path string syntax for array items, convert a loop index to a string, etc. |
IXmpProperty | GetLocalizedText(string schemaNs, string altTextName, string genericLang, string specificLang) |
IXmpProperty | GetProperty(string schemaNs, string propName) |
sbyte``[] | GetPropertyBase64(string schemaNs, string propName)Convenience method to retrieve the literal value of a property. |
Nullable<bool> | GetPropertyBoolean(string schemaNs, string propName)These are very similar to ... |
DateTime | GetPropertyCalendar(string schemaNs, string propName)Convenience method to retrieve the literal value of a property. |
IXmpDateTime | GetPropertyDate(string schemaNs, string propName)Convenience method to retrieve the literal value of a property. |
Nullable<double> | GetPropertyDouble(string schemaNs, string propName)Convenience method to retrieve the literal value of a property. |
Nullable<int> | GetPropertyInteger(string schemaNs, string propName)Convenience method to retrieve the literal value of a property. |
Nullable<long> | GetPropertyLong(string schemaNs, string propName)Convenience method to retrieve the literal value of a property. |
string | GetPropertyString(string schemaNs, string propName)Convenience method to retrieve the literal value of a property. Note: There is no ... |
IXmpProperty | GetQualifier(string schemaNs, string propName, string qualNs, string qualName) |
IXmpProperty | GetStructField(string schemaNs, string structName, string fieldNs, string fieldName) |
void | InsertArrayItem(...)Inserts an item into an array previous to the given index. The index is passed as an integer, you need not worry about the path string syntax for array items, convert a loop index to a string, etc. The array passed must already exist. In normal usage the selected array item is modified. A new item is automatically appended if the index is the array size plus 1. |
IXmpIterator | Iterator(...) |
void | Normalize(ParseOptions options)Perform the normalization as a separate parsing step. Normally it is done during parsing, unless the parsing option is set to ... |
void | SetArrayItem(...)Replaces an item within an array. The index is passed as an integer, you need not worry about the path string syntax for array items, convert a loop index to a string, etc. The array passed must already exist. In normal usage the selected array item is modified. A new item is automatically appended if the index is the array size plus 1. |
void | SetLocalizedText(...)Modifies the value of a selected item in an alt-text array. Creates an appropriate array item if necessary, and handles special cases for the x-default item. If the selected item is from a match with the specific language, the value of that item is modified. If the existing value of that item matches the existing value of the x-default item, the x-default item is also modified. If the array only has 1 existing item (which is not x-default), an x-default item is added with the given value. If the selected item is from a match with the generic language and there are no other generic matches, the value of that item is modified. If the existing value of that item matches the existing value of the x-default item, the x-default item is also modified. If the array only has 1 existing item (which is not x-default), an x-default item is added with the given value. If the selected item is from a partial match with the generic language and there are other partial matches, a new item is created for the specific language. The x-default item is not modified. If the selected item is from the last 2 rules then a new item is created for the specific language. If the array only had an x-default item, the x-default item is also modified. If the array was empty, items are created for the specific language and x-default. Note: In a future version of this API a method using Java ... |
void | SetProperty(...) |
void | SetPropertyBase64(...)Convenience method to set a property from a binary ... |
void | SetPropertyBoolean(...)Convenience method to set a property to a literal ... |
void | SetPropertyCalendar(...)Convenience method to set a property with a Java Calendar-object, which is serialized to an ISO8601 date. |
void | SetPropertyDate(...)Convenience method to set a property with an XMPDateTime-object, which is serialized to an ISO8601 date. |
void | SetPropertyDouble(...)Convenience method to set a property to a literal ... |
void | SetPropertyInteger(...)Convenience method to set a property to a literal ... |
void | SetPropertyLong(...)Convenience method to set a property to a literal ... |
void | SetQualifier(...)Provides access to a qualifier attached to a property. The namespace for the qualifier is passed as a URI, you need not worry about the path string syntax. In many regards qualifiers are like struct fields. See the introductory discussion of qualified properties for more information. The names of qualifiers should be XML qualified names, that is within an XML namespace. The path syntax for a qualified name uses the namespace prefix, which is unreliable because the prefix is never guaranteed. The URI is the formal name, the prefix is just a local shorthand in a given sequence of XML text. The property the qualifier will be attached has to exist. |
void | SetStructField(...)Provides access to fields within a nested structure. The namespace for the field is passed as a URI, you need not worry about the path string syntax. The names of fields should be XML qualified names, that is within an XML namespace. The path syntax for a qualified name uses the namespace prefix, which is unreliable because the prefix is never guaranteed. The URI is the formal name, the prefix is just a local shorthand in a given sequence of XML text. |
void | Sort() |
Details
Summary
This class represents the set of XMP metadata as a DOM representation. It has methods to read and modify all kinds of properties, create an iterator over all properties and Serialize the metadata to a String, byte-array or
OutputStream
Inheritance
ICloneable
Methods
GetProperty
public IXmpProperty GetProperty(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName |
GetArrayItem
public IXmpProperty GetArrayItem(string schemaNs, string arrayName, int itemIndex)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the array. Has the same usage as in GetProperty. |
string | arrayName | The name of the array. May be a general path expression, must not be ... |
int | itemIndex | The index of the desired item. Arrays in XMP are indexed from 1. The constant always refers to the last existing array item. |
Summary
Provides access to items within an array. The index is passed as an integer, you need not worry about the path string syntax for array items, convert a loop index to a string, etc.
Returns
Returns a
XMPProperty
containing the value and the options or
null
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all errors and exceptions that may occur. |
CountArrayItems
public int CountArrayItems(string schemaNs, string arrayName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the array. Has the same usage as in GetProperty. |
string | arrayName | The name of the array. May be a general path expression, must not be ... |
Summary
Returns the number of items in the array.
Returns
Returns the number of items in the array.
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all errors and exceptions that may occur. |
GetStructField
public IXmpProperty GetStructField(string schemaNs, string structName, string fieldNs, string fieldName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | structName | |
string | fieldNs | |
string | fieldName |
GetQualifier
public IXmpProperty GetQualifier(string schemaNs, string propName, string qualNs, string qualName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
string | qualNs | |
string | qualName |
SetProperty [1/2]
public void SetProperty(string schemaNs, string propName, object propValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
object | propValue | |
PropertyOptions | options |
SetProperty [2/2]
public void SetProperty(string schemaNs, string propName, object propValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
object | propValue |
SetArrayItem [1/2]
public void SetArrayItem(string schemaNs, string arrayName, int itemIndex, string itemValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the array. Has the same usage as in GetProperty. |
string | arrayName | The name of the array. May be a general path expression, must not be ... |
int | itemIndex | The index of the desired item. Arrays in XMP are indexed from 1. To address the last existing item, use to find out the length of the array. |
string | itemValue | the new value of the array item. Has the same usage as propValue in ... |
PropertyOptions | options | the set options for the item. |
Summary
Replaces an item within an array. The index is passed as an integer, you need not worry about the path string syntax for array items, convert a loop index to a string, etc. The array passed must already exist. In normal usage the selected array item is modified. A new item is automatically appended if the index is the array size plus 1.
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all errors and exceptions that may occur. |
SetArrayItem [2/2]
public void SetArrayItem(string schemaNs, string arrayName, int itemIndex, string itemValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | arrayName | |
int | itemIndex | |
string | itemValue |
InsertArrayItem [1/2]
public void InsertArrayItem(string schemaNs, string arrayName, int itemIndex, string itemValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the array. Has the same usage as in GetProperty. |
string | arrayName | The name of the array. May be a general path expression, must not be ... |
int | itemIndex | The index to insert the new item. Arrays in XMP are indexed from 1. Use ... |
string | itemValue | the new value of the array item. Has the same usage as propValue in ... |
PropertyOptions | options | the set options that decide about the kind of the node. |
Summary
Inserts an item into an array previous to the given index. The index is passed as an integer, you need not worry about the path string syntax for array items, convert a loop index to a string, etc. The array passed must already exist. In normal usage the selected array item is modified. A new item is automatically appended if the index is the array size plus 1.
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all errors and exceptions that may occur. |
InsertArrayItem [2/2]
public void InsertArrayItem(string schemaNs, string arrayName, int itemIndex, string itemValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | arrayName | |
int | itemIndex | |
string | itemValue |
AppendArrayItem [1/2]
public void AppendArrayItem(string schemaNs, string arrayName, PropertyOptions arrayOptions, string itemValue, PropertyOptions itemOptions)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | arrayName | |
PropertyOptions | arrayOptions | |
string | itemValue | |
PropertyOptions | itemOptions |
AppendArrayItem [2/2]
public void AppendArrayItem(string schemaNs, string arrayName, string itemValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | arrayName | |
string | itemValue |
SetStructField [1/2]
public void SetStructField(string schemaNs, string structName, string fieldNs, string fieldName, string fieldValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the struct. Has the same usage as in GetProperty. |
string | structName | The name of the struct. May be a general path expression, must not be null or the empty string. Has the same namespace prefix usage as propName in GetProperty. |
string | fieldNs | The namespace URI for the field. Has the same URI and prefix usage as the schemaNs parameter. |
string | fieldName | The name of the field. Must be a single XML name, must not be null or the empty string. Has the same namespace prefix usage as the structName parameter. |
string | fieldValue | the value of thefield, if the field has a value. Has the same usage as propValue in GetProperty. |
PropertyOptions | options | Option flags describing the field. See the earlier description. |
Summary
Provides access to fields within a nested structure. The namespace for the field is passed as a URI, you need not worry about the path string syntax. The names of fields should be XML qualified names, that is within an XML namespace. The path syntax for a qualified name uses the namespace prefix, which is unreliable because the prefix is never guaranteed. The URI is the formal name, the prefix is just a local shorthand in a given sequence of XML text.
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all errors and exceptions that may occur. |
SetStructField [2/2]
public void SetStructField(string schemaNs, string structName, string fieldNs, string fieldName, string fieldValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | structName | |
string | fieldNs | |
string | fieldName | |
string | fieldValue |
SetQualifier [1/2]
public void SetQualifier(string schemaNs, string propName, string qualNs, string qualName, string qualValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the struct. Has the same usage as in GetProperty. |
string | propName | The name of the property to which the qualifier is attached. Has the same usage as in GetProperty. |
string | qualNs | The namespace URI for the qualifier. Has the same URI and prefix usage as the schemaNs parameter. |
string | qualName | The name of the qualifier. Must be a single XML name, must not be ... |
string | qualValue | A pointer to the ... |
PropertyOptions | options | Option flags describing the qualifier. See the earlier description. |
Summary
Provides access to a qualifier attached to a property. The namespace for the qualifier is passed as a URI, you need not worry about the path string syntax. In many regards qualifiers are like struct fields. See the introductory discussion of qualified properties for more information. The names of qualifiers should be XML qualified names, that is within an XML namespace. The path syntax for a qualified name uses the namespace prefix, which is unreliable because the prefix is never guaranteed. The URI is the formal name, the prefix is just a local shorthand in a given sequence of XML text. The property the qualifier will be attached has to exist.
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all errors and exceptions that may occur. |
SetQualifier [2/2]
public void SetQualifier(string schemaNs, string propName, string qualNs, string qualName, string qualValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
string | qualNs | |
string | qualName | |
string | qualValue |
DeleteProperty
public void DeleteProperty(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in GetProperty. |
Summary
Deletes the given XMP subtree rooted at the given property. It is not an error if the property does not exist.
DeleteArrayItem
public void DeleteArrayItem(string schemaNs, string arrayName, int itemIndex)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the array. Has the same usage as in GetProperty. |
string | arrayName | The name of the array. May be a general path expression, must not be ... |
int | itemIndex | The index of the desired item. Arrays in XMP are indexed from 1. The constant ... |
Summary
Deletes the given XMP subtree rooted at the given array item. It is not an error if the array item does not exist.
DeleteStructField
public void DeleteStructField(string schemaNs, string structName, string fieldNs, string fieldName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the struct. Has the same usage as in ... |
string | structName | The name of the struct. May be a general path expression, must not be ... |
string | fieldNs | The namespace URI for the field. Has the same URI and prefix usage as the schemaNs parameter. |
string | fieldName | The name of the field. Must be a single XML name, must not be ... |
Summary
Deletes the given XMP subtree rooted at the given struct field. It is not an error if the field does not exist.
DeleteQualifier
public void DeleteQualifier(string schemaNs, string propName, string qualNs, string qualName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the struct. Has the same usage as in ... |
string | propName | The name of the property to which the qualifier is attached. Has the same usage as in GetProperty. |
string | qualNs | The namespace URI for the qualifier. Has the same URI and prefix usage as the schemaNs parameter. |
string | qualName | The name of the qualifier. Must be a single XML name, must not be ... |
Summary
Deletes the given XMP subtree rooted at the given qualifier. It is not an error if the qualifier does not exist.
DoesPropertyExist
public bool DoesPropertyExist(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
Summary
Returns whether the property exists.
Returns
Returns true if the property exists.
DoesArrayItemExist
public bool DoesArrayItemExist(string schemaNs, string arrayName, int itemIndex)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the array. Has the same usage as in ... |
string | arrayName | The name of the array. May be a general path expression, must not be ... |
int | itemIndex | The index of the desired item. Arrays in XMP are indexed from 1. The constant ... |
Summary
Tells if the array item exists.
Returns
Returns
true
if the array exists,
false
DoesStructFieldExist
public bool DoesStructFieldExist(string schemaNs, string structName, string fieldNs, string fieldName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the struct. Has the same usage as in ... |
string | structName | The name of the struct. May be a general path expression, must not be ... |
string | fieldNs | The namespace URI for the field. Has the same URI and prefix usage as the schemaNs parameter. |
string | fieldName | The name of the field. Must be a single XML name, must not be ... |
Summary
DoesStructFieldExist tells if the struct field exists.
Returns
Returns true if the field exists.
DoesQualifierExist
public bool DoesQualifierExist(string schemaNs, string propName, string qualNs, string qualName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the struct. Has the same usage as in ... |
string | propName | The name of the property to which the qualifier is attached. Has the same usage as in ... |
string | qualNs | The namespace URI for the qualifier. Has the same URI and prefix usage as the schemaNs parameter. |
string | qualName | The name of the qualifier. Must be a single XML name, must not be ... |
Summary
DoesQualifierExist tells if the qualifier exists.
Returns
Returns true if the qualifier exists.
GetLocalizedText
public IXmpProperty GetLocalizedText(string schemaNs, string altTextName, string genericLang, string specificLang)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | altTextName | |
string | genericLang | |
string | specificLang |
SetLocalizedText [1/2]
public void SetLocalizedText(string schemaNs, string altTextName, string genericLang, string specificLang, string itemValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the alt-text array. Has the same usage as in ... |
string | altTextName | The name of the alt-text array. May be a general path expression, must not be ... |
string | genericLang | The name of the generic language as an RFC 3066 primary subtag. May be ... |
string | specificLang | The name of the specific language as an RFC 3066 tag. Must not be ... |
string | itemValue | A pointer to the ... |
PropertyOptions | options | Option flags, none are defined at present. |
Summary
Modifies the value of a selected item in an alt-text array. Creates an appropriate array item if necessary, and handles special cases for the x-default item. If the selected item is from a match with the specific language, the value of that item is modified. If the existing value of that item matches the existing value of the x-default item, the x-default item is also modified. If the array only has 1 existing item (which is not x-default), an x-default item is added with the given value. If the selected item is from a match with the generic language and there are no other generic matches, the value of that item is modified. If the existing value of that item matches the existing value of the x-default item, the x-default item is also modified. If the array only has 1 existing item (which is not x-default), an x-default item is added with the given value. If the selected item is from a partial match with the generic language and there are other partial matches, a new item is created for the specific language. The x-default item is not modified. If the selected item is from the last 2 rules then a new item is created for the specific language. If the array only had an x-default item, the x-default item is also modified. If the array was empty, items are created for the specific language and x-default. Note: In a future version of this API a method using Java
java.lang.Locale
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all errors and exceptions that may occur. |
SetLocalizedText [2/2]
public void SetLocalizedText(string schemaNs, string altTextName, string genericLang, string specificLang, string itemValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | altTextName | |
string | genericLang | |
string | specificLang | |
string | itemValue |
GetPropertyBoolean
public Nullable<bool> GetPropertyBoolean(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
Summary
These are very similar to
GetProperty()
and
SetProperty()
above, but the value is returned or provided in a literal form instead of as a UTF-8 string. The path composition functions in
XMPPathFactory
Returns
Returns a
Boolean
value or
null
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur, especially conversion errors. |
GetPropertyInteger
public Nullable<int> GetPropertyInteger(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
Summary
Convenience method to retrieve the literal value of a property.
Returns
Returns an
Integer
value or
null
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur, especially conversion errors. |
GetPropertyLong
public Nullable<long> GetPropertyLong(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
Summary
Convenience method to retrieve the literal value of a property.
Returns
Returns a
Long
value or
null
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur, especially conversion errors. |
GetPropertyDouble
public Nullable<double> GetPropertyDouble(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
Summary
Convenience method to retrieve the literal value of a property.
Returns
Returns a
Double
value or
null
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur, especially conversion errors. |
GetPropertyDate
public IXmpDateTime GetPropertyDate(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
Summary
Convenience method to retrieve the literal value of a property.
Returns
Returns a
XMPDateTime
-object or
null
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur, especially conversion errors. |
GetPropertyCalendar
public DateTime GetPropertyCalendar(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
Summary
Convenience method to retrieve the literal value of a property.
Returns
Returns a Java
Calendar
-object or
null
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur, especially conversion errors. |
GetPropertyBase64
public sbyte GetPropertyBase64(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
Summary
Convenience method to retrieve the literal value of a property.
Returns
Returns a
byte[]
-array contained the decoded base64 value or
null
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur, especially conversion errors. |
GetPropertyString
public string GetPropertyString(string schemaNs, string propName)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
Summary
Convenience method to retrieve the literal value of a property. Note: There is no
SetPropertyString()
, because
SetProperty()
Returns
Returns a
String
value or
null
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur, especially conversion errors. |
SetPropertyBoolean [1/2]
public void SetPropertyBoolean(string schemaNs, string propName, bool propValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
bool | propValue | the literal property value as ... |
PropertyOptions | options | options of the property to set (optional). |
Summary
Convenience method to set a property to a literal
boolean
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur. |
SetPropertyBoolean [2/2]
public void SetPropertyBoolean(string schemaNs, string propName, bool propValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
bool | propValue |
SetPropertyInteger [1/2]
public void SetPropertyInteger(string schemaNs, string propName, int propValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
int | propValue | the literal property value as ... |
PropertyOptions | options | options of the property to set (optional). |
Summary
Convenience method to set a property to a literal
int
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur. |
SetPropertyInteger [2/2]
public void SetPropertyInteger(string schemaNs, string propName, int propValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
int | propValue |
SetPropertyLong [1/2]
public void SetPropertyLong(string schemaNs, string propName, long propValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
long | propValue | the literal property value as ... |
PropertyOptions | options | options of the property to set (optional). |
Summary
Convenience method to set a property to a literal
long
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur. |
SetPropertyLong [2/2]
public void SetPropertyLong(string schemaNs, string propName, long propValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
long | propValue |
SetPropertyDouble [1/2]
public void SetPropertyDouble(string schemaNs, string propName, double propValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
double | propValue | the literal property value as ... |
PropertyOptions | options | options of the property to set (optional). |
Summary
Convenience method to set a property to a literal
double
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur. |
SetPropertyDouble [2/2]
public void SetPropertyDouble(string schemaNs, string propName, double propValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
double | propValue |
SetPropertyDate [1/2]
public void SetPropertyDate(string schemaNs, string propName, IXmpDateTime propValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
IXmpDateTime | propValue | the property value as ... |
PropertyOptions | options | options of the property to set (optional). |
Summary
Convenience method to set a property with an XMPDateTime-object, which is serialized to an ISO8601 date.
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur. |
SetPropertyDate [2/2]
public void SetPropertyDate(string schemaNs, string propName, IXmpDateTime propValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
IXmpDateTime | propValue |
SetPropertyCalendar [1/2]
public void SetPropertyCalendar(string schemaNs, string propName, DateTime propValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
DateTime | propValue | the property value as Java ... |
PropertyOptions | options | options of the property to set (optional). |
Summary
Convenience method to set a property with a Java Calendar-object, which is serialized to an ISO8601 date.
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur. |
SetPropertyCalendar [2/2]
public void SetPropertyCalendar(string schemaNs, string propName, DateTime propValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
DateTime | propValue |
SetPropertyBase64 [1/2]
public void SetPropertyBase64(string schemaNs, string propName, sbyte[] propValue, PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | The namespace URI for the property. Has the same usage as in ... |
string | propName | The name of the property. Has the same usage as in ... |
sbyte``[] | propValue | the literal property value as byte array. |
PropertyOptions | options | options of the property to set (optional). |
Summary
Convenience method to set a property from a binary
byte[]
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all exceptions that may occur. |
SetPropertyBase64 [2/2]
public void SetPropertyBase64(string schemaNs, string propName, sbyte[] propValue)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | |
string | propName | |
sbyte``[] | propValue |
Iterator [1/3]
public IXmpIterator Iterator()
Iterator [2/3]
public IXmpIterator Iterator(IteratorOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
IteratorOptions | options |
Iterator [3/3]
public IXmpIterator Iterator(string schemaNs, string propName, IteratorOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
string | schemaNs | Optional schema namespace URI to restrict the iteration. Omitted (visit all schema) by passing ... |
string | propName | Optional property name to restrict the iteration. May be an arbitrary path expression. Omitted (visit all properties) by passing ... |
IteratorOptions | options | Option flags to control the iteration. See for details. |
Summary
Construct an iterator for the properties within an XMP object. According to the parameters it iterates the entire data tree, properties within a specific schema, or a subtree rooted at a specific node.
Returns
Returns an
XMPIterator
for this
XMPMeta
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all errors and exceptions that may occur. |
Sort
public void Sort()
Normalize
public void Normalize(ParseOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
ParseOptions | options | optional parsing options. |
Summary
Perform the normalization as a separate parsing step. Normally it is done during parsing, unless the parsing option is set to
true
. Note: It does no harm to call this method to an already normalized xmp object. It was a PDF/A requirement to get hand on the unnormalized
XMPMeta
Exceptions
| Name | Description |
|---|---|
| XmpException | Wraps all errors and exceptions that may occur. |
DumpObject
public string DumpObject()
Summary
Renders this node and the tree unter this node in a human readable form.
Returns
Returns a multiline string containing the dump.
Properties
ObjectName
public string ObjectName { get; set; }
Summary
This correlates to the about-attribute, returns the empty String if no name is set.
PacketHeader
public string PacketHeader { get; }
Generated with ModularDoc