XmpCustomSchema Class

Contains properties used to define the XMP custom namespace.

Namespace: DevExpress.Docs.Pdf

Assembly: DevExpress.Docs.Pdf.v26.1.dll

Declaration

C#

public sealed class XmpCustomSchema :
    IEnumerable<XmpProperty>,
    IEnumerable

VB.NET

Public NotInheritable Class XmpCustomSchema
    Implements IEnumerable(Of XmpProperty),
               IEnumerable

Related API Members

The following members return XmpCustomSchema objects:

• XmpMetadata.CustomSchema
• XmpMetadata.GetCustomSchema(String)
• XmpMetadata.GetCustomSchema(XmpPdfAExtensionDescriptor)

Example

How to Set XMP Custom Schema Properties

The following code snippet creates a custom XMP schema with the “http://www.example.com/custom/1.0/“ namespace URI and adds custom properties to this schema:

C#

using DevExpress.Docs.Pdf;
using System.IO;

using (PdfDocument pdfDocument =
    new PdfDocument(File.OpenRead(@"document_001.pdf"))) {
    XmpMetadata metadata = new XmpMetadata();
    XmpCustomSchema customSchema = metadata.CustomSchema;
    metadata.RegisterNamespace("http://www.example.com/custom/1.0/", "dx");

    customSchema["Team"] = "Office";
    customSchema["Checked"] = "true";
    customSchema["Project"] = "PDF Document API";

    // Embed metadata in the document:
    pdfDocument.Metadata.Xmp = metadata;
}

VB.NET

Imports DevExpress.Docs.Pdf
Imports System.IO

Using pdfDocument As PdfDocument =
    New PdfDocument(File.OpenRead("document_001.pdf"))
    Dim metadata As XmpMetadata = New XmpMetadata()
    Dim customSchema As XmpCustomSchema = metadata.CustomSchema
    metadata.RegisterNamespace("http://www.example.com/custom/1.0/", "dx")

    customSchema("Team") = "Office"
    customSchema("Checked") = "true"
    customSchema("Project") = "PDF Document API"

    ' Embed metadata in the document:
    pdfDocument.Metadata.Xmp = metadata
End Using

Implements

IEnumerable<XmpProperty>

IEnumerable

Inheritance

Object

XmpCustomSchema