Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

PdfDocument.CustomProperties Property

Provides access to the document’s custom properties.

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Core

#Declaration

public IDictionary<string, string> CustomProperties { get; }

#Property Value

Type Description
IDictionary<String, String>

A dictionary object containing custom properties.

#Remarks

Use the CustomProperties property to access and modify a document’s custom properties. The code sample below shows how to add, modify and remove custom properties from the dictionary:

private static void ModifyCustomProperties(PdfDocument document)
{
    //Add new property
    document.CustomProperties.Add("NumberOfCopies", "3");

    //Modify the CompanyEmail property value:
    if (document.CustomProperties.ContainsKey("CompanyEmail"))
        document.CustomProperties["CompanyEmail"] = "clientservices@devexpress.com";

    //Remove the HasImages property:
    document.CustomProperties.Remove("HasImages");
}

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomProperties 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.

See Also