Class PdfCustomMetadataProperties

Class that represents set of custom metadata properties

Inheritance
System.Object
PdfCustomMetadataProperties
Namespace: IronPdf.MetaData
Assembly: IronPdf.dll
Syntax
public class PdfCustomMetadataProperties : Object

PdfCustomMetadataProperties is what IronPDF C# code uses for PDF metadata. It represents class that represents set of custom metadata properties.

PdfCustomMetadataProperties matters when an application needs to configure or invoke PDF metadata from C# code. The class encapsulates the related options and behavior in a single object that is set up once and reused across render or processing calls. Typical scenarios include batch generation pipelines, templated document workflows, and integration with existing C# document services.

To use PdfCustomMetadataProperties, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include Item[String]. Assign options or invoke methods on the instance to configure or perform the operation. The custom hyphenation covers typical usage in C# end to end.

using IronPdf;

// Obtain PdfCustomMetadataProperties from the relevant entry point in the IronPDF API
void Configure(PdfCustomMetadataProperties instance)
{
    var current = instance.Item[String];
    instance.Add();
}

For the broader workflow, see the custom logging guide in the IronPDF C# documentation. For broader context, the PDF metadata portion of the IronPDF C# API contains related types that work with PdfCustomMetadataProperties directly. PdfCustomMetadataProperties exposes additional members beyond those highlighted above; the reference tables on this page list the full set. In application code, treat PdfCustomMetadataProperties as a configured object that is constructed once and reused across operations rather than instantiated per call. Configuration is generally idempotent: assigning the same property value twice has the same effect as assigning it once. For diagnostic purposes, inspect the relevant PdfCustomMetadataProperties property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of PdfCustomMetadataProperties. Application code typically obtains or instantiates a single PdfCustomMetadataProperties and shares it across multiple IronPDF operations rather than recreating it per call.

Properties

Item[String]

Gets or sets element value with the specified key.

Declaration
public string this[string key] { get; set; }
Parameters
Type Name Description
System.String key

The key of the element.
Property Value
Type Description
System.String

Methods

Add(String, String)

Method for adding property with the specified name and value.

You can convert value of any type to the string and store it in custom properties.

Declaration
public void Add(string name, string value)
Parameters
Type Name Description
System.String name

The name of the custom PDF MetaData Property.
System.String value

The value of the custom PDF MetaData Property as a String.

Remove(String)

Method for removing property by its name.

Declaration
public bool Remove(string name)
Parameters
Type Name Description
System.String name

The name of the property.
Returns
Type Description
System.Boolean

true if property was removed, otherwise false.