Class EmbedFileConfiguration
Configuration of EmbedFilePath, EmbedFileByte, or EmbedFileStream when converting PdfDocument to PDF/A-3 document with embedding files
Specifying type of embeddding file, file name, and custom of XMP Metadata
Inheritance
Namespace: IronPdf
Assembly: IronPdf.dll
Syntax
public class EmbedFileConfiguration : Object
Use EmbedFileConfiguration in IronPDF when a C# application works with PDF generation. It represents configuration of EmbedFilePath , EmbedFileByte , or EmbedFileStream when converting PdfDocument to PDF/A-3 document with embedding files Specifying type of embeddding file, file name, and custom of XMP Metadata.
EmbedFileConfiguration matters when an application needs to configure or invoke PDF generation 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 EmbedFileConfiguration, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include AFDesc, AFRelationship, ConformanceLevel, EmbedFileName. 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 EmbedFileConfiguration from the relevant entry point in the IronPDF API
void Configure(EmbedFileConfiguration instance)
{
var current = instance.AFDesc;
}For the broader workflow, see the custom logging guide in the IronPDF C# documentation. For broader context, the PDF generation portion of the IronPDF C# API contains related types that work with EmbedFileConfiguration directly. EmbedFileConfiguration exposes additional members beyond those highlighted above; the reference tables on this page list the full set. In application code, treat EmbedFileConfiguration 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 EmbedFileConfiguration property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of EmbedFileConfiguration.
Constructors
EmbedFileConfiguration(EmbedFileType)
Initailize an instance for a constructor class EmbedFileConfiguration
Declaration
public EmbedFileConfiguration(EmbedFileType embedFileType)
Parameters
| Type | Name | Description |
|---|---|---|
| EmbedFileType | embedFileType | type of supported embedding file to PDF/A document |
Properties
AFDesc
Associated file description for embedding file
Declaration
public string AFDesc { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
Using the default description if none
AFRelationship
Relation of the associated file (embedding file) to PDF/A document
Declaration
public AFRelationship AFRelationship { get; set; }
Property Value
| Type | Description |
|---|---|
| AFRelationship |
ConformanceLevel
Conformance level of embedding XML file applying to XMP Metadata of PDF/A document
Declaration
public ConformanceLevel ConformanceLevel { get; set; }
Property Value
| Type | Description |
|---|---|
| ConformanceLevel |
Remarks
default value is ConformanceLevel.EN16931
EmbedFileName
Name of embedding file to PDF/A document
Declaration
public string EmbedFileName { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
In case of using a directory of embed file EmbedFilePath, file name is using from the directory.
EmbedFileType
Type of supported embedding file to PDF/A document
Declaration
public EmbedFileType EmbedFileType { get; }
Property Value
| Type | Description |
|---|---|
| EmbedFileType |
PropertyVersion
Property Version of embedding XML file applying to XMP Metadata of PDF/A document
Declaration
public PropertyVersion PropertyVersion { get; set; }
Property Value
| Type | Description |
|---|---|
| PropertyVersion |
Remarks
default value is PropertyVersion.v1
SchemaNamespace
PDF/A Schema NamespaceURI of embedding XML file appyling to XMP Metadata of PDF/A document
Declaration
public SchemaNamespace SchemaNamespace { get; set; }
Property Value
| Type | Description |
|---|---|
| SchemaNamespace |
Remarks
default value is SchemaNamespace.facturX
SchemaPrefix
PDF/A Schema Prefix of embedding XML file appyling to XMP Metadata of PDF/A document
Declaration
public SchemaPrefix SchemaPrefix { get; set; }
Property Value
| Type | Description |
|---|---|
| SchemaPrefix |
Remarks
defalut value is SchemaPrefix.fx