|
Properties
LastErrorHtml As String (ReadOnly)
Error information in HTML format for the last method called.
LastErrorText As String (ReadOnly)
Error information in plain-text format for the last method called.
LastErrorXml As String (ReadOnly)
Error information in XML format for the last method called.
NumEmbedded As Integer (ReadOnly)
The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.
StructInnerDescrip As Boolean
Determines whether structures are stored with rdf:parseType="Resource", or within an "rdf:Description" sub-node.
Version As String (ReadOnly)
The version, such as "1.0" of the XMP toolkit.
Methods
Function AddArray(ByVal xml As Xml, ByVal arrType As String, ByVal propName As String, ByVal values As StringArray) As Boolean
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".
Sub AddNsMapping(ByVal ns As String, ByVal uri As String)
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.
Function AddSimpleDate(ByVal xml As Xml, ByVal propName As String, ByVal propVal As Date) As Boolean
Adds or replaces an XMP date 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 "xap:CreateDate".
Function AddSimpleInt(ByVal xml As Xml, ByVal propName As String, ByVal propVal As Integer) As Boolean
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".
Function AddSimpleStr(ByVal xml As Xml, ByVal propName As String, ByVal propVal As String) As Boolean
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".
Function AddStructProp(ByVal xml As Xml, ByVal structName As String, ByVal propName As String, ByVal propVal As String) As Boolean
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".
Function Append(ByVal xml As Xml) As Boolean
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.
Function DateToString(ByVal dt As Date) As String
Converts a date to a string representation. This method is added for convenience (just in case date-to-string conversions are required).
Function GetArray(ByVal xml As Xml, ByVal propName As String) As StringArray
Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as "dc:subject".
Function GetEmbedded(ByVal index As Integer) As Xml
Returns the Nth embedded XMP document as a Chilkat XML object.
Function GetSimpleDate(ByVal xml As Xml, ByVal propName As String) As Date
Finds and returns an XMP date property. The property name should be prefixed with the namespace, such as "xap:ModifyDate".
Function GetSimpleInt(ByVal xml As Xml, ByVal propName As String) As Integer
Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as "tiff:ResolutionUnit".
Function GetSimpleStr(ByVal xml As Xml, ByVal propName As String) As String
Finds and returns an XMP simple string property. The property name should be prefixed with the namespace, such as "photoshop:Source".
Function GetStructPropNames(ByVal xml As Xml, ByVal structName As String) As StringArray
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.
Function GetStructValue(ByVal xml As Xml, ByVal structName As String, ByVal propName As String) As String
Returns the value of a single item within an XMP structure property. Property names should always be prefixed with the namespace.
Function LoadAppFile(ByVal filename As String) As Boolean
Loads a TIFF or JPG file into the XMP object.
Function LoadFromBuffer(ByVal data As Byte(), ByVal ext As String) As Boolean
Loads a JPG or TIFF from an byte buffer containing the image file data.
Function NewXmp() As Xml
Creates and returns a new/empty XMP metadata document as a Chilkat XML object.
Function RemoveAllEmbedded() As Boolean
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.
Function RemoveArray(ByVal xml As Xml, ByVal propName As String) As Boolean
Removes an XMP array property from the XMP document.
Function RemoveEmbedded(ByVal index As Integer) As Boolean
Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist the changes to disk.
Sub RemoveNsMapping(ByVal ns As String)
Removes a namespace-to-URI mapping.
Function RemoveSimple(ByVal xml As Xml, ByVal propName As String) As Boolean
Removes a simple XMP property from the XMP document.
Function RemoveStruct(ByVal xml As Xml, ByVal structName As String) As Boolean
Removes an XMP structure property from the XMP document.
Function RemoveStructProp(ByVal xml As Xml, ByVal structName As String, ByVal propName As String) As Boolean
Removes a single member from an XMP structured property.
Function SaveAppFile(ByVal filename As String) As Boolean
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.
Function SaveLastError(ByVal filename As String) As Boolean
Saves the last error information to an XML formatted file.
Function SaveToBuffer() As Byte()
Saves a JPG or TIFF image with updated XMP to a byte buffer.
Function StringToDate(ByVal str As String) As Date
Converts a string to a date value. This method is added for convenience (just in case string-to-date conversions are required).
Function UnlockComponent(ByVal b1 As String) As Boolean
Unlocks the XMP component at runtime. This must be called once at the beginning of your application. Passing an arbitrary value initiates a fully-functional 30-day trial. A permanent unlock code is required to use the component beyond 30 days.
|
