ApocDriver Class

ApocDriver Class

ApocDriver provides the client with a single interface to invoking Apoc XSL-FO.

Inheritance Hierarchy

SystemObject
Kettic.AspNet.Controls.Toolkit.ApocApocDriver

Namespace: Kettic.AspNet.Controls.Toolkit.Apoc
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)

Syntax

C++

Copy

public class ApocDriver : IDriver

Public Class ApocDriver
	Implements IDriver

public ref class ApocDriver : IDriver

type ApocDriver =  
    class
        interface IDriver
    end

The ApocDriver type exposes the following members.

Constructors

	Name	Description
	ApocDriver	Sets the the 'baseDir' property in the Configuration class using the value returned by Directory.GetCurrentDirectory().

Top

Methods

	Name	Description
	Make	Constructs a new ApocDriver and registers the newly created driver as the active driver.
	Render(Stream, Stream)	Executes the conversion reading the source tree from the input stream, converting it to a format dictated by the render and writing it to the supplied output stream.
	Render(TextReader, Stream)	Executes the conversion reading the source tree from the input reader, converting it to a format dictated by the renderer and writing it to the supplied output stream.
	Render(String, Stream)	Executes the conversion reading the source tree from the file inputFile, converting it to a format dictated by the renderer and writing it to the supplied output stream.
	Render(String, String)	Executes the conversion reading the source tree from the file inputFile, converting it to a format dictated by the renderer and writing it to the file identified by outputFile.
	Render(XmlDocument, Stream)	Executes the conversion reading the source tree from the supplied XmlDocument, converting it to a format dictated by the renderer and writing it to the supplied output stream.
	Render(XmlReader, Stream)	Executes the conversion reading the source tree from the input reader, converting it to a format dictated by the render and writing it to the supplied output stream.

Top

Properties

	Name	Description
	ActiveDriver	Gets or sets the active ApocDriver.
	BaseDirectory	Gets or sets the base directory used to locate external resourcs such as images.
	CloseOnExit	Determines if the output stream should be automatically closed upon completion of the render process.
	Credentials	Gets a reference to a CredentialCache object that manages credentials for multiple Internet resources.
	ImageHandler	Gets or sets the handler that is responsible for loading the image data for external graphics.
	Options	Options that are passed to the rendering engine.
	ProductKey	Write only property that can be used to bypass licenses.licx and set a product key directly.
	Renderer	Determines which rendering engine to use.
	Timeout	Gets or sets the time in milliseconds until an HTTP image request times out.

Top

Events

	Name	Description
	OnError	A multicast delegate. The error event Apoc publishes.
	OnInfo	A multicast delegate. The info event Apoc publishes.
	OnWarning	A multicast delegate. The warning event Apoc publishes.

Top

Remarks

The examples belows demonstrate several ways of invoking Apoc XSL-FO. The methodology is the same regardless of how Apoc is embedded in your system (ASP.NET, WinForm, Web Service, etc).

Examples

C++

Copy

// This example demonstrates rendering an XSL-FO file to a PDF file.
ApocDriver driver = ApocDriver.Make();
driver.Render(
    new FileStream("readme.fo", FileMode.Open), 
    new FileStream("readme.pdf", FileMode.Create));

// This example demonstrates rendering an XSL-FO file to a PDF file.
Dim driver As ApocDriver = ApocDriver.Make
driver.Render( _
    New FileStream("readme.fo", FileMode.Open), _
    New FileStream("readme.pdf", FileMode.Create))

C++

Copy

// This example demonstrates rendering the result of an XSLT transformation 
// into a PDF file.
ApocDriver driver = ApocDriver.Make();
driver.Render(
    XslTransformer.Transform("readme.xml", "readme.xsl"),
    new FileStream("readme.pdf", FileMode.Create));

// This example demonstrates rendering the result of an XSLT transformation 
// into a PDF file.
Dim driver As ApocDriver = ApocDriver.Make
driver.Render( _
    XslTransformer.Transform("readme.xml", "readme.xsl"), _
    New FileStream("readme.pdf", FileMode.Create))

C++

Copy

// This example demonstrates using an XmlDocument as the source of the 
// XSL-FO tree.  The XmlDocument could easily be dynamically generated.
XmlDocument doc = new XmlDocument()
doc.Load("reader.fo");

ApocDriver driver = ApocDriver.Make();
driver.Render(doc, new FileStream("readme.pdf", FileMode.Create));

// This example demonstrates using an XmlDocument as the source of the 
// XSL-FO tree.  The XmlDocument could easily be dynamically generated.
Dim doc As XmlDocument = New XmlDocument()
doc.Load("reader.fo")

Dim driver As ApocDriver = ApocDriver.Make
driver.Render(doc, New FileStream("readme.pdf", FileMode.Create))

Reference

Kettic.AspNet.Controls.Toolkit.Apoc Namespace