Working with Metadata (XMP)
23 Jul 202624 minutes to read
Metadata is data that describes the characteristics or properties of a document. It includes document information properties such as author, modification date, and copyright status, as well as structured XMP packets that conform to the Extensible Metadata Platform (XMP) specification. PDF readers and search engines use this metadata to index, classify, and display information about a document.
Syncfusion® PDF provides comprehensive support for reading and writing both document information properties and XMP metadata, including the standard XMP schemas and custom user-defined schemas.
Working with document information
Document information, also called the Document Information Dictionary, is a simpler set of metadata properties stored in the PDF file that is used by Acrobat and other PDF readers to display information about a document. The PdfDocumentInformation class exposes the following commonly used properties.
The following code example shows how to set the basic document information properties.
using System;
using Syncfusion.Pdf;
//Create a PDF document.
PdfDocument pdfDoc = new PdfDocument();
pdfDoc.Pages.Add();
//Set the document information.
pdfDoc.DocumentInformation.Author = "Syncfusion";
pdfDoc.DocumentInformation.Title = "Working with PDF Metadata";
pdfDoc.DocumentInformation.Subject = "PDF metadata overview";
pdfDoc.DocumentInformation.Keywords = "PDF, metadata, XMP";
pdfDoc.DocumentInformation.Creator = "Syncfusion .NET PDF library";
pdfDoc.DocumentInformation.Producer = "Syncfusion .NET PDF library";
pdfDoc.DocumentInformation.CreationDate = DateTime.Now;
pdfDoc.DocumentInformation.ModificationDate = DateTime.Now;
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using System;
using Syncfusion.Pdf;
//Create a PDF document.
PdfDocument pdfDoc = new PdfDocument();
pdfDoc.Pages.Add();
//Set the document information.
pdfDoc.DocumentInformation.Author = "Syncfusion";
pdfDoc.DocumentInformation.Title = "Working with PDF Metadata";
pdfDoc.DocumentInformation.Subject = "PDF metadata overview";
pdfDoc.DocumentInformation.Keywords = "PDF, metadata, XMP";
pdfDoc.DocumentInformation.Creator = "Syncfusion .NET PDF library";
pdfDoc.DocumentInformation.Producer = "Syncfusion .NET PDF library";
pdfDoc.DocumentInformation.CreationDate = DateTime.Now;
pdfDoc.DocumentInformation.ModificationDate = DateTime.Now;
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);Imports System
Imports Syncfusion.Pdf
'Create a PDF document.
Dim pdfDoc As New PdfDocument()
pdfDoc.Pages.Add()
'Set the document information.
pdfDoc.DocumentInformation.Author = "Syncfusion"
pdfDoc.DocumentInformation.Title = "Working with PDF Metadata"
pdfDoc.DocumentInformation.Subject = "PDF metadata overview"
pdfDoc.DocumentInformation.Keywords = "PDF, metadata, XMP"
pdfDoc.DocumentInformation.Creator = "Syncfusion .NET PDF library"
pdfDoc.DocumentInformation.Producer = "Syncfusion .NET PDF library"
pdfDoc.DocumentInformation.CreationDate = DateTime.Now
pdfDoc.DocumentInformation.ModificationDate = DateTime.Now
'Save and close the document.
pdfDoc.Save("Output.pdf")
pdfDoc.Close(True)Adding XMP metadata in a new PDF document
You can add XMP metadata in a PDF document using the XmpMetadata class, which is exposed through the XmpMetadata property of the PdfDocumentInformation class. The following code example shows how to populate the XMP basic schema.
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a PDF document.
PdfDocument pdfDoc = new PdfDocument();
//Add a page.
pdfDoc.Pages.Add();
//Get the XMP object.
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//Access the XMP Basic Schema.
BasicSchema basic = metaData.BasicSchema;
//Set the basic details of the document.
basic.Advisory.Add("advisory");
basic.BaseURL = new Uri("http://google.com");
basic.CreateDate = DateTime.Now;
basic.CreatorTool = "creator tool";
basic.Identifier.Add("identifier");
basic.Label = "label";
basic.MetadataDate = DateTime.Now;
basic.ModifyDate = DateTime.Now;
basic.Nickname = "nickname";
basic.Rating.Add(-25);
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a PDF document.
PdfDocument pdfDoc = new PdfDocument();
//Add a page.
pdfDoc.Pages.Add();
//Get the XMP object.
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//Access the XMP Basic Schema.
BasicSchema basic = metaData.BasicSchema;
//Set the basic details of the document.
basic.Advisory.Add("advisory");
basic.BaseURL = new Uri("http://google.com");
basic.CreateDate = DateTime.Now;
basic.CreatorTool = "creator tool";
basic.Identifier.Add("identifier");
basic.Label = "label";
basic.MetadataDate = DateTime.Now;
basic.ModifyDate = DateTime.Now;
basic.Nickname = "nickname";
basic.Rating.Add(-25);
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Create a PDF document.
Dim pdfDoc As New PdfDocument()
'Add a page.
pdfDoc.Pages.Add()
'Get the XMP object.
Dim metaData As XmpMetadata = pdfDoc.DocumentInformation.XmpMetadata
'Access the XMP Basic Schema.
Dim basic As BasicSchema = metaData.BasicSchema
'Set the basic details of the document.
basic.Advisory.Add("advisory")
basic.BaseURL = New Uri("http://google.com")
basic.CreateDate = DateTime.Now
basic.CreatorTool = "creator tool"
basic.Identifier.Add("identifier")
basic.Label = "label"
basic.MetadataDate = DateTime.Now
basic.ModifyDate = DateTime.Now
basic.Nickname = "nickname"
basic.Rating.Add(-25)
'Save and close the document.
pdfDoc.Save("Output.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
Adding XMP metadata in an existing PDF document
You can add XMP metadata in an existing PDF document by loading it with PdfLoadedDocument and accessing the XmpMetadata property.
The following code example shows how to add XMP basic schema to an existing PDF document.
using Syncfusion.Pdf;
using Syncfusion.Pdf.Parsing;
using Syncfusion.Pdf.Xmp;
//Load the existing PDF document.
FileStream inputStream = new FileStream("Input.pdf", FileMode.Open, FileAccess.Read);
PdfLoadedDocument pdfDoc = new PdfLoadedDocument(inputStream);
//Get the XMP object.
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//Access the XMP Basic Schema.
BasicSchema basic = metaData.BasicSchema;
//Set the basic details of the document.
basic.Advisory.Add("advisory");
basic.BaseURL = new Uri("http://google.com");
basic.CreateDate = DateTime.Now;
basic.CreatorTool = "creator tool";
basic.Identifier.Add("identifier");
basic.Label = "label";
basic.MetadataDate = DateTime.Now;
basic.ModifyDate = DateTime.Now;
basic.Nickname = "nickname";
basic.Rating.Add(-25);
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);
inputStream.Close();using Syncfusion.Pdf;
using Syncfusion.Pdf.Parsing;
using Syncfusion.Pdf.Xmp;
//Load the existing PDF document.
PdfLoadedDocument pdfDoc = new PdfLoadedDocument("Input.pdf");
//Get the XMP object.
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//Access the XMP Basic Schema.
BasicSchema basic = metaData.BasicSchema;
//Set the basic details of the document.
basic.Advisory.Add("advisory");
basic.BaseURL = new Uri("http://google.com");
basic.CreateDate = DateTime.Now;
basic.CreatorTool = "creator tool";
basic.Identifier.Add("identifier");
basic.Label = "label";
basic.MetadataDate = DateTime.Now;
basic.ModifyDate = DateTime.Now;
basic.Nickname = "nickname";
basic.Rating.Add(-25);
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Parsing
Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Load the existing PDF document.
Dim pdfDoc As New PdfLoadedDocument("Input.pdf")
'Get the XMP object.
Dim metaData As XmpMetadata = pdfDoc.DocumentInformation.XmpMetadata
'Access the XMP Basic Schema.
Dim basic As BasicSchema = metaData.BasicSchema
'Set the basic details of the document.
basic.Advisory.Add("advisory")
basic.BaseURL = New Uri("http://google.com")
basic.CreateDate = DateTime.Now
basic.CreatorTool = "creator tool"
basic.Identifier.Add("identifier")
basic.Label = "label"
basic.MetadataDate = DateTime.Now
basic.ModifyDate = DateTime.Now
basic.Nickname = "nickname"
basic.Rating.Add(-25)
'Save and close the document.
pdfDoc.Save("Output.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
Supported Schema types
XMP is provided with the following schemas:
- Basic Schema
- Dublin Core Schema
- Rights Management Schema
- Basic Job Ticket Schema
- Paged-Text Schema
- PDF Schema
Basic Schema
Basic Schema contains properties that provide basic descriptive information such as,
- Base URL
- Creation date
- Creator tool
- Label
- Modified date.
- Meta data date
- Nickname
- Rating
The BasicSchema class is used to create the basic schema properties. Refer the following code sample to create XMP basic schema in PDF document.
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a PDF document
PdfDocument pdfDoc = new PdfDocument();
//Create a page
PdfPage page = pdfDoc.Pages.Add();
//Get metaData object
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP Basic Schema
BasicSchema basic = metaData.BasicSchema;
//Set the basic details of the document
basic.Advisory.Add("advisory");
basic.BaseURL = new Uri("http://google.com");
basic.CreateDate = DateTime.Now;
basic.CreatorTool = "creator tool";
basic.Identifier.Add("identifier");
basic.Label = "label";
basic.MetadataDate = DateTime.Now;
basic.ModifyDate = DateTime.Now;
basic.Nickname = "nickname";
basic.Rating.Add(-25);
//Save and close the document
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a PDF document
PdfDocument pdfDoc = new PdfDocument();
//Create a page
PdfPage page = pdfDoc.Pages.Add();
//Get metaData object
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP Basic Schema
BasicSchema basic = metaData.BasicSchema;
//Set the basic details of the document
basic.Advisory.Add("advisory");
basic.BaseURL = new Uri("http://google.com");
basic.CreateDate = DateTime.Now;
basic.CreatorTool = "creator tool";
basic.Identifier.Add("identifier");
basic.Label = "label";
basic.MetadataDate = DateTime.Now;
basic.ModifyDate = DateTime.Now;
basic.Nickname = "nickname";
basic.Rating.Add(-25);
//Save and close the document
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Create a PDF document
Dim pdfDoc As New PdfDocument()
'Create a page
Dim page As PdfPage = pdfDoc.Pages.Add()
'Get metaData object
Dim metaData As XmpMetadata = pdfDoc.DocumentInformation.XmpMetadata
'XMP Basic Schema
Dim basic As BasicSchema = metaData.BasicSchema
'Set the basic details of the document
basic.Advisory.Add("advisory")
basic.BaseURL = New Uri("http://google.com")
basic.CreateDate = DateTime.Now
basic.CreatorTool = "creator tool"
basic.Identifier.Add("identifier")
basic.Label = "label"
basic.MetadataDate = DateTime.Now
basic.ModifyDate = DateTime.Now
basic.Nickname = "nickname"
basic.Rating.Add(-25)
'Save and close the document
pdfDoc.Save("DocumentInformation.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
Dublin Core Schema
The Dublin Core schema provides a set of commonly used properties such as:
- Contributor
- Coverage
- Creator
- Date
- Description
- Format
- Language
- Publisher
- Title
The DublinCoreSchema class is used to create the Dublin core schema properties in a PDF document.
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a new PDF document.
PdfDocument pdfDoc = new PdfDocument();
//Add a new page.
PdfPage page = pdfDoc.Pages.Add();
//Get the XMP object.
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP Dublin Core Schema.
DublinCoreSchema dublin = metaData.DublinCoreSchema;
//Set the Dublin Core Schema details of the document.
dublin.Creator.Add("Syncfusion");
dublin.Description.Add("Title", "Syncfusion .NET PDF library creator");
dublin.Title.Add("Resource name", "Documentation");
dublin.Type.Add("PDF");
dublin.Publisher.Add("Syncfusion");
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a new PDF document.
PdfDocument pdfDoc = new PdfDocument();
//Add a new page.
PdfPage page = pdfDoc.Pages.Add();
//Get the XMP object.
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP Dublin Core Schema.
DublinCoreSchema dublin = metaData.DublinCoreSchema;
//Set the Dublin Core Schema details of the document.
dublin.Creator.Add("Syncfusion");
dublin.Description.Add("Title", "Syncfusion .NET PDF library creator");
dublin.Title.Add("Resource name", "Documentation");
dublin.Type.Add("PDF");
dublin.Publisher.Add("Syncfusion");
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Create a new PDF document.
Dim pdfDoc As New PdfDocument()
'Add a new page.
Dim page As PdfPage = pdfDoc.Pages.Add()
'Get the XMP object.
Dim metaData As XmpMetadata = pdfDoc.DocumentInformation.XmpMetadata
'XMP Dublin Core Schema.
Dim dublin As DublinCoreSchema = metaData.DublinCoreSchema
'Set the Dublin Core Schema details of the document.
dublin.Creator.Add("Syncfusion")
dublin.Description.Add("Title", "Syncfusion .NET PDF library creator")
dublin.Title.Add("Resource name", "Documentation")
dublin.Type.Add("PDF")
dublin.Publisher.Add("Syncfusion")
'Save and close the document.
pdfDoc.Save("Output.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
Rights Management Schema
This schema includes properties related to rights management. These properties provide information regarding the legal restrictions associated with a resource.
- Certificate
- Marked
- Owner
- UsageTerm
- WebStatement
The RightsManagementSchema class is used to create the Rights management schema properties.
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create PDF document
PdfDocument pdfDoc = new PdfDocument();
//Add a new page
PdfPage page = pdfDoc.Pages.Add();
//Gets XMP object
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP Rights Management Schema
RightsManagementSchema rights = metaData.RightsManagementSchema;
//Set the Rights Management Schema details of the document
rights.Certificate = new Uri("http://syncfusion.com");
rights.Owner.Add("Syncfusion");
rights.Marked = true;
//Save and close the document
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create PDF document
PdfDocument pdfDoc = new PdfDocument();
//Add a new page
PdfPage page = pdfDoc.Pages.Add();
//Gets XMP object
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP Rights Management Schema
RightsManagementSchema rights = metaData.RightsManagementSchema;
//Set the Rights Management Schema details of the document
rights.Certificate = new Uri("http://syncfusion.com");
rights.Owner.Add("Syncfusion");
rights.Marked = true;
//Save and close the document
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Create PDF document
Dim pdfDoc As New PdfDocument()
'Add a new page
Dim page As PdfPage = pdfDoc.Pages.Add()
'Gets XMP object
Dim metaData As XmpMetadata = pdfDoc.DocumentInformation.XmpMetadata
'XMP Rights Management Schema
Dim rights As RightsManagementSchema = metaData.RightsManagementSchema
'Set the Rights Management Schema details of the document
rights.Certificate = New Uri("http://syncfusion.com")
rights.Owner.Add("Syncfusion")
rights.Marked = True
'Save and close the document
pdfDoc.Save("DocumentInformation.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
Basic Job Ticket Schema
This schema describes simple workflow or job information. The BasicJobTicketSchema class is used to create the Basic Job Ticket Schema properties in a PDF document. It exposes the following property:
- JobRef
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a document.
PdfDocument pdfDoc = new PdfDocument();
//Add a page.
PdfPage page = pdfDoc.Pages.Add();
//Get the XMP object.
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP Basic Job Ticket Schema.
BasicJobTicketSchema basicJob = metaData.BasicJobTicketSchema;
//Set the Basic Job Ticket Schema details of the document.
basicJob.JobRef.Add("PDF document creation");
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a document.
PdfDocument pdfDoc = new PdfDocument();
//Add a page.
PdfPage page = pdfDoc.Pages.Add();
//Get the XMP object.
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP Basic Job Ticket Schema.
BasicJobTicketSchema basicJob = metaData.BasicJobTicketSchema;
//Set the Basic Job Ticket Schema details of the document.
basicJob.JobRef.Add("PDF document creation");
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Create a document.
Dim pdfDoc As New PdfDocument()
'Add a page.
Dim page As PdfPage = pdfDoc.Pages.Add()
'Get the XMP object.
Dim metaData As XmpMetadata = pdfDoc.DocumentInformation.XmpMetadata
'XMP Basic Job Ticket Schema.
Dim basicJob As BasicJobTicketSchema = metaData.BasicJobTicketSchema
'Set the Basic Job Ticket Schema details of the document.
basicJob.JobRef.Add("PDF document creation")
'Save and close the document.
pdfDoc.Save("Output.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
Paged-Text Schema
The Paged-Text schema is used for text appearance on page in a document.
- MaxPageSize
- NPages
- Colorants
- PlateNames
The PagedTextSchema class is used for creating Paged-Text schema properties in PDF document.
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a PDF document
PdfDocument pdfDoc = new PdfDocument();
//Create a Page
PdfPage page = pdfDoc.Pages.Add();
//Gets XMP object
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP Page text Schema
PagedTextSchema pagedText = metaData.PagedTextSchema;
//Sets the Page text Schema details of the document
pagedText.MaxPageSize.Width = 500;
pagedText.MaxPageSize.Height = 750;
pagedText.NPages = 1;
pagedText.PlateNames.Add("Sample page");
//Save and close the document
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a Pdf document
PdfDocument pdfDoc = new PdfDocument();
//Create a Page
PdfPage page = pdfDoc.Pages.Add();
//Gets XMP object
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP Page text Schema
PagedTextSchema pagedText = metaData.PagedTextSchema;
//Sets the Page text Schema details of the document
pagedText.MaxPageSize.Width = 500;
pagedText.MaxPageSize.Height = 750;
pagedText.NPages = 1;
pagedText.PlateNames.Add("Sample page");
//Save and close the document
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Create a PDF document
Dim pdfDoc As New PdfDocument()
'Create a Page
Dim page As PdfPage = pdfDoc.Pages.Add()
'Gets XMP object
Dim metaData As XmpMetadata = pdfDoc.DocumentInformation.XmpMetadata
'XMP Page text Schema
Dim pagedText As PagedTextSchema = metaData.PagedTextSchema
'Sets the Page text Schema details of the document
pagedText.MaxPageSize.Width = 500
pagedText.MaxPageSize.Height = 750
pagedText.NPages = 1
pagedText.PlateNames.Add("Sample page")
'Save and close the document
pdfDoc.Save("DocumentInformation.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
PDF schema
This schema specifies the properties used with Adobe PDF documents. The PDFSchema class is used to create the PDF Schema properties in a PDF document. It exposes the following properties.
| Property | Description |
|---|---|
Producer |
The name of the tool that produced the PDF. |
PDFVersion |
The PDF version of the document. |
Keywords |
Keywords associated with the document. |
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a PDF document.
PdfDocument pdfDoc = new PdfDocument();
//Add a page.
PdfPage page = pdfDoc.Pages.Add();
//Get the XMP object.
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP PDF Schema.
PDFSchema pdfSchema = metaData.PDFSchema;
//Set the PDF Schema details of the document.
pdfSchema.Producer = "Syncfusion";
pdfSchema.PDFVersion = "1.5";
pdfSchema.Keywords = "Syncfusion .NET PDF library";
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create a PDF document.
PdfDocument pdfDoc = new PdfDocument();
//Add a page.
PdfPage page = pdfDoc.Pages.Add();
//Get the XMP object.
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//XMP PDF Schema.
PDFSchema pdfSchema = metaData.PDFSchema;
//Set the PDF Schema details of the document.
pdfSchema.Producer = "Syncfusion";
pdfSchema.PDFVersion = "1.5";
pdfSchema.Keywords = "Syncfusion .NET PDF library";
//Save and close the document.
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Create a PDF document.
Dim pdfDoc As New PdfDocument()
'Add a page.
Dim page As PdfPage = pdfDoc.Pages.Add()
'Get the XMP object.
Dim metaData As XmpMetadata = pdfDoc.DocumentInformation.XmpMetadata
'XMP PDF Schema.
Dim pdfSchema As PDFSchema = metaData.PDFSchema
'Set the PDF Schema details of the document.
pdfSchema.Producer = "Syncfusion"
pdfSchema.PDFVersion = "1.5"
pdfSchema.Keywords = "Syncfusion .NET PDF library"
'Save and close the document.
pdfDoc.Save("Output.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
Custom Schema
A custom schema defines the structure of the customized information records. You can use the CustomSchema class to:
- Define custom metadata files and,
- Add them to the PDF document
Add the following code sample to define the custom schema in a PDF document.
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create PDF document
PdfDocument pdfDoc = new PdfDocument();
//Add a new page
PdfPage page = pdfDoc.Pages.Add();
//Get metaData object
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//Create custom schema field
CustomSchema customSchema = new CustomSchema(metaData, "custom", "http://www.syncfusion.com");
customSchema["creationDate"] = DateTime.Now.ToString();
customSchema["DOCID"] = "SYNCSAM001";
customSchema["Encryption"] = "Standard";
customSchema["Project"] = "Data processing";
//Save and close the document
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create Pdf document
PdfDocument pdfDoc = new PdfDocument();
//Add a new page
PdfPage page = pdfDoc.Pages.Add();
//Get metaData object
XmpMetadata metaData = pdfDoc.DocumentInformation.XmpMetadata;
//Create custom schema field
CustomSchema customSchema = new CustomSchema(metaData, "custom", "http://www.syncfusion.com");
customSchema["Author"] = "Syncfusion";
customSchema["creationDate"] = DateTime.Now.ToString();
customSchema["DOCID"] = "SYNCSAM001";
customSchema["Encryption"] = "Standard";
customSchema["Project"] = "Data processing";
//Save and close the document
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Create PDF document
Dim pdfDoc As New PdfDocument()
'Add a new page
Dim page As PdfPage = pdfDoc.Pages.Add()
'Get metaData object
Dim metaData As XmpMetadata = pdfDoc.DocumentInformation.XmpMetadata
'Create custom schema field
Dim customSchema As New CustomSchema(metaData, "custom", "http://www.syncfusion.com")
customSchema("Author") = "Syncfusion"
customSchema("creationDate") = DateTime.Now.ToString()
customSchema("DOCID") = "SYNCSAM001"
customSchema("Encryption") = "Standard"
customSchema("Project") = "Data processing"
'Save and close the document
pdfDoc.Save("DocumentInformation.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
Adding a custom schema to the PDF document
Syncfusion® PDF allows you to add required metadata (custom schema) to a PDF document using the CustomSchema class with the XmpMetadata class. The following code example demonstrates how to create a custom schema by initializing a new XmpMetadata instance from the existing XML data.
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create PDF document
PdfDocument pdfDoc = new PdfDocument();
//Add a new page
PdfPage page = pdfDoc.Pages.Add();
//Create XML Document container
XmpMetadata metaData = new XmpMetadata(pdfDoc.DocumentInformation.XmpMetadata.XmlData);
//Create custom schema
CustomSchema customSchema = new CustomSchema(metaData, "custom", "http://www.syncfusion.com");
customSchema["Author"] = "Syncfusion";
customSchema["creationDate"] = DateTime.Now.ToString();
customSchema["DOCID"] = "SYNCSAM001";
//Save and close the document
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create PDF document
PdfDocument pdfDoc = new PdfDocument();
//Add a new page
PdfPage page = pdfDoc.Pages.Add();
//Create XML Document container
XmpMetadata metaData = new XmpMetadata(pdfDoc.DocumentInformation.XmpMetadata.XmlData);
//Create custom schema
CustomSchema customSchema = new CustomSchema(metaData, "custom", "http://www.syncfusion.com");
customSchema["Author"] = "Syncfusion";
customSchema["creationDate"] = DateTime.Now.ToString();
customSchema["DOCID"] = "SYNCSAM001";
//Save and close the document
pdfDoc.Save("CustomMetaField.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Create PDF document
Dim pdfDoc As New PdfDocument()
'Add a new page
Dim page As PdfPage = pdfDoc.Pages.Add()
'Create XML Document container
Dim metaData As New XmpMetadata(pdfDoc.DocumentInformation.XmpMetadata.XmlData)
'Create custom schema
Dim customSchema As New CustomSchema(metaData, "custom", "http://www.syncfusion.com")
customSchema("Author") = "Syncfusion"
customSchema("creationDate") = DateTime.Now.ToString()
customSchema("DOCID") = "SYNCSAM001"
'Save and close the document
pdfDoc.Save("CustomMetaField.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
Adding Custom Metadata to the PDF document
The custom metadata can be added in PDF document by using the CustomMetadata property in PdfDocumentInformation class. Please refer to the following code.
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create PDF document
PdfDocument pdfDoc = new PdfDocument();
//Add new PDF page
PdfPage page = pdfDoc.Pages.Add();
//Add Custom MetaData
pdfDoc.DocumentInformation.CustomMetadata["ID"] = "IO1";
pdfDoc.DocumentInformation.CustomMetadata["CompanyName"] = "Syncfusion";
pdfDoc.DocumentInformation.CustomMetadata["Key"] = "DocumentKey";
//Save and close the document
pdfDoc.Save("Output.pdf");
pdfDoc.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
//Create PDF document
PdfDocument pdfDoc = new PdfDocument();
//Add new PDF page
PdfPage page = pdfDoc.Pages.Add();
//Add Custom MetaData
pdfDoc.DocumentInformation.CustomMetadata["ID"] = "IO1";
pdfDoc.DocumentInformation.CustomMetadata["CompanyName"] = "Syncfusion";
pdfDoc.DocumentInformation.CustomMetadata["Key"] = "DocumentKey";
//Save and close the document
pdfDoc.Save("AddCustomField.pdf");
pdfDoc.Close(true);Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Create PDF document
Dim pdfDoc As New PdfDocument()
'Add new PDF page
Dim page As PdfPage = pdfDoc.Pages.Add()
'Add Custom MetaData
pdfDoc.DocumentInformation.CustomMetadata("ID") = "IO1"
pdfDoc.DocumentInformation.CustomMetadata("CompanyName") = "Syncfusion"
pdfDoc.DocumentInformation.CustomMetadata("Key") = "DocumentKey"
'Save and close the document
pdfDoc.Save("AddCustomField.pdf")
pdfDoc.Close(True)You can download a complete working sample from GitHub.
Removing Custom Metadata from an existing PDF document
Removing the custom metadata from an existing PDF document using the Remove method in CustomMetadata class.
using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
using Syncfusion.Pdf.Parsing;
//Load the PDF document
PdfLoadedDocument loadedDocument = new PdfLoadedDocument("Input.pdf");
//Remove custom metadata using key name
loadedDocument.DocumentInformation.CustomMetadata.Remove("Key");
//Save and close the document
loadedDocument.Save("Output.pdf");
loadedDocument.Close(true);using Syncfusion.Pdf;
using Syncfusion.Pdf.Xmp;
using Syncfusion.Pdf.Parsing;
//Load the document
PdfLoadedDocument loadedDocument = new PdfLoadedDocument("Input.pdf");
//Remove custom metadata using key name
loadedDocument.DocumentInformation.CustomMetadata.Remove("Key");
//Save and close the document
loadedDocument.Save("Output.pdf");
loadedDocument.Close(true);Imports Syncfusion.Pdf.Parsing
Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Load the document
Dim loadedDocument As PdfLoadedDocument = New PdfLoadedDocument("Input.pdf")
'Remove custom metadata using key name
loadedDocument.DocumentInformation.CustomMetadata.Remove("Key")
'Save and close the document
loadedDocument.Save("Output.pdf")
loadedDocument.Close(True)You can download a complete working sample from GitHub.
Working with image metadata
Image metadata is a data that describes the characteristics or properties of an image which is embedded in the image file.
Adding XMP metadata along with an image in a PDF document
You can add the XMP metadata along with an image to the PDF document. The PdfBitmap class is used to load the image files and draw an images through the DrawImage method of the PdfGraphics class.
using Syncfusion.Pdf.Graphics;
using Syncfusion.Pdf;
using System.Reflection.Metadata;
//Create a new PDF document
PdfDocument doc = new PdfDocument();
//Add a page to the document
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page
PdfGraphics graphics = page.Graphics;
//Load the image as stream which contains XMP metadata
FileStream imageStream = new FileStream("Autumn Leaves.jpg", FileMode.Open, FileAccess.Read);
PdfBitmap image = new PdfBitmap(imageStream, true);
//Draw the image
graphics.DrawImage(image, 0, 0);
//Save the document
doc.Save("Output.pdf");
//Close the document
doc.Close(true);using Syncfusion.Pdf.Graphics;
using Syncfusion.Pdf;
using System.Reflection.Metadata;
//Create a new PDF document
PdfDocument doc = new PdfDocument();
//Add a page to the document
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page
PdfGraphics graphics = page.Graphics;
//Load the image file from the disk which contains XMP metadata
PdfBitmap image = new PdfBitmap("Autumn Leaves.jpg", true);
//Draw the image
graphics.DrawImage(image, 0, 0);
//Save the document
doc.Save("Output.pdf");
//Close the document
doc.Close(true);Imports Syncfusion.Pdf
Imports Syncfusion.Pdf.Graphics
Imports System.Reflection.Metadata
'Create a new PDF document
Dim doc As New PdfDocument()
'Add a page to the document
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page
Dim graphics As PdfGraphics = page.Graphics
'Load the image file from the disk which contains XMP metadata
Dim image As New PdfBitmap("Autumn Leaves.jpg", True)
'Draw the image
graphics.DrawImage(image, 0, 0)
'Save the document
doc.Save("Output.pdf")
'Close the document
doc.Close(True)You can download a complete working sample from GitHub.
Extracting XMP metadata from PDF image
To extract the XmpMetadata from an image in an existing PDF document, you can use the ImagesInfo property in the PdfPageBase class.
Refer to the following code example to extract the image metadata from a PDF image.
using Syncfusion.Pdf.Parsing;
using Syncfusion.Pdf.Xmp;
using Syncfusion.Pdf;
//Load the PDF document
PdfLoadedDocument loadedDocument = new PdfLoadedDocument("Input.pdf");
//Load the first page
PdfPageBase pageBase = loadedDocument.Pages[0];
//Extracts all the images info from first page
PdfImageInfo[] imagesInfo= pageBase.GetImagesInfo();
//Extracts the XMP metadata from PDF image
XmpMetadata metadata = imagesInfo[0].XmpMetadata;
//Close the document
loadedDocument.Close(true);using Syncfusion.Pdf.Parsing;
using Syncfusion.Pdf.Xmp;
using Syncfusion.Pdf;
//Load an existing PDF document
PdfLoadedDocument loadedDocument = new PdfLoadedDocument(fileName);
//Load the first page
PdfPageBase pageBase = loadedDocument.Pages[0];
//Extracts all the images info from first page
PdfImageInfo[] imagesInfo= pageBase.ImagesInfo;
//Extracts the XMP metadata from PDF image
XmpMetadata metadata = imagesInfo[0].XmpMetadata;
//Close the document
loadedDocument.Close(true);Imports Syncfusion.Pdf.Parsing
Imports Syncfusion.Pdf.Xmp
Imports Syncfusion.Pdf
'Load an existing PDF
Dim loadedDocument As New PdfLoadedDocument(fileName)
'Load the first page
Dim pageBase As PdfPageBase = loadedDocument.Pages(0)
'Extracts all the images info from first page
Dim imagesInfo As PdfImageInfo[] = pageBase.ImagesInfo
'Extracts the XMP metadata from PDF image
XmpMetadata metadata = imagesInfo[0].XmpMetadata;
'Close the document
loadedDocument.Close(True)You can download a complete working sample from GitHub.
NOTE
To extract image information from a PDF page in .NET Core, add the Syncfusion.Pdf.Imaging.Net.Core package reference to your project.