Convert HTML to DOCX | C#

A DOCX file is a Microsoft Word document that typically contains the text but can contain a wide range of data, including tables, raster and vector graphics, video, sounds and diagrams. The DOCX file is highly editable, easy to use and manageable in size. This format is popular because of the variety of options it offers users to write any type of documents. This file format is one of the most widely used and is available through numerous programs.

Using Converter.ConvertHTML methods is the most common way to convert HTML code into various formats. With Aspose.HTML, you can convert HTML to DOCX format programmatically with full control over a wide range of conversion parameters. In this article, you find information on how to convert HTML to DOCX using ConvertHTML() methods of the Converter class, and how to apply DocSaveOptions and ICreateStreamProvider parameters.

Online HTML Converter

You can check the Aspose.HTML API functionality and convert HTML in real-time. Please load HTML from the local file system, select the output format and run the example. In the example, the save options are set by default. You will immediately receive the result as a separate file.

If you want to convert HTML to DOCX programmatically, please see the following C# code examples.

HTML to DOCX by a single line of code

The static methods of the Converter class are primarily used as the easiest way to convert an HTML code into various formats. You can convert HTML to DOCX in your C# application literally with a single line of code!

// Invoke the ConvertHTML() method to convert HTML to DOCX
Converter.ConvertHTML(@"<h1>Convert HTML to DOCX!</h1>", ".", new DocSaveOptions(), Path.Combine(OutputDir, "convert-with-single-line.docx"));

Convert HTML to DOCX

Converting a file to another format using the ConvertHTML() method is a sequence of operations among which document loading and saving:

1. Load an HTML file using the HTMLDocument class.
2. Create a new DocSaveOptions object.
3. Use the ConvertHTML() method of the Converter class to save HTML as a DOCX file. You need to pass the HTMLDocument, DocSaveOptions, and output file path to the ConvertHTML() method to convert HTML to DOCX.

Please take a look over the following C# code snippet which shows the process of converting HTML to DOCX using Aspose.HTML for .NET.

// Prepare a path to a source HTML file
string documentPath = Path.Combine(DataDir, "canvas.html");

// Prepare a path to save the converted file 
string savePath = Path.Combine(OutputDir, "canvas-output.docx");

// Initialize an HTML document from the file
using var document = new HTMLDocument(documentPath);

// Initialize DocSaveOptions 
var options = new DocSaveOptions();

// Convert HTML to DOCX
Converter.ConvertHTML(document, options, savePath);

Save Options

Aspose.HTML allows converting HTML to DOCX using default or custom save options. DocSaveOptions usage enables you to customize the rendering process; you can specify the page size, margins, resolutions, CSS, etc.

Property	Description
FontEmbeddingRule	This property gets or sets the font embedding rule. Available values are Full and None. The default value is None.
Css	Gets a CssOptions object which is used for configuration of CSS properties processing.
DocumentFormat	This property gets or sets the file format of the output document. The default value is DOCX.
PageSetup	This property gets a page setup object and uses it for configuration output page-set.
HorizontalResolution	Sets horizontal resolution for output images in pixels per inch. The default value is 300 dpi.
VerticalResolution	Sets vertical resolution for output images in pixels per inch. The default value is 300 dpi.

To learn more about DocSaveOptions, please read the Fine-Tuning Converters article.

Convert HTML to DOCX using DocSaveOptions

To convert HTML to DOCX with DocSaveOptions specifying, you should follow a few steps:

1. Load an HTML file using one of the HTMLDocument() constructors of the HTMLDocument class.
2. Create a new DocSaveOptions object.
3. Use the ConvertHTML() method of the Converter class to save HTML as a DOCX file. You need to pass the HTMLDocument, DocSaveOptions, and output file path to the ConvertHTML() method to convert HTML to DOCX.

The following example shows how to use DocSaveOptions and create a DOCX file with custom save options:

string documentPath = Path.Combine(OutputDir, "save-options.html");
string savePath = Path.Combine(OutputDir, "save-options-output.docx");

// Prepare HTML code and save it to a file
var code = "<h1>DocSaveOptions Class</h1>\r\n" +
           "<p>Using DocSaveOptions Class, you can programmatically apply a wide range of conversion parameters.</p>\r\n";

File.WriteAllText(documentPath, code);

// Initialize an HTML Document from the html file
using var document = new HTMLDocument(documentPath);

// Initialize DocSaveOptions. Set A5 as a page-size 
var options = new DocSaveOptions();
options.PageSetup.AnyPage = new Page(new Aspose.Html.Drawing.Size(Length.FromInches(8.3f), Length.FromInches(5.8f)));

// Convert HTML to DOCX
Converter.ConvertHTML(document, options, savePath);

The DocSaveOptions() constructor initializes an instance of the DocSaveOptions class that is passed to ConvertHTML() method. The ConvertHTML() method takes the document, options, output file path savePath and performs the conversion operation. The DocSaveOptions class provides numerous properties that give you full control over a wide range of parameters and improve the process of converting HTML to DOCX format. In the above example, we use the PageSetup property that specifies the page size of the DOCX document.

Output Stream Providers

If it is required to save files in the remote storage (e.g., cloud, database, etc.) you can implement ICreateStreamProvider interface to have manual control over the file creating process. This interface is designed as a callback object to create a stream at the beginning of the document/page (depending on the output format) and release the early created stream after rendering the document/page.

Aspose.HTML for .NET provides various types of output formats for rendering operations. Some of these formats produce a single output file (for instance PDF, XPS), others create multiple files (Image formats JPG, PNG, etc.).

The example below shows how to implement and use your own MemoryStreamProvider in the application:

class MemoryStreamProvider : Aspose.Html.IO.ICreateStreamProvider
{
    // List of MemoryStream objects created during the document rendering
    public List<MemoryStream> Streams { get; } = new List<MemoryStream>();

    public Stream GetStream(string name, string extension)
    {
        // This method is called when only one output stream is required, for instance for XPS, PDF or TIFF formats
        MemoryStream result = new MemoryStream();
        Streams.Add(result);
        return result;
    }

    public Stream GetStream(string name, string extension, int page)
    {
        // This method is called when the creation of multiple output streams are required. For instance, during the rendering HTML to list of image files (JPG, PNG, etc.)
        MemoryStream result = new MemoryStream();
        Streams.Add(result);
        return result;
    }

    public void ReleaseStream(Stream stream)
    {
        // Here you can release the stream filled with data and, for instance, flush it to the hard-drive
    }

    public void Dispose()
    {
        // Releasing resources
        foreach (var stream in Streams)
            stream.Dispose();
    }
}

The following code snippet demonstrates how to convert an HTML file to a DOCX file using a memory stream.

// Create an instance of MemoryStreamProvider
using var streamProvider = new MemoryStreamProvider();

// Initialize an HTML document
using var document = new HTMLDocument(@"<h1>Convert HTML to DOCX File Format!</h1>", ".");

// Convert HTML to DOCX using the MemoryStreamProvider
Converter.ConvertHTML(document, new DocSaveOptions(), streamProvider);

// Get access to the memory stream that contains the result data
var memory = streamProvider.Streams.First();
memory.Seek(0, SeekOrigin.Begin);

// Flush the result data to the output file
using (FileStream fs = File.Create(Path.Combine(OutputDir, "stream-provider.docx")))
{
    memory.CopyTo(fs);
}

Download our Aspose.HTML for .NET library allows you to successfully, quickly, and easily convert your HTML, MHTML, EPUB, SVG, and Markdown documents to the most popular formats.

Aspose.HTML offers a free online HTML to DOCX Converter that converts HTML to DOCX with high quality, easy and fast. Just upload, convert your files and get results in a few seconds!