CSF.Zpt.Rendering.IRenderingSettings Interface Reference

Encapsulates the available options for rendering a IZptDocument. More...

Inheritance diagram for CSF.Zpt.Rendering.IRenderingSettings:

Public Member Functions
IRenderingContext	CreateRootContext (IZptElement element)
	Creates a new root IRenderingContext instance. More...
IRenderingContext	CreateRootContext (IZptElement element, object model)
	Creates a new root IRenderingContext instance. More...
ITemplateFileFactory	GetTemplateFileFactory ()
	Gets an instance of ITemplateFileFactory from the current instance. More...

Properties
IRenderingContextFactory	ContextFactory [get]
	Gets the factory implementation with which to create IRenderingContext instances. More...
bool	AddSourceFileAnnotation [get]
	Gets or sets a value indicating whether source file annotations should be added to the rendered output. More...
IContextVisitor[]	ContextVisitors [get]
	Gets the context visitors to be used when processing ZPT documents. More...
Encoding	OutputEncoding [get]
	Gets the encoding (eg: Unicode) for the rendered output. More...
bool	OmitXmlDeclaration [get]
	Gets a value indicating whether the XML declaration should be omitted (where applicable). More...

Detailed Description

Encapsulates the available options for rendering a IZptDocument.

Member Function Documentation

IRenderingContext CSF.Zpt.Rendering.IRenderingSettings.CreateRootContext

(

IZptElement

element

)

Creates a new root IRenderingContext instance.

Parameters

element

The root ZPT element

Returns

The root rendering context.

Implemented in CSF.Zpt.Rendering.DefaultRenderingSettings, and CSF.Zpt.Rendering.RenderingSettings.

IRenderingContext CSF.Zpt.Rendering.IRenderingSettings.CreateRootContext	(	IZptElement	element,
		object	model
	)

Creates a new root IRenderingContext instance.

Parameters

element	The root ZPT element
model	The model to render

Returns

The root rendering context.

Implemented in CSF.Zpt.Rendering.DefaultRenderingSettings, and CSF.Zpt.Rendering.RenderingSettings.

ITemplateFileFactory CSF.Zpt.Rendering.IRenderingSettings.GetTemplateFileFactory

(

)

Gets an instance of ITemplateFileFactory from the current instance.

Returns

The template file factory

Implemented in CSF.Zpt.Rendering.DefaultRenderingSettings, and CSF.Zpt.Rendering.RenderingSettings.

Property Documentation

bool CSF.Zpt.Rendering.IRenderingSettings.AddSourceFileAnnotation

get

Gets or sets a value indicating whether source file annotations should be added to the rendered output.

true if source file annotations are to be added; otherwise, false.

IRenderingContextFactory CSF.Zpt.Rendering.IRenderingSettings.ContextFactory

get

Gets the factory implementation with which to create IRenderingContext instances.

The rendering context factory.

IContextVisitor [] CSF.Zpt.Rendering.IRenderingSettings.ContextVisitors

get

Gets the context visitors to be used when processing ZPT documents.

The context visitors.

bool CSF.Zpt.Rendering.IRenderingSettings.OmitXmlDeclaration

get

Gets a value indicating whether the XML declaration should be omitted (where applicable).

true if the XML declaration is to be omitted; otherwise, false.

Encoding CSF.Zpt.Rendering.IRenderingSettings.OutputEncoding

get

Gets the encoding (eg: Unicode) for the rendered output.

The output encoding.

---

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

• /home/craig/Projects/CSF.Zpt/CSF.Zpt.Abstractions/Rendering/IRenderingSettings.cs