Class EmbedFileStream
Struct for storing Stream of embedding file with configuration
Inheritance
System.Object
EmbedFileStream
Assembly: IronPdf.dll
Syntax
public sealed class EmbedFileStream : ValueType
PDF generation in IronPDF is handled through EmbedFileStream. It represents struct for storing Stream of embedding file with configuration.
EmbedFileStream 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 EmbedFileStream, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include EmbedFileConfiguration, FileStream. 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 EmbedFileStream from the relevant entry point in the IronPDF API
void Configure(EmbedFileStream 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 EmbedFileStream directly. EmbedFileStream instances inherit additional members from ValueType that may be relevant in advanced scenarios. In application code, treat EmbedFileStream 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 EmbedFileStream property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of EmbedFileStream. Application code typically obtains or instantiates a single EmbedFileStream and shares it across multiple IronPDF operations rather than recreating it per call.
Constructors
EmbedFileStream(Stream, EmbedFileConfiguration)
Struct for storing Stream of embedding file with configuration
Declaration
public EmbedFileStream(Stream FileStream, EmbedFileConfiguration EmbedFileConfiguration)
Parameters
| Type |
Name |
Description |
| System.IO.Stream |
FileStream |
Stream of embedding file
|
| EmbedFileConfiguration |
EmbedFileConfiguration |
configuration of embedding file
|
Properties
EmbedFileConfiguration
configuration of embedding file
Declaration
public EmbedFileConfiguration EmbedFileConfiguration { get; set; }
Property Value
FileStream
Declaration
public Stream FileStream { get; set; }
Property Value
| Type |
Description |
| System.IO.Stream |
|
Methods
Deconstruct(out Stream, out EmbedFileConfiguration)
Declaration
public void Deconstruct(out Stream FileStream, out EmbedFileConfiguration EmbedFileConfiguration)
Parameters
Equals(EmbedFileStream)
Declaration
public bool Equals(EmbedFileStream other)
Parameters
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(EmbedFileStream, EmbedFileStream)
Declaration
public static bool operator ==(EmbedFileStream left, EmbedFileStream right)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Inequality(EmbedFileStream, EmbedFileStream)
Declaration
public static bool operator !=(EmbedFileStream left, EmbedFileStream right)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Implements
System.IEquatable<>