GroupDocs.Assembly for .NET 17.3.0 Release Notes

Major Features

Supported document assembly for Plain Text, HTML, and XML file formats.

Full List of Issues Covering all Changes in this Release

KeySummaryCategory
ASSEMBLYNET-30Support document assembly for Plain Text file formatsFeature
ASSEMBLYNET-31Support document assembly for HTML file formatsFeature
ASSEMBLYNET-36Support document assembly for XML files of general formFeature

Public API and Backward Incompatible Changes

Added Support for HTML, XML, and Plain Text File Formats

Supported Features for HTML, XML, and Plain Text File Formats

The following table provides information on those GroupDocs.Assembly features that are partially supported or not supported at all for HTML, XML, and plain text file formats.

FeatureHTML StatusXML StatusPlain Text Status
Inserting Charts DynamicallyNot availableNot availableNot available
Inserting Documents DynamicallyTo be supportedNot supportedNot supported
Inserting Images DynamicallySupported, to be extendedNot availableNot available

Specifics of Working with HTML and XML File Formats

GroupDocs.Assembly treats HTML and XML tags in template documents as common text. That is, to output HTML or XML tags using a data band or conditional block, these tags must be included to the body of the corresponding data band or conditional block as in the following example. Given thatĀ itemsĀ is an enumeration of strings “Item1”, “Item2”, and “Item3”, you can use the following HTML template to output the items in a bulleted list.

<html>
<body>
<ul>
<<foreach [item in items]>>
<li><<[item]>></li>
<</foreach>>
</ul>
</body>
</html>

In this case, GroupDocs.Assembly produces the following result document.

<html>
<body>
<ul>

<li>Item1</li>

<li>Item2</li>

<li>Item3</li>

</ul>
</body>
</html>

The resulting document looks in a web browser as follows.

  • Item1
  • Item2
  • Item3

Escaping Special Characters

GroupDocs.Assembly does not require you to escape special characters such as ‘<’, ‘>’, and others in HTML and XML templates while declaring GroupDocs.Assembly tags. However, if you need your HTML and XML templates to be correctly viewed by web browsers, you can escape special characters in accordance with HTML and XML standards. GroupDocs.Assembly understands both unescaped and escaped characters in HTML and XML templates. For example, the following two template fragments produce the same results.

Fragment 1

<<[value]>>

Fragment 2

&lt;&lt;[value]&gt;&gt;

Inserting Images Dynamically (HTML only)

You can insert images into HTML documents dynamically using a combination of HTML and GroupDocs.Assembly tags. Basically there are the following two options to achieve this.

Option 1. Specifying Image URL

To specify an image URL dynamically, you can use the following syntax.

<img src="<<[url_expression]>>"/>

Here, url_expression stands for an expression returning a URL string like “/images/foo.png”.

Option 2. Embedding Image Data

To embed an image into an HTML document, you can use syntax as in the following example.

<img src="data:image_mime_type;base64,<<[ImageUtil.GetBytesAsBase64(path)]>>"/>

Here, image_mime_type stands for an image mime type like “image/png”, path stands for the local path to an image file to be embedded, and ImageUtil stands for an external class defined in your application as follows.

public static class ImageUtil
{
    public static string GetBytesAsBase64(string path)
    {
        return System.Convert.ToBase64String(System.IO.File.ReadAllBytes(path));
    }
} 

To make this example work, the type of ImageUtil must be set known for a DocumentAssembler instance before assembling a document like in the following code snippet.

DocumentAssembler assembler = new DocumentAssembler();
assembler.KnownTypes.Add(typeof(ImageUtil));
assembler.AssembleDocument(...);