Have you ever found yourself needing to harness the powerful document formatting capabilities of Antenna House Formatter V7.5 directly from your .NET applications? Whether you're working with Visual Basic.NET or Visual C#.NET, the .NET interface offers a seamless bridge, allowing your code to leverage this robust tool.
This interface is designed to play nicely with a range of Microsoft .NET Framework versions, including 4.5.2, 4.6.x, 4.7.x, and 4.8, as well as the newer .NET 8 environment (specifically with V7.4MR3). It's worth noting, however, that for those on Amazon Linux 2023 Graviton2 or Macintosh M1, the .NET interface isn't currently available. Also, a crucial point to remember: you can't have multiple versions of Antenna House Formatter or XSL Formatter installed simultaneously when using the .NET interface. You'll need to uninstall any conflicting versions and ensure your system's PATH environment variable is clean.
Getting the .NET components set up is a bit like setting up a new tool in your workshop. They don't automatically register themselves in the global assembly cache. This means you'll need to either place the component files in your application's current folder or create an application configuration file to help the system find them. For Windows users, the installation process typically adds the necessary directory to your PATH, simplifying things. On Linux and macOS, you'll need to manually add the [Install directory]/lib to your LD_LIBRARY_PATH (Linux) or DYLD_LIBRARY_PATH (macOS) environment variables to ensure the shared libraries can be found at runtime.
Antenna House provides two key DLL files for this purpose: XfoDotNet40Ctl75.dll for .NET Framework 4.5.2 through 4.8 (Windows only), and XfoDotNetStdCtl75.dll for the broader .NET environment.
At the heart of this integration are two main classes: XfoObj and XfoException.
The XfoObj Class: Your Gateway to Formatting
The XfoObj class is essentially the main engine for Antenna House Formatter V7.5 within your .NET application. It's designed to be disposable, meaning you should call its Dispose() method when you're finished with it to free up resources. Think of it like closing a file handle or releasing a network connection – good practice to keep your application running smoothly. A typical C# snippet might look like this:
XfoDotNetCtl.XfoObj obj = new XfoDotNetCtl.XfoObj();
try {
// Your formatting operations here
} finally {
obj.Dispose();
}
This class offers a rich set of properties to control the formatting process. You can specify the document to be formatted (DocumentURI), the stylesheet to use (StylesheetURI), and even the type of formatter to employ (FormatterType), with options ranging from automatic detection to specific types like HTML, XHTML, XML+CSS, and XSL-FO. You can also set default character encodings for HTML (HtmlDefaultCharset) and point to option files (OptionFileURI) that contain custom formatting settings.
Perhaps one of the most versatile properties is PrinterName. This isn't just about sending output to a physical printer. You can direct the output to various formats: PDF (@PDF), SVG (@SVG), PostScript (@PS), XPS (@XPS), Word documents (@DOCX), or even plain text (@TEXT). If you don't specify anything, it defaults to PDF output. For Windows users, there's also PrinterSettingURI to load specific printer configurations.
The OutputFile property lets you define where the formatted results should be saved, or you can direct them to standard output (@STDOUT).
Understanding XfoException
When things don't go as planned, the XfoException class comes into play. This class is thrown by the Execute method of XfoObj and provides valuable details about what went wrong. Its properties include ErrorLevel (indicating the severity, from informational to fatal), ErrorCode (a specific code for the error), and Message (a descriptive English string explaining the issue).
By understanding and utilizing these .NET components, developers can integrate sophisticated document generation and transformation directly into their applications, streamlining workflows and enhancing the capabilities of their software.
