This class represents the XMP metadata for a PDF document.

public class XmpMetadata : Resource
Public Class XmpMetadata
    Inherits Resource

Inheritance: ObjectResourceXmpMetadata

Licensing Info

This class is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:


This example shows how to create an Xmp Metadata and Add it to the document.
Imports System
Imports System.IO
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.Xmp
Module MyModule
    Sub Main()
        ' Create a PDF Document
        Dim MyDocument As Document = New Document
        MyDocument.Keywords = "XMP, metadata, pdf, example"
        MyDocument.Title = "Pdf document with xmp metadata"
        ' Add blank pages to the document
        MyDocument.Pages.Add(New Page(PageSize.Letter))
        MyDocument.Pages.Add(New Page(PageSize.Letter))
        ' Create an Xmp Metadata
        Dim MyXmp As XmpMetadata = New XmpMetadata
        ' Dublin Core Schema.
        Dim Mydc As DublinCoreSchema = MyXmp.DublinCore
        Mydc.Contributors.Add( "Abc" )
        Mydc.Contributors.Add( "Xyz" )
        Mydc.Contributors.Add( "Pqrs" )
        Mydc.Coverage = "To test all the attributes of schema's provided"
        Mydc.Creators.Add( "MyProduct" )
        Mydc.Creators.Add( "MyCompany" )
        Mydc.Date.Add( DateTime.Now )
        Mydc.Description.AddLang( "en-us", "XMP Schema's test" )
        Mydc.Identifier = "First XMP pdf"
        Mydc.Publisher.Add( "mydomain.com" )
        Mydc.Publisher.Add( "My Company" )
        Mydc.Relation.Add( "test pdf with xmp" )
        Mydc.Rights.DefaultText = "US English"
        Mydc.Rights.AddLang( "en-us", "All rights reserved 2012, MyCompany." )
        Mydc.Source = "XMP Project"
        Mydc.Subject.Add( "eXtensible Metadata Platform" )
        Mydc.Title.AddLang( "en-us", "XMP" )
        Mydc.Title.AddLang( "it-it", "XMP - Piattaforma Estendible di Metadata" )
        Mydc.Title.AddLang( "du-du", "De hallo Wereld" )
        Mydc.Title.AddLang( "fr-fr", "XMP - Une Platforme Extensible pour les Métédonnées" )
        Mydc.Title.AddLang( "DE-DE", "ÄËßÜ Hallo Welt" )
        Mydc.Type.Add( "Pdf file containing xmp metadata" )
        ' Basic Schema.
        Dim Mybs As BasicSchema  = MyXmp.BasicSchema
        Mybs.Advisory.Add( "Date" )
        Mybs.Advisory.Add( "Contributors" )
        Mybs.Nickname = "xyz"
        Mybs.Thumbnails.Add(106, 80, "JPEG", GetImage("C:\thumbnail.jpg"))
        ' Rights Management Schema.
        Dim Myrm As RightsManagementSchema = New RightsManagementSchema
        Myrm.Marked2 = CopyrightStatus.PublicDomain
        Myrm.Owner.Add( "MyCompany" )
        Myrm.UsageTerms.AddLang( "en-us", "Contact MyCompany" )
        ' Basic Job Ticket Schema.
        Dim MyJob As BasicJobTicketSchema = New BasicJobTicketSchema
        MyJob.JobRef.Add( "MyCompany", "Xmp Test", new Uri( "http://www.mydomain.com/" ) )
        MyJob.JobRef.Add( "MyCompany", "XMP Metadata", new Uri( "http://www.mydomain.com/" ) )
        ' Paged-Text Schema.
        Dim Mypt As PagedTextSchema = New PagedTextSchema
        ' Add the Xmp Metadata to the document
        MyDocument.XmpMetadata = MyXmp
        ' Save the PDF document
    End Sub
    Private Function GetImage(ByVal filePath As String) As Byte()
    	Dim MyInFile As FileStream = New FileStream(filePath, FileMode.Open, FileAccess.Read)
        Dim MyBinaryData(MyInFile.Length) As Byte
        MyInFile.Read(MyBinaryData, 0, MyInFile.Length)
        return MyBinaryData
    End Function
End Module
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.xmp;

public class Example
    public static void CreatePDF(string outputPath, string imagePath)
        // Create a PDF Document
        Document document = new Document();
        document.Keywords = "XMP, metadata, pdf, example";
        document.Title = "Pdf document with xmp metadata";

        // Add blank pages to the document
        document.Pages.Add(new Page(PageSize.Letter));
        document.Pages.Add(new Page(PageSize.Letter));

        // Create an Xmp Metadata
        XmpMetadata xmp = new XmpMetadata();

        // Dublin Core Schema.
        DublinCoreSchema dc = xmp.DublinCore;
        dc.Coverage = "To test all the attributes of schema's provided";
        dc.Description.AddLang("en-us", "XMP Schema's test");
        dc.Identifier = "First XMP pdf";
        dc.Relation.Add("test pdf with xmp");
        dc.Rights.DefaultText = "US English";
        dc.Rights.AddLang("en-us", "All rights reserved 2012, MyCompany.");
        dc.Source = "XMP Project";
        dc.Subject.Add("eXtensible Metadata Platform");
        dc.Title.AddLang("en-us", "XMP");
        dc.Title.AddLang("it-it", "XMP - Piattaforma Estendible di Metadata");
        dc.Title.AddLang("du-du", "De hallo Wereld");
        dc.Title.AddLang("fr-fr", "XMP - Une Platforme Extensible pour les Métédonnées");
        dc.Title.AddLang("DE-DE", "ÄËßÜ Hallo Welt");
        dc.Type.Add("Pdf file containing xmp metadata");

        // Basic Schema.
        BasicSchema bs = xmp.BasicSchema;
        bs.Nickname = "xyz";
        bs.Thumbnails.Add(106, 80, "JPEG", GetImage(imagePath));

        // Rights Management Schema.
        RightsManagementSchema rm = new RightsManagementSchema();
        rm.Marked2 = CopyrightStatus.PublicDomain;
        rm.UsageTerms.AddLang("en-us", "Contact MyCompany");

        // Basic Job Ticket Schema.
        BasicJobTicketSchema job = new BasicJobTicketSchema();
        job.JobRef.Add("MyCompany", "Xmp Test", new Uri("http://www.mydomain.com/"));
        job.JobRef.Add("MyCompany", "XMP Metadata", new Uri("http://www.mydomain.com/"));

        // Paged-Text Schema.
        PagedTextSchema pt = new PagedTextSchema();

        // Add the Xmp Metadata to the document
        document.XmpMetadata = xmp;

        // Save the PDF

    private static byte[] GetImage(string filePath)
        FileStream inFile = new FileStream(filePath, FileMode.Open, FileAccess.Read);
        byte[] binaryData = new byte[inFile.Length];
        inFile.Read(binaryData, 0, (int)inFile.Length);
        return binaryData;


For more details on using XMP metadata take a look at the XMP Metadata topic.


XmpMetadata()Initializes a new instance of the XmpMetadata class.


BasicSchemaGets the BasicSchema schema object.
DublinCoreGets the DublinCoreSchema schema object.
RequiredPdfObjectsGets the number of PDF objects required by the resource.
ResourceTypeGets the type of resource.
(Inherited from Resource)
UidGets the unique ID of the resource.
(Inherited from Resource)


AddSchema(XmpSchema)Adds a given Xmp Schema to the schema list.
Draw(DocumentWriter)Draws the xmp metadata to the DocumentWriter object.
Equals(Object)Determines whether the specified Object is equal to the current Object .
(Inherited from Object)
GetHashCode()Serves as a hash function for a particular type.
(Inherited from Object)
GetType()Gets the Type of the current instance.
(Inherited from Object)
ToString()Returns a String that represents the current Object .
(Inherited from Object)

See Also


In this topic