XmpMetaImpl

XmpMetaImpl `Public class`

Description

Implementation for .

        @since 17.02.2006

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph iTextSharp.xmp.impl
  iTextSharp.xmp.impl.XmpMetaImpl[[XmpMetaImpl]]
  end
  subgraph iTextSharp.xmp
  iTextSharp.xmp.IXmpMeta[[IXmpMeta]]
  class iTextSharp.xmp.IXmpMeta interfaceStyle;
  iTextSharp.xmp.XmpConst[[XmpConst]]
  end
  subgraph System
System.ICloneable[[ICloneable]]
  end
iTextSharp.xmp.IXmpMeta --> iTextSharp.xmp.impl.XmpMetaImpl
System.ICloneable --> iTextSharp.xmp.IXmpMeta
iTextSharp.xmp.XmpConst --> iTextSharp.xmp.impl.XmpMetaImpl

Members

Properties

Public properties

Type	Name	Methods
`string`	`ObjectName`	`get, set`
`string`	`PacketHeader`	`get, set`
`XmpNode`	`Root`	`get`

Methods

Public methods

Returns	Name
`void`	`AppendArrayItem`(`...`)
`object`	`Clone`()
`int`	`CountArrayItems`(`string` schemaNs, `string` arrayName)
`void`	`DeleteArrayItem`(`string` schemaNs, `string` arrayName, `int` itemIndex)
`void`	`DeleteProperty`(`string` schemaNs, `string` propName)
`void`	`DeleteQualifier`(`string` schemaNs, `string` propName, `string` qualNs, `string` qualName)
`void`	`DeleteStructField`(`string` schemaNs, `string` structName, `string` fieldNs, `string` fieldName)
`bool`	`DoesArrayItemExist`(`string` schemaNs, `string` arrayName, `int` itemIndex)
`bool`	`DoesPropertyExist`(`string` schemaNs, `string` propName)
`bool`	`DoesQualifierExist`(`string` schemaNs, `string` propName, `string` qualNs, `string` qualName)
`bool`	`DoesStructFieldExist`(`string` schemaNs, `string` structName, `string` fieldNs, `string` fieldName)
`string`	`DumpObject`()
`IXmpProperty`	`GetArrayItem`(`string` schemaNs, `string` arrayName, `int` itemIndex)
`IXmpProperty`	`GetLocalizedText`(`string` schemaNs, `string` altTextName, `string` genericLang, `string` specificLang)
`IXmpProperty`	`GetProperty`(`string` schemaNs, `string` propName)
sbyte``[]	`GetPropertyBase64`(`string` schemaNs, `string` propName)
`Nullable`<`bool`>	`GetPropertyBoolean`(`string` schemaNs, `string` propName)
`DateTime`	`GetPropertyCalendar`(`string` schemaNs, `string` propName)
`IXmpDateTime`	`GetPropertyDate`(`string` schemaNs, `string` propName)
`Nullable`<`double`>	`GetPropertyDouble`(`string` schemaNs, `string` propName)
`Nullable`<`int`>	`GetPropertyInteger`(`string` schemaNs, `string` propName)
`Nullable`<`long`>	`GetPropertyLong`(`string` schemaNs, `string` propName)
`string`	`GetPropertyString`(`string` schemaNs, `string` propName)
`IXmpProperty`	`GetQualifier`(`string` schemaNs, `string` propName, `string` qualNs, `string` qualName)
`IXmpProperty`	`GetStructField`(`string` schemaNs, `string` structName, `string` fieldNs, `string` fieldName)
`void`	`InsertArrayItem`(`...`)
`IXmpIterator`	`Iterator`(`...`)
`void`	`Normalize`(`ParseOptions` options)
`void`	`SetArrayItem`(`...`)
`void`	`SetLocalizedText`(`...`)
`void`	`SetProperty`(`...`)
`void`	`SetPropertyBase64`(`...`)
`void`	`SetPropertyBoolean`(`...`)
`void`	`SetPropertyCalendar`(`...`)
`void`	`SetPropertyDate`(`...`)
`void`	`SetPropertyDouble`(`...`)
`void`	`SetPropertyInteger`(`...`)
`void`	`SetPropertyLong`(`...`)
`void`	`SetQualifier`(`...`)
`void`	`SetStructField`(`...`)
`void`	`Sort`()

Protected internal methods

Returns	Name
`IXmpProperty`	`GetProperty`(`string` schemaNs, `string` propName, `int` valueType)
`object`	`GetPropertyObject`(`string` schemaNs, `string` propName, `int` valueType)

Internal methods

Returns	Name
`void`	`SetNode`(`XmpNode` node, `object` value, `PropertyOptions` newOptions, `bool` deleteExisting) The internals for SetProperty() and related calls, used after the node is found or created.

Details

Summary

Implementation for .

        @since 17.02.2006

Inheritance

IXmpMeta
ICloneable
XmpConst

Constructors

XmpMetaImpl [1/2]

Source code

public XmpMetaImpl()

Summary

Constructor for an empty metadata object.

XmpMetaImpl [2/2]

Source code

public XmpMetaImpl(XmpNode tree)

Arguments

Type	Name	Description
`XmpNode`	tree	an prefilled metadata tree which fulfills all ...

Summary

Constructor for a cloned metadata tree.

Methods

AppendArrayItem [1/2]

Source code

public virtual 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]

Source code

public virtual void AppendArrayItem(string schemaNs, string arrayName, string itemValue)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	arrayName
`string`	itemValue

CountArrayItems

Source code

public virtual int CountArrayItems(string schemaNs, string arrayName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	arrayName

DeleteArrayItem

Source code

public virtual void DeleteArrayItem(string schemaNs, string arrayName, int itemIndex)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	arrayName
`int`	itemIndex

DeleteProperty

Source code

public virtual void DeleteProperty(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

DeleteQualifier

Source code

public virtual void DeleteQualifier(string schemaNs, string propName, string qualNs, string qualName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`string`	qualNs
`string`	qualName

DeleteStructField

Source code

public virtual void DeleteStructField(string schemaNs, string structName, string fieldNs, string fieldName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	structName
`string`	fieldNs
`string`	fieldName

DoesPropertyExist

Source code

public virtual bool DoesPropertyExist(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

DoesArrayItemExist

Source code

public virtual bool DoesArrayItemExist(string schemaNs, string arrayName, int itemIndex)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	arrayName
`int`	itemIndex

DoesStructFieldExist

Source code

public virtual bool DoesStructFieldExist(string schemaNs, string structName, string fieldNs, string fieldName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	structName
`string`	fieldNs
`string`	fieldName

DoesQualifierExist

Source code

public virtual bool DoesQualifierExist(string schemaNs, string propName, string qualNs, string qualName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`string`	qualNs
`string`	qualName

GetArrayItem

Source code

public virtual IXmpProperty GetArrayItem(string schemaNs, string arrayName, int itemIndex)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	arrayName
`int`	itemIndex

GetLocalizedText

Source code

public virtual 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]

Source code

public virtual void SetLocalizedText(string schemaNs, string altTextName, string genericLang, string specificLang, string itemValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	altTextName
`string`	genericLang
`string`	specificLang
`string`	itemValue
`PropertyOptions`	options

SetLocalizedText [2/2]

Source code

public virtual 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

GetProperty [1/2]

Source code

public virtual IXmpProperty GetProperty(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

GetPropertyBoolean

Source code

public virtual Nullable<bool> GetPropertyBoolean(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

SetPropertyBoolean [1/2]

Source code

public virtual void SetPropertyBoolean(string schemaNs, string propName, bool propValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`bool`	propValue
`PropertyOptions`	options

SetPropertyBoolean [2/2]

Source code

public virtual void SetPropertyBoolean(string schemaNs, string propName, bool propValue)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`bool`	propValue

GetPropertyInteger

Source code

public virtual Nullable<int> GetPropertyInteger(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

SetPropertyInteger [1/2]

Source code

public virtual void SetPropertyInteger(string schemaNs, string propName, int propValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`int`	propValue
`PropertyOptions`	options

SetPropertyInteger [2/2]

Source code

public virtual void SetPropertyInteger(string schemaNs, string propName, int propValue)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`int`	propValue

GetPropertyLong

Source code

public virtual Nullable<long> GetPropertyLong(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

SetPropertyLong [1/2]

Source code

public virtual void SetPropertyLong(string schemaNs, string propName, long propValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`long`	propValue
`PropertyOptions`	options

SetPropertyLong [2/2]

Source code

public virtual void SetPropertyLong(string schemaNs, string propName, long propValue)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`long`	propValue

GetPropertyDouble

Source code

public virtual Nullable<double> GetPropertyDouble(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

SetPropertyDouble [1/2]

Source code

public virtual void SetPropertyDouble(string schemaNs, string propName, double propValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`double`	propValue
`PropertyOptions`	options

SetPropertyDouble [2/2]

Source code

public virtual void SetPropertyDouble(string schemaNs, string propName, double propValue)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`double`	propValue

GetPropertyDate

Source code

public virtual IXmpDateTime GetPropertyDate(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

SetPropertyDate [1/2]

Source code

public virtual void SetPropertyDate(string schemaNs, string propName, IXmpDateTime propValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`IXmpDateTime`	propValue
`PropertyOptions`	options

SetPropertyDate [2/2]

Source code

public virtual void SetPropertyDate(string schemaNs, string propName, IXmpDateTime propValue)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`IXmpDateTime`	propValue

GetPropertyCalendar

Source code

public virtual DateTime GetPropertyCalendar(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

SetPropertyCalendar [1/2]

Source code

public virtual void SetPropertyCalendar(string schemaNs, string propName, DateTime propValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`DateTime`	propValue
`PropertyOptions`	options

SetPropertyCalendar [2/2]

Source code

public virtual void SetPropertyCalendar(string schemaNs, string propName, DateTime propValue)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`DateTime`	propValue

GetPropertyBase64

Source code

public virtual sbyte GetPropertyBase64(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

GetPropertyString

Source code

public virtual string GetPropertyString(string schemaNs, string propName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName

SetPropertyBase64 [1/2]

Source code

public virtual void SetPropertyBase64(string schemaNs, string propName, sbyte[] propValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
sbyte``[]	propValue
`PropertyOptions`	options

SetPropertyBase64 [2/2]

Source code

public virtual void SetPropertyBase64(string schemaNs, string propName, sbyte[] propValue)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
sbyte``[]	propValue

GetQualifier

Source code

public virtual IXmpProperty GetQualifier(string schemaNs, string propName, string qualNs, string qualName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`string`	qualNs
`string`	qualName

GetStructField

Source code

public virtual IXmpProperty GetStructField(string schemaNs, string structName, string fieldNs, string fieldName)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	structName
`string`	fieldNs
`string`	fieldName

Iterator [1/3]

Source code

public virtual IXmpIterator Iterator()

Iterator [2/3]

Source code

public virtual IXmpIterator Iterator(IteratorOptions options)

Arguments

Type	Name	Description
`IteratorOptions`	options

Iterator [3/3]

Source code

public virtual IXmpIterator Iterator(string schemaNs, string propName, IteratorOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`IteratorOptions`	options

SetArrayItem [1/2]

Source code

public virtual void SetArrayItem(string schemaNs, string arrayName, int itemIndex, string itemValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	arrayName
`int`	itemIndex
`string`	itemValue
`PropertyOptions`	options

SetArrayItem [2/2]

Source code

public virtual 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]

Source code

public virtual void InsertArrayItem(string schemaNs, string arrayName, int itemIndex, string itemValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	arrayName
`int`	itemIndex
`string`	itemValue
`PropertyOptions`	options

InsertArrayItem [2/2]

Source code

public virtual void InsertArrayItem(string schemaNs, string arrayName, int itemIndex, string itemValue)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	arrayName
`int`	itemIndex
`string`	itemValue

SetProperty [1/2]

Source code

public virtual 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]

Source code

public virtual void SetProperty(string schemaNs, string propName, object propValue)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`object`	propValue

SetQualifier [1/2]

Source code

public virtual void SetQualifier(string schemaNs, string propName, string qualNs, string qualName, string qualValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`string`	qualNs
`string`	qualName
`string`	qualValue
`PropertyOptions`	options

SetQualifier [2/2]

Source code

public virtual 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

SetStructField [1/2]

Source code

public virtual void SetStructField(string schemaNs, string structName, string fieldNs, string fieldName, string fieldValue, PropertyOptions options)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	structName
`string`	fieldNs
`string`	fieldName
`string`	fieldValue
`PropertyOptions`	options

SetStructField [2/2]

Source code

public virtual 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

Clone

Source code

public virtual object Clone()

DumpObject

Source code

public virtual string DumpObject()

Sort

Source code

public virtual void Sort()

Normalize

Source code

public virtual void Normalize(ParseOptions options)

Arguments

Type	Name	Description
`ParseOptions`	options

GetProperty [2/2]

Source code

protected internal virtual IXmpProperty GetProperty(string schemaNs, string propName, int valueType)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`int`	valueType

GetPropertyObject

Source code

protected internal virtual object GetPropertyObject(string schemaNs, string propName, int valueType)

Arguments

Type	Name	Description
`string`	schemaNs
`string`	propName
`int`	valueType

SetNode

Source code

internal virtual void SetNode(XmpNode node, object value, PropertyOptions newOptions, bool deleteExisting)

Arguments

Type	Name	Description
`XmpNode`	node	the newly created node
`object`	value	the node value, can be ...
`PropertyOptions`	newOptions	options for the new node, must not be ...
`bool`	deleteExisting	flag if the existing value is to be overwritten

Summary

The internals for SetProperty() and related calls, used after the node is found or created.

Exceptions

Name	Description
XmpException	thrown if options and value do not correspond

Properties

Root

public virtual XmpNode Root { get; }

ObjectName

public virtual string ObjectName { get; set; }

PacketHeader

public virtual string PacketHeader { get; set; }

Generated with ModularDoc

XmpMetaImpl Public class

Description

Diagram

Members

Properties

Public properties

Methods

Public methods

Protected internal methods

Internal methods

Details

Summary

Inheritance

Constructors

XmpMetaImpl [1/2]

Summary

XmpMetaImpl [2/2]

Arguments

Summary

Methods

AppendArrayItem [1/2]

Arguments

AppendArrayItem [2/2]

Arguments

CountArrayItems

Arguments

DeleteArrayItem

Arguments

DeleteProperty

Arguments

DeleteQualifier

Arguments

DeleteStructField

Arguments

DoesPropertyExist

Arguments

DoesArrayItemExist

Arguments

DoesStructFieldExist

Arguments

DoesQualifierExist

Arguments

GetArrayItem

Arguments

GetLocalizedText

Arguments

SetLocalizedText [1/2]

Arguments

SetLocalizedText [2/2]

Arguments

GetProperty [1/2]

Arguments

GetPropertyBoolean

Arguments

SetPropertyBoolean [1/2]

Arguments

SetPropertyBoolean [2/2]

Arguments

GetPropertyInteger

Arguments

SetPropertyInteger [1/2]

Arguments

SetPropertyInteger [2/2]

Arguments

GetPropertyLong

Arguments

SetPropertyLong [1/2]

Arguments

SetPropertyLong [2/2]

Arguments

GetPropertyDouble

Arguments

SetPropertyDouble [1/2]

Arguments

SetPropertyDouble [2/2]

Arguments

GetPropertyDate

Arguments

SetPropertyDate [1/2]

Arguments

XmpMetaImpl `Public class`