Search Results for

    Show / Hide Table of Contents

    Class EmbeddedResourceLoader

    Provides functionality to load embedded resources from the assembly.

    Inheritance
    System.Object
    EmbeddedResourceLoader
    Namespace: IronOcr.Utils
    Assembly: IronOcr.dll
    Syntax
    public class EmbeddedResourceLoader : Object

    Reading a file embedded in an assembly back as a stream runs through EmbeddedResourceLoader. It resolves a named embedded resource and hands you a System.IO.Stream, wrapping the usual reflection boilerplate of locating and opening a resource compiled into a .dll.

    The work is done by a single static method, so you call it without constructing the loader: EmbeddedResourceLoader.LoadResource(string resourceName) takes the resource name and returns an open Stream you can read from. This is an internal utility IronOCR uses to load its own bundled assets, surfaced for code that follows the same pattern, such as loading a packaged language file or template from your own assembly.

    Because the method returns a Stream, dispose it when you are finished, ideally with a using. The resource name follows the .NET embedded-resource convention (the default namespace plus the folder path and file name), so pass the fully qualified name that matches how the file was embedded. If the name does not match, no stream is returned, so verify the resource name against the assembly's manifest.

    The advanced installation guide covers how IronOCR packages its native and resource files, and the custom language how-to shows loading language assets.

    Constructors

    EmbeddedResourceLoader()

    Declaration
    public EmbeddedResourceLoader()

    Methods

    LoadResource(String)

    Loads an embedded resource as a System.IO.Stream.

    Declaration
    public static Stream LoadResource(string resourceName)
    Parameters
    Type Name Description
    System.String resourceName

    The name of the embedded resource.

    Returns
    Type Description
    System.IO.Stream

    A System.IO.Stream representing the embedded resource.

    Exceptions
    Type Condition
    IronOcrProductException

    Thrown when the specified resource cannot be found.

    ☀
    ☾
    Downloads
    • Download with Nuget
    • Start for Free
    In This Article
    Back to top
    Install with Nuget