XmpProperties Class

Contains properties used to define the XMP basic namespace.

Namespace: DevExpress.Pdf.Xmp

Assembly: DevExpress.Pdf.v23.2.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public class XmpProperties

VB.NET

Public Class XmpProperties

Related API Members

The following members return XmpProperties objects:

• XmpDocument.XmpProperties

Remarks

The XMP basic namespace contains basic description information. The namespace URI is http://ns.adobe.com/xap/1.0/, the prefix is xmp.

Example

The code sample below adds items from the basic schema to the packet:

C#

using DevExpress.Pdf;
using DevExpress.Pdf.Xmp;
//...

using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
    // Load a document:
    pdfDocumentProcessor.LoadDocument("Documents//Invoice.pdf");
    PdfDocument document = pdfDocumentProcessor.Document;

    // Create a new XMP packet:
    XmpDocument metadata = new XmpDocument();

    XmpProperties basicSchema = metadata.XmpProperties;
    basicSchema.CreatorTool = "PDF Document API";
    basicSchema.Label = "Sample";
    basicSchema.Identifier.Add("Id");
    basicSchema.Rating = "0";

    // Embed metadata in the document:
    document.SetMetadata(metadata);

    // Save the result:
    pdfDocumentProcessor.SaveDocument("Invoice_Upd.pdf");
}

VB.NET

Imports DevExpress.Pdf
Imports DevExpress.Pdf.Xmp
'...

Using pdfDocumentProcessor As New PdfDocumentProcessor()
    ' Load a document:
    pdfDocumentProcessor.LoadDocument("Documents//Invoice.pdf")
    Dim document As PdfDocument = pdfDocumentProcessor.Document

    ' Create a new XMP packet:
    Dim metadata As New XmpDocument()

      Dim basicSchema As XmpProperties = metadata.XmpProperties
      basicSchema.CreatorTool = "PDF Document API"
      basicSchema.Label = "Sample"
      basicSchema.Identifier.Add("Id")
      basicSchema.Rating = "0"

    ' Embed metadata in the document:
    document.SetMetadata(metadata)

    ' Save the result:
    pdfDocumentProcessor.SaveDocument("Invoice_Upd.pdf")
End Using

Inheritance

Object

XmpProperties