CSF.Zpt.Rendering.RenderingSettings Class Reference

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

Inheritance diagram for CSF.Zpt.Rendering.RenderingSettings:

Collaboration diagram for CSF.Zpt.Rendering.RenderingSettings:

Public Member Functions
virtual IRenderingContext	CreateRootContext (IZptElement element)
	Creates a new root IRenderingContext instance. More...
virtual IRenderingContext	CreateRootContext (IZptElement element, object model)
	Creates a new root IRenderingContext instance. More...
virtual ITemplateFileFactory	GetTemplateFileFactory ()
	Gets an instance of ITemplateFileFactory from the current instance. More...
	RenderingSettings (IContextVisitor[] elementVisitors, IRenderingContextFactory contextFactory, bool addSourceFileAnnotation, System.Text.Encoding outputEncoding, bool omitXmlDeclaration, ITemplateFileFactory documentFactory)
	Initializes a new instance of the CSF.Zpt.Rendering.IRenderingSettings class. More...

Properties
IRenderingContextFactory	ContextFactory [get]
	Gets the factory implementation with which to create RenderingContext 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...
ITemplateFileFactory	TemplateFileFactory [get]
	Gets or sets the implementation of ITemplateFileFactory to use. More...
static IRenderingSettings	Default [get]
	Exposes an instance of IRenderingSettings which carries the default settings. More...
Properties inherited from CSF.Zpt.Rendering.IRenderingSettings
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 ZptDocument.

Constructor & Destructor Documentation

CSF.Zpt.Rendering.RenderingSettings.RenderingSettings ( IContextVisitor[]  elementVisitors, IRenderingContextFactory  contextFactory, bool  addSourceFileAnnotation, System.Text.Encoding  outputEncoding, bool  omitXmlDeclaration, ITemplateFileFactory  documentFactory  )

inline

Initializes a new instance of the CSF.Zpt.Rendering.IRenderingSettings class.

Parameters

addSourceFileAnnotation	Indicates whether or not source file annotation is to be added.
elementVisitors	The element visitors to use.
contextFactory	The rendering context factory.
outputEncoding	The desired output encoding.
omitXmlDeclaration	Whether or not to omit the XML declaration.
documentFactory	An optional non-default implementation of ITemplateFileFactory to use.

Member Function Documentation

virtual IRenderingContext CSF.Zpt.Rendering.RenderingSettings.CreateRootContext ( IZptElement  element )

inlinevirtual

Creates a new root IRenderingContext instance.

Returns

The root rendering context.

Implements CSF.Zpt.Rendering.IRenderingSettings.

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

inlinevirtual

Creates a new root IRenderingContext instance.

Parameters

element	The root ZPT element
model	The model to render

Returns

The root rendering context.

Implements CSF.Zpt.Rendering.IRenderingSettings.

virtual ITemplateFileFactory CSF.Zpt.Rendering.RenderingSettings.GetTemplateFileFactory ( )

inlinevirtual

Gets an instance of ITemplateFileFactory from the current instance.

Returns

The template file factory

Implements CSF.Zpt.Rendering.IRenderingSettings.

Property Documentation

bool CSF.Zpt.Rendering.RenderingSettings.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.RenderingSettings.ContextFactory

get

Gets the factory implementation with which to create RenderingContext instances.

The rendering context factory.

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

get

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

The context visitors.

IRenderingSettings CSF.Zpt.Rendering.RenderingSettings.Default

staticget

Exposes an instance of IRenderingSettings which carries the default settings.

The default settings.

bool CSF.Zpt.Rendering.RenderingSettings.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.RenderingSettings.OutputEncoding

get

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

The output encoding.

ITemplateFileFactory CSF.Zpt.Rendering.RenderingSettings.TemplateFileFactory

get

Gets or sets the implementation of ITemplateFileFactory to use.

The template file factory.

---

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

• /home/craig/Projects/CSF.Zpt/CSF.Zpt/Rendering/RenderingSettings.cs