Back to Devexpress

XmpDocument.PdfProperties Property

officefileapi-devexpress-dot-pdf-dot-xmp-dot-xmpdocument-0b7f73ac.md

latest4.1 KB
Original Source

XmpDocument.PdfProperties Property

Gets properties used to define the Adobe PDF namespace.

Namespace : DevExpress.Pdf.Xmp

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

NuGet Package : DevExpress.Pdf.Core

Declaration

csharp
public AdobePdfProperties PdfProperties { get; }
vb
Public ReadOnly Property PdfProperties As AdobePdfProperties

Property Value

TypeDescription
AdobePdfProperties

An object that contains Adobe PDF namespace properties.

|

Example

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

csharp
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();

    AdobePdfProperties adobePdfProperties = metadata.PdfProperties;
    adobePdfProperties.Keywords = "Invoice, Northwind, PDF, XMP";
    adobePdfProperties.PDFVersion = "1.3";
    adobePdfProperties.Producer = "PDF Document API";
    adobePdfProperties.Trapped = false;

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

    // Save the result:
    pdfDocumentProcessor.SaveDocument("Invoice_Upd.pdf");
}
vb
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 adobePdfProperties As AdobePdfProperties = metadata.PdfProperties
    adobePdfProperties.Keywords = "Invoice, Northwind, PDF, XMP"
    adobePdfProperties.PDFVersion = "1.3"
    adobePdfProperties.Producer = "PDF Document API"
    adobePdfProperties.Trapped = False

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

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

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PdfProperties property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

pdf-document-api-xmp-example/CS/XmpMetadataExamples/Program.cs#L146

csharp
// Add items from the Adobe PDF schema:
AdobePdfProperties adobePdfProperties = metadata.PdfProperties;
adobePdfProperties.Keywords = "Invoice, Northwind, PDF, XMP";

pdf-document-api-xmp-example/VB/XmpMetadataExamples/Program.vb#L117

vb
' Add items from the Adobe PDF schema:
Dim adobePdfProperties As AdobePdfProperties = metadata.PdfProperties
adobePdfProperties.Keywords = "Invoice, Northwind, PDF, XMP"

See Also

XmpDocument Class

XmpDocument Members

DevExpress.Pdf.Xmp Namespace