Back to Devexpress

XmpDocument.CustomProperties Property

officefileapi-devexpress-dot-pdf-dot-xmp-dot-xmpdocument-018c7755.md

latest2.8 KB
Original Source

XmpDocument.CustomProperties Property

Gets properties used to define a custom schema.

Namespace : DevExpress.Pdf.Xmp

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

NuGet Package : DevExpress.Pdf.Core

Declaration

csharp
public CustomProperties CustomProperties { get; }
vb
Public ReadOnly Property CustomProperties As CustomProperties

Property Value

TypeDescription
CustomProperties

An object that contains a custom schema properties.

|

Remarks

Create a CustomProperties class object and fill it with items to create a custom schema. Assign this object to the CustomProperties property to add your schema to the packet.

Example

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

using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
    pdfDocumentProcessor.LoadDocument("Documents//Invoice.pdf");
    PdfDocument document = pdfDocumentProcessor.Document;
    XmpDocument metadata = XmpDocument.FromString(document.Metadata.Data);

    metadata.RegisterNamespace("https://www.devexpress.com/", "dx");
    CustomProperties customProperties = new CustomProperties(metadata, "https://www.devexpress.com/");
    customProperties["Team"] = "Office";
    customProperties["Checked"] = "true";
    customProperties["Project"] = "PDF Document API";

    document.SetMetadata(metadata);
    pdfDocumentProcessor.SaveDocument("Invoice_Upd.pdf");
}
vb
Imports DevExpress.Pdf
Imports DevExpress.Pdf.Xmp
'...

Using pdfDocumentProcessor As New PdfDocumentProcessor()
    pdfDocumentProcessor.LoadDocument("Documents//Invoice.pdf")
    Dim document As PdfDocument = pdfDocumentProcessor.Document
    Dim metadata As XmpDocument = XmpDocument.FromString(document.Metadata.Data)

    metadata.RegisterNamespace("https://www.devexpress.com/", "dx")
    Dim customProperties As New CustomProperties(metadata, "https://www.devexpress.com/")
    customProperties("Team") = "Office"
    customProperties("Checked") = "true"
    customProperties("Project") = "PDF Document API"

    document.SetMetadata(metadata)
    pdfDocumentProcessor.SaveDocument("Invoice_Upd.pdf")
End Using

See Also

XmpDocument Class

XmpDocument Members

DevExpress.Pdf.Xmp Namespace