CSF.Zpt.IZptDocument Interface Reference

Represents a ZPT document. More...

Inheritance diagram for CSF.Zpt.IZptDocument:

Public Member Functions
string	Render (object model, IRenderingSettings options=null, Action< IModelValueContainer > contextConfigurator=null)
	Renders the document to a System.String. More...
void	Render (object model, TextWriter writer, IRenderingSettings options=null, Action< IModelValueContainer > contextConfigurator=null)
	Renders the document to the given System.IO.TextWriter. More...
string	Render (IRenderingSettings options=null, Action< IModelValueContainer > contextConfigurator=null)
	Renders the document to a System.String. More...
void	Render (TextWriter writer, IRenderingSettings options=null, Action< IModelValueContainer > contextConfigurator=null)
	Renders the document to the given System.IO.TextWriter. More...
IMetalMacroContainer	GetMacros ()
	Gets a collection of elements in the document which are defined as METAL macros. More...
ISourceInfo	GetSourceInfo ()
	Gets information about the source medium for the current instance More...

Properties
RenderingMode	Mode [get]
	Gets the RenderingMode for which the current document type caters. More...

Detailed Description

Represents a ZPT document.

Member Function Documentation

IMetalMacroContainer CSF.Zpt.IZptDocument.GetMacros

(

)

Gets a collection of elements in the document which are defined as METAL macros.

Returns

Elements representing the METAL macros.

Implemented in CSF.Zpt.DocumentProviders.ZptXmlDocument, CSF.Zpt.ZptDocument, CSF.Zpt.DocumentProviders.ZptHtmlDocument, and CSF.Zpt.DocumentProviders.ZptXmlLinqDocument.

ISourceInfo CSF.Zpt.IZptDocument.GetSourceInfo

(

)

Gets information about the source medium for the current instance

Returns

The source info.

Implemented in CSF.Zpt.DocumentProviders.ZptXmlDocument, CSF.Zpt.ZptDocument, CSF.Zpt.DocumentProviders.ZptXmlLinqDocument, and CSF.Zpt.DocumentProviders.ZptHtmlDocument.

string CSF.Zpt.IZptDocument.Render	(	object	model,
		IRenderingSettings	options = null,
		Action< IModelValueContainer >	contextConfigurator = null
	)

Renders the document to a System.String.

Parameters

model	An object for which the ZPT document is to be applied.
options	The rendering options to use. If null then default options are used.
contextConfigurator	An optional action to perform upon the root IModelValueContainer, to configure it.

Implemented in CSF.Zpt.ZptDocument.

void CSF.Zpt.IZptDocument.Render	(	object	model,
		TextWriter	writer,
		IRenderingSettings	options = null,
		Action< IModelValueContainer >	contextConfigurator = null
	)

Renders the document to the given System.IO.TextWriter.

Parameters

model	An object for which the ZPT document is to be applied.
writer	The text writer to render to.
options	The rendering options to use. If null then default options are used.
contextConfigurator	An optional action to perform upon the root IModelValueContainer, to configure it.

Implemented in CSF.Zpt.ZptDocument.

string CSF.Zpt.IZptDocument.Render	(	IRenderingSettings	options = null,
		Action< IModelValueContainer >	contextConfigurator = null
	)

Renders the document to a System.String.

Parameters

options	The rendering options to use. If null then default options are used.
contextConfigurator	An optional action to perform upon the root IModelValueContainer, to configure it.

Implemented in CSF.Zpt.ZptDocument.

void CSF.Zpt.IZptDocument.Render	(	TextWriter	writer,
		IRenderingSettings	options = null,
		Action< IModelValueContainer >	contextConfigurator = null
	)

Renders the document to the given System.IO.TextWriter.

Parameters

writer	The text writer to render to.
options	The rendering options to use. If null then default options are used.
contextConfigurator	An optional action to perform upon the root IModelValueContainer, to configure it.

Implemented in CSF.Zpt.ZptDocument.

Property Documentation

RenderingMode CSF.Zpt.IZptDocument.Mode

get

Gets the RenderingMode for which the current document type caters.

The rendering mode.

---

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

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