Search Results for

    Show / Hide Table of Contents

    Class EmbedFileByte

    Struct for storing byte[] of embedding file with configuration

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

    Use EmbedFileByte in IronPDF when a C# application works with PDF generation. It represents struct for storing byte[] of embedding file with configuration.

    EmbedFileByte 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 EmbedFileByte, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include EmbedFileConfiguration, FileBytes. 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 EmbedFileByte from the relevant entry point in the IronPDF API
    void Configure(EmbedFileByte 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 EmbedFileByte directly. EmbedFileByte instances inherit additional members from ValueType that may be relevant in advanced scenarios. In application code, treat EmbedFileByte 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 EmbedFileByte property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of EmbedFileByte. Application code typically obtains or instantiates a single EmbedFileByte and shares it across multiple IronPDF operations rather than recreating it per call.

    Constructors

    EmbedFileByte(in Byte[], EmbedFileConfiguration)

    Struct for storing byte[] of embedding file with configuration

    Declaration
    public EmbedFileByte(in byte[] FileBytes, EmbedFileConfiguration EmbedFileConfiguration)
    Parameters
    Type Name Description
    System.Byte[] FileBytes

    byte[] 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

    FileBytes

    byte[] of embedding file

    Declaration
    public byte[] FileBytes { get; set; }
    Property Value
    Type Description
    System.Byte[]

    Methods

    Deconstruct(out Byte[], out EmbedFileConfiguration)

    Declaration
    public void Deconstruct(out byte[] FileBytes, out EmbedFileConfiguration EmbedFileConfiguration)
    Parameters
    Type Name Description
    System.Byte[] FileBytes
    EmbedFileConfiguration EmbedFileConfiguration

    Equals(EmbedFileByte)

    Declaration
    public bool Equals(EmbedFileByte other)
    Parameters
    Type Name Description
    EmbedFileByte 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(EmbedFileByte, EmbedFileByte)

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

    Inequality(EmbedFileByte, EmbedFileByte)

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

    Implements

    System.IEquatable<>
    ☀
    ☾
    Downloads
    • Download with Nuget
    • Start for Free
    In This Article
    Back to top
    Install with Nuget