CSF.Zpt.IZptDocumentFactory Interface Reference

Interface for a type which creates instances of IZptDocument. More...

Inheritance diagram for CSF.Zpt.IZptDocumentFactory:

Public Member Functions
bool	TryDetectMode (FileInfo sourceFile, out RenderingMode detectedMode)
	Gets a value indicating the RenderingMode detected for a given source file. More...
IZptDocument	CreateDocument (FileInfo sourceFile, Encoding encoding=null, RenderingMode?renderingMode=null)
	Creates a document from the given source file. More...
IZptDocument	CreateDocument (FileInfo sourceFile, Type providerType, Encoding encoding=null)
	Creates a document from the given source file. More...
IZptDocument	CreateDocument (Stream source, RenderingMode renderingMode, ISourceInfo sourceInfo=null, Encoding encoding=null)
	Creates a document from the given source stream. More...
IZptDocument	CreateDocument (Stream source, Type providerType, ISourceInfo sourceInfo=null, Encoding encoding=null)
	Creates a document from the given source file. More...

Detailed Description

Interface for a type which creates instances of IZptDocument.

Member Function Documentation

IZptDocument CSF.Zpt.IZptDocumentFactory.CreateDocument	(	FileInfo	sourceFile,
		Encoding	encoding = null,
		RenderingMode?	renderingMode = null
	)

Creates a document from the given source file.

Parameters

sourceFile	The source file containing the document to create.
encoding	The text encoding to use in reading the source file.
renderingMode	The rendering mode to use in creating the output document.

Implemented in CSF.Zpt.ZptDocumentFactory.

IZptDocument CSF.Zpt.IZptDocumentFactory.CreateDocument	(	FileInfo	sourceFile,
		Type	providerType,
		Encoding	encoding = null
	)

Creates a document from the given source file.

Parameters

sourceFile	The source file containing the document to create.
providerType	The IZptDocumentProvider type to use for creating the document.
encoding	The text encoding to use in reading the source file.

Implemented in CSF.Zpt.ZptDocumentFactory.

IZptDocument CSF.Zpt.IZptDocumentFactory.CreateDocument	(	Stream	source,
		RenderingMode	renderingMode,
		ISourceInfo	sourceInfo = null,
		Encoding	encoding = null
	)

Creates a document from the given source stream.

Parameters

source	The stream containing the document to create.
renderingMode	The rendering mode to use in creating the output document.
sourceInfo	Optional information about the source of the document.
encoding	The text encoding to use in reading the source file.

Implemented in CSF.Zpt.ZptDocumentFactory.

IZptDocument CSF.Zpt.IZptDocumentFactory.CreateDocument	(	Stream	source,
		Type	providerType,
		ISourceInfo	sourceInfo = null,
		Encoding	encoding = null
	)

Creates a document from the given source file.

Parameters

source	The stream containing the document to create.
providerType	The IZptDocumentProvider type to use for creating the document.
sourceInfo	Optional information about the source of the document.
encoding	The text encoding to use in reading the source file.

Implemented in CSF.Zpt.ZptDocumentFactory.

bool CSF.Zpt.IZptDocumentFactory.TryDetectMode	(	FileInfo	sourceFile,
		out RenderingMode	detectedMode
	)

Gets a value indicating the RenderingMode detected for a given source file.

Returns

true if the RenderingMode could be auto-detected; false if not.

Parameters

sourceFile	The source file.
detectedMode	Exposes the detected rendering mode.

Implemented in CSF.Zpt.ZptDocumentFactory.

---

The documentation for this interface was generated from the following file:

• /home/craig/Projects/CSF.Zpt/CSF.Zpt.Abstractions/IZptDocumentFactory.cs