PdfDocument.CustomProperties Property

Provides access to the document’s custom properties.

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

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

VB.NET

Public ReadOnly Property CustomProperties As IDictionary(Of String, String)

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:

C#

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"] = "[e-mail]";

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

VB.NET

Private Shared Sub ModifyCustomProperties(ByVal document As PdfDocument)

    'Add new property
    document.CustomProperties.Add("NumberOfCopies", "3")

    'Modify the CompanyEmail property value:
    If document.CustomProperties.ContainsKey("CompanyEmail") Then document.CustomProperties("CompanyEmail") = "[e-mail]"

    'Remove the HasImages property:
    document.CustomProperties.Remove("HasImages")
End Sub

Related GitHub Examples

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.

C#

pdf-document-api-custom-properties/CS/pdf-custom-properties/Program.cs#L31

if (document.CustomProperties.ContainsKey("CompanyEmail"))
    document.CustomProperties["CompanyEmail"] = "[e-mail]";

VB.NET

pdf-document-api-custom-properties/VB/pdf-custom-properties/Program.vb#L26

If document.CustomProperties.ContainsKey("CompanyEmail") Then
    document.CustomProperties("CompanyEmail") = "[e-mail]"
End If