Class EmbedFilePath

Struct for storing path directory of embedding file with configuration

Inheritance
System.Object
EmbedFilePath
Implements
System.IEquatable<EmbedFilePath>
Namespace: IronPdf
Assembly: IronPdf.dll
Syntax
public sealed class EmbedFilePath : ValueType

EmbedFilePath is the object IronPDF C# code works with for PDF generation. It represents struct for storing path directory of embedding file with configuration.

EmbedFilePath 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 EmbedFilePath, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include EmbedFileConfiguration, FilePath. Assign options or invoke methods on the instance to configure or perform the operation. The HTML file to PDF covers typical usage in C# end to end.

using IronPdf;

// Obtain EmbedFilePath from the relevant entry point in the IronPDF API
void Configure(EmbedFilePath instance)
{
    var current = instance.EmbedFileConfiguration;
    instance.Deconstruct();
}

For the broader workflow, see the HTML zip file to PDF guide in the IronPDF C# documentation. For broader context, the PDF generation portion of the IronPDF C# API contains related types that work with EmbedFilePath directly. EmbedFilePath instances inherit additional members from ValueType that may be relevant in advanced scenarios. In application code, treat EmbedFilePath 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 EmbedFilePath property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of EmbedFilePath. Application code typically obtains or instantiates a single EmbedFilePath and shares it across multiple IronPDF operations rather than recreating it per call.

Constructors

EmbedFilePath(String, EmbedFileConfiguration)

Struct for storing path directory of embedding file with configuration

Declaration
public EmbedFilePath(string FilePath, EmbedFileConfiguration EmbedFileConfiguration)
Parameters
Type Name Description
System.String FilePath

Path direcotry of embedding file
EmbedFileConfiguration EmbedFileConfiguration

configuration of embedding file
Remarks

currently only support 3 types of file; .xml, .pdf, and .png

Properties

EmbedFileConfiguration

configuration of embedding file

Declaration
public EmbedFileConfiguration EmbedFileConfiguration { get; set; }
Property Value
Type Description
EmbedFileConfiguration

FilePath

Path direcotry of embedding file

Declaration
public string FilePath { get; set; }
Property Value
Type Description
System.String

Methods

Deconstruct(out String, out EmbedFileConfiguration)

Declaration
public void Deconstruct(out string FilePath, out EmbedFileConfiguration EmbedFileConfiguration)
Parameters
Type Name Description
System.String FilePath
EmbedFileConfiguration EmbedFileConfiguration

Equals(EmbedFilePath)

Declaration
public bool Equals(EmbedFilePath other)
Parameters
Type Name Description
EmbedFilePath other
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Operators

Equality(EmbedFilePath, EmbedFilePath)

Declaration
public static bool operator ==(EmbedFilePath left, EmbedFilePath right)
Parameters
Type Name Description
EmbedFilePath left
EmbedFilePath right
Returns
Type Description
System.Boolean

Inequality(EmbedFilePath, EmbedFilePath)

Declaration
public static bool operator !=(EmbedFilePath left, EmbedFilePath right)
Parameters
Type Name Description
EmbedFilePath left
EmbedFilePath right
Returns
Type Description
System.Boolean

Implements

System.IEquatable<>