Class XMPMetaImpl

Namespace

iText.Kernel.XMP.Impl

Assembly

itext.kernel.dll

Implementation for XMPMeta .

public class XMPMetaImpl : XMPConst, XMPMeta

Inheritance

object

XMPConst

XMPMetaImpl

Implements

XMPMeta

Inherited Members

XMPConst.NS_XML

XMPConst.NS_RDF

XMPConst.NS_DC

XMPConst.NS_IPTCCORE

XMPConst.NS_IPTCEXT

XMPConst.NS_DICOM

XMPConst.NS_PLUS

XMPConst.NS_X

XMPConst.NS_IX

XMPConst.NS_XMP

XMPConst.NS_XMP_RIGHTS

XMPConst.NS_XMP_MM

XMPConst.NS_XMP_BJ

XMPConst.NS_XMP_NOTE

XMPConst.NS_PDF

XMPConst.NS_PDFX

XMPConst.NS_PDFX_ID

XMPConst.NS_PDFA_SCHEMA

XMPConst.NS_PDFA_PROPERTY

XMPConst.NS_PDFA_TYPE

XMPConst.NS_PDFA_FIELD

XMPConst.NS_PDFA_ID

XMPConst.NS_PDFUA_ID

XMPConst.NS_PDFA_EXTENSION

XMPConst.NS_PHOTOSHOP

XMPConst.NS_PSALBUM

XMPConst.NS_EXIF

XMPConst.NS_EXIFX

XMPConst.NS_EXIF_AUX

XMPConst.NS_TIFF

XMPConst.NS_PNG

XMPConst.NS_JPEG

XMPConst.NS_JP2K

XMPConst.NS_CAMERARAW

XMPConst.NS_ADOBESTOCKPHOTO

XMPConst.NS_CREATOR_ATOM

XMPConst.NS_ASF

XMPConst.NS_WAV

XMPConst.NS_BWF

XMPConst.NS_RIFFINFO

XMPConst.NS_SCRIPT

XMPConst.NS_TXMP

XMPConst.NS_SWF

XMPConst.NS_DM

XMPConst.NS_TRANSIENT

XMPConst.NS_DC_DEPRECATED

XMPConst.TYPE_IDENTIFIERQUAL

XMPConst.TYPE_DIMENSIONS

XMPConst.TYPE_TEXT

XMPConst.TYPE_PAGEDFILE

XMPConst.TYPE_GRAPHICS

XMPConst.TYPE_IMAGE

XMPConst.TYPE_FONT

XMPConst.TYPE_RESOURCEEVENT

XMPConst.TYPE_RESOURCEREF

XMPConst.TYPE_ST_VERSION

XMPConst.TYPE_ST_JOB

XMPConst.TYPE_MANIFESTITEM

XMPConst.TRUESTR

XMPConst.FALSESTR

XMPConst.ARRAY_LAST_ITEM

XMPConst.ARRAY_ITEM_NAME

XMPConst.X_DEFAULT

XMPConst.XML_LANG

XMPConst.RDF_TYPE

XMPConst.XMP_PI

XMPConst.TAG_XMPMETA

XMPConst.TAG_XAPMETA

XMPConst.PART

XMPConst.TITLE

XMPConst.REV

XMPConst.CONFORMANCE

XMPConst.HISTORY

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

XMPMetaImpl()

Constructor for an empty metadata object.

public XMPMetaImpl()

XMPMetaImpl(XMPNode)

Constructor for a cloned metadata tree.

public XMPMetaImpl(XMPNode tree)

Parameters

tree XMPNode

an prefilled metadata tree which fulfills all

XMPNode

contracts.

Methods

AppendArrayItem(string, string, string)

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

Parameters

schemaNS string

arrayName string

itemValue string

AppendArrayItem(string, string, PropertyOptions, string, PropertyOptions)

public virtual void AppendArrayItem(string schemaNS, string arrayName, PropertyOptions arrayOptions, string itemValue, PropertyOptions itemOptions)

Parameters

schemaNS string

arrayName string

arrayOptions PropertyOptions

itemValue string

itemOptions PropertyOptions

Clone()

Performs a deep clone of the XMPMeta-object

public virtual object Clone()

Returns

object

CountArrayItems(string, string)

public virtual int CountArrayItems(string schemaNS, string arrayName)

Parameters

schemaNS string

arrayName string

Returns

int

DeleteArrayItem(string, string, int)

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

Parameters

schemaNS string

arrayName string

itemIndex int

DeleteProperty(string, string)

public virtual void DeleteProperty(string schemaNS, string propName)

Parameters

schemaNS string

propName string

DeleteQualifier(string, string, string, string)

public virtual void DeleteQualifier(string schemaNS, string propName, string qualNS, string qualName)

Parameters

schemaNS string

propName string

qualNS string

qualName string

DeleteStructField(string, string, string, string)

public virtual void DeleteStructField(string schemaNS, string structName, string fieldNS, string fieldName)

Parameters

schemaNS string

structName string

fieldNS string

fieldName string

DoesArrayItemExist(string, string, int)

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

Parameters

schemaNS string

arrayName string

itemIndex int

Returns

bool

DoesPropertyExist(string, string)

public virtual bool DoesPropertyExist(string schemaNS, string propName)

Parameters

schemaNS string

propName string

Returns

bool

DoesQualifierExist(string, string, string, string)

public virtual bool DoesQualifierExist(string schemaNS, string propName, string qualNS, string qualName)

Parameters

schemaNS string

propName string

qualNS string

qualName string

Returns

bool

DoesStructFieldExist(string, string, string, string)

public virtual bool DoesStructFieldExist(string schemaNS, string structName, string fieldNS, string fieldName)

Parameters

schemaNS string

structName string

fieldNS string

fieldName string

Returns

bool

DumpObject()

public virtual string DumpObject()

Returns

string

GetArrayItem(string, string, int)

public virtual XMPProperty GetArrayItem(string schemaNS, string arrayName, int itemIndex)

Parameters

schemaNS string

arrayName string

itemIndex int

Returns

XMPProperty

GetLocalizedText(string, string, string, string)

public virtual XMPProperty GetLocalizedText(string schemaNS, string altTextName, string genericLang, string specificLang)

Parameters

schemaNS string

altTextName string

genericLang string

specificLang string

Returns

XMPProperty

GetObjectName()

public virtual string GetObjectName()

Returns

string

GetPacketHeader()

Returns the unparsed content of the <?xpacket> processing instruction. This contains normally the attribute-like elements 'begin="<BOM>" id="W5M0MpCehiHzreSzNTczkc9d"' and possibly the deprecated elements 'bytes="1234"' or 'encoding="XXX"'. If the parsed packet has not been wrapped into an xpacket, null is returned.

public virtual string GetPacketHeader()

Returns

string

GetProperty(string, string)

public virtual XMPProperty GetProperty(string schemaNS, string propName)

Parameters

schemaNS string

propName string

Returns

XMPProperty

GetProperty(string, string, int)

Returns a property, but the result value can be requested.

protected virtual XMPProperty GetProperty(string schemaNS, string propName, int valueType)

Parameters

schemaNS string

a schema namespace

propName string

a property name or path

valueType int

the type of the value, see VALUE_...

Returns

XMPProperty

Returns an

XMPProperty

Remarks

Returns a property, but the result value can be requested. It can be one of iText.Kernel.XMP.Impl.XMPMetaImpl.VALUE_STRING , iText.Kernel.XMP.Impl.XMPMetaImpl.VALUE_BOOLEAN , iText.Kernel.XMP.Impl.XMPMetaImpl.VALUE_INTEGER , iText.Kernel.XMP.Impl.XMPMetaImpl.VALUE_LONG , iText.Kernel.XMP.Impl.XMPMetaImpl.VALUE_DOUBLE , iText.Kernel.XMP.Impl.XMPMetaImpl.VALUE_DATE , iText.Kernel.XMP.Impl.XMPMetaImpl.VALUE_CALENDAR , iText.Kernel.XMP.Impl.XMPMetaImpl.VALUE_BASE64 .

Exceptions

XMPException

Collects any exception that occurs.

See Also

GetProperty(string, string)

GetPropertyBase64(string, string)

public virtual byte[] GetPropertyBase64(string schemaNS, string propName)

Parameters

schemaNS string

propName string

Returns

byte[]

GetPropertyBoolean(string, string)

public virtual bool? GetPropertyBoolean(string schemaNS, string propName)

Parameters

schemaNS string

propName string

Returns

bool?

GetPropertyCalendar(string, string)

public virtual DateTime GetPropertyCalendar(string schemaNS, string propName)

Parameters

schemaNS string

propName string

Returns

DateTime

GetPropertyDate(string, string)

public virtual XMPDateTime GetPropertyDate(string schemaNS, string propName)

Parameters

schemaNS string

propName string

Returns

XMPDateTime

GetPropertyDouble(string, string)

public virtual double? GetPropertyDouble(string schemaNS, string propName)

Parameters

schemaNS string

propName string

Returns

double?

GetPropertyInteger(string, string)

public virtual int? GetPropertyInteger(string schemaNS, string propName)

Parameters

schemaNS string

propName string

Returns

int?

GetPropertyLong(string, string)

public virtual long? GetPropertyLong(string schemaNS, string propName)

Parameters

schemaNS string

propName string

Returns

long?

GetPropertyObject(string, string, int)

Returns a property, but the result value can be requested.

protected virtual object GetPropertyObject(string schemaNS, string propName, int valueType)

Parameters

schemaNS string

a schema namespace

propName string

a property name or path

valueType int

the type of the value, see VALUE_...

Returns

object

Returns the node value as an object according to the

valueType

.

Exceptions

XMPException

Collects any exception that occurs.

See Also

GetProperty(string, string)

GetPropertyString(string, string)

public virtual string GetPropertyString(string schemaNS, string propName)

Parameters

schemaNS string

propName string

Returns

string

GetQualifier(string, string, string, string)

public virtual XMPProperty GetQualifier(string schemaNS, string propName, string qualNS, string qualName)

Parameters

schemaNS string

propName string

qualNS string

qualName string

Returns

XMPProperty

GetRoot()

public virtual XMPNode GetRoot()

Returns

XMPNode

Returns the root node of the XMP tree.

GetStructField(string, string, string, string)

public virtual XMPProperty GetStructField(string schemaNS, string structName, string fieldNS, string fieldName)

Parameters

schemaNS string

structName string

fieldNS string

fieldName string

Returns

XMPProperty

InsertArrayItem(string, string, int, string)

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

Parameters

schemaNS string

arrayName string

itemIndex int

itemValue string

InsertArrayItem(string, string, int, string, PropertyOptions)

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

Parameters

schemaNS string

arrayName string

itemIndex int

itemValue string

options PropertyOptions

Iterator()

public virtual XMPIterator Iterator()

Returns

XMPIterator

Iterator(string, string, IteratorOptions)

public virtual XMPIterator Iterator(string schemaNS, string propName, IteratorOptions options)

Parameters

schemaNS string

propName string

options IteratorOptions

Returns

XMPIterator

Iterator(IteratorOptions)

public virtual XMPIterator Iterator(IteratorOptions options)

Parameters

options IteratorOptions

Returns

XMPIterator

Normalize(ParseOptions)

public virtual void Normalize(ParseOptions options)

Parameters

options ParseOptions

SetArrayItem(string, string, int, string)

public virtual void SetArrayItem(string schemaNS, string arrayName, int itemIndex, string itemValue)

Parameters

schemaNS string

arrayName string

itemIndex int

itemValue string

SetArrayItem(string, string, int, string, PropertyOptions)

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

Parameters

schemaNS string

arrayName string

itemIndex int

itemValue string

options PropertyOptions

SetLocalizedText(string, string, string, string, string)

public virtual void SetLocalizedText(string schemaNS, string altTextName, string genericLang, string specificLang, string itemValue)

Parameters

schemaNS string

altTextName string

genericLang string

specificLang string

itemValue string

SetLocalizedText(string, string, string, string, string, PropertyOptions)

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

Parameters

schemaNS string

altTextName string

genericLang string

specificLang string

itemValue string

options PropertyOptions

SetObjectName(string)

Sets the name of the XMP object.

public virtual void SetObjectName(string name)

Parameters

name string

SetPacketHeader(string)

Sets the packetHeader attributes, only used by the parser.

public virtual void SetPacketHeader(string packetHeader)

Parameters

packetHeader string

the processing instruction content

SetProperty(string, string, object)

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

Parameters

schemaNS string

propName string

propValue object

SetProperty(string, string, object, PropertyOptions)

public virtual void SetProperty(string schemaNS, string propName, object propValue, PropertyOptions options)

Parameters

schemaNS string

propName string

propValue object

options PropertyOptions

SetPropertyBase64(string, string, byte[])

public virtual void SetPropertyBase64(string schemaNS, string propName, byte[] propValue)

Parameters

schemaNS string

propName string

propValue byte[]

SetPropertyBase64(string, string, byte[], PropertyOptions)

public virtual void SetPropertyBase64(string schemaNS, string propName, byte[] propValue, PropertyOptions options)

Parameters

schemaNS string

propName string

propValue byte[]

options PropertyOptions

SetPropertyBoolean(string, string, bool)

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

Parameters

schemaNS string

propName string

propValue bool

SetPropertyBoolean(string, string, bool, PropertyOptions)

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

Parameters

schemaNS string

propName string

propValue bool

options PropertyOptions

SetPropertyCalendar(string, string, DateTime)

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

Parameters

schemaNS string

propName string

propValue DateTime

SetPropertyCalendar(string, string, DateTime, PropertyOptions)

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

Parameters

schemaNS string

propName string

propValue DateTime

options PropertyOptions

SetPropertyDate(string, string, XMPDateTime)

public virtual void SetPropertyDate(string schemaNS, string propName, XMPDateTime propValue)

Parameters

schemaNS string

propName string

propValue XMPDateTime

SetPropertyDate(string, string, XMPDateTime, PropertyOptions)

public virtual void SetPropertyDate(string schemaNS, string propName, XMPDateTime propValue, PropertyOptions options)

Parameters

schemaNS string

propName string

propValue XMPDateTime

options PropertyOptions

SetPropertyDouble(string, string, double)

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

Parameters

schemaNS string

propName string

propValue double

SetPropertyDouble(string, string, double, PropertyOptions)

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

Parameters

schemaNS string

propName string

propValue double

options PropertyOptions

SetPropertyInteger(string, string, int)

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

Parameters

schemaNS string

propName string

propValue int

SetPropertyInteger(string, string, int, PropertyOptions)

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

Parameters

schemaNS string

propName string

propValue int

options PropertyOptions

SetPropertyLong(string, string, long)

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

Parameters

schemaNS string

propName string

propValue long

SetPropertyLong(string, string, long, PropertyOptions)

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

Parameters

schemaNS string

propName string

propValue long

options PropertyOptions

SetQualifier(string, string, string, string, string)

public virtual void SetQualifier(string schemaNS, string propName, string qualNS, string qualName, string qualValue)

Parameters

schemaNS string

propName string

qualNS string

qualName string

qualValue string

SetQualifier(string, string, string, string, string, PropertyOptions)

public virtual void SetQualifier(string schemaNS, string propName, string qualNS, string qualName, string qualValue, PropertyOptions options)

Parameters

schemaNS string

propName string

qualNS string

qualName string

qualValue string

options PropertyOptions

SetStructField(string, string, string, string, string)

public virtual void SetStructField(string schemaNS, string structName, string fieldNS, string fieldName, string fieldValue)

Parameters

schemaNS string

structName string

fieldNS string

fieldName string

fieldValue string

SetStructField(string, string, string, string, string, PropertyOptions)

public virtual void SetStructField(string schemaNS, string structName, string fieldNS, string fieldName, string fieldValue, PropertyOptions options)

Parameters

schemaNS string

structName string

fieldNS string

fieldName string

fieldValue string

options PropertyOptions

Sort()

public virtual void Sort()