CSF.Zpt.BatchRendering.BatchRenderingOptions Class Reference

Concrete implementation of IBatchRenderingOptions. More...

Inheritance diagram for CSF.Zpt.BatchRendering.BatchRenderingOptions:

Collaboration diagram for CSF.Zpt.BatchRendering.BatchRenderingOptions:

Public Member Functions
void	Dispose ()
	Releases all resource used by the CSF.Zpt.BatchRendering.BatchRenderingOptions object. More...
	BatchRenderingOptions (Stream inputStream=null, Stream outputStream=null, IEnumerable< FileSystemInfo > inputPaths=null, FileSystemInfo outputPath=null, string inputSearchPattern=null, string outputExtensionOverride=null, IEnumerable< DirectoryInfo > ignoredPaths=null, RenderingMode?renderingMode=null)
	Initializes a new instance of the CSF.Zpt.BatchRendering.BatchRenderingOptions class. More...

Static Public Member Functions
static IBatchOptionsInputHelper	Build ()
	Create and return a 'builder' instance which helps construct valid instance of IBatchRenderingOptions. More...

Properties
Stream	InputStream [get]
	Gets the input stream, or a null reference if it is unset. More...
IEnumerable< FileSystemInfo >	InputPaths [get]
	Gets the input paths, which may be an empty set if it is unset. More...
IEnumerable< DirectoryInfo >	IgnoredPaths [get]
	Gets a collection of ignored paths, which shall be excluded when examining the InputPaths. More...
string	InputSearchPattern [get]
	Gets a glob search pattern for examining the InputPaths. More...
RenderingMode	RenderingMode [get]
	Gets an optional value acting as an override for auto-detection of the rendering mode. More...
Stream	OutputStream [get]
	Gets the output stream, or a null reference if it is unset. More...
FileSystemInfo	OutputPath [get]
	Gets the output path, or a null reference if it is unset. More...
string	OutputExtensionOverride [get]
	Gets an optional override for setting the file extension of written output files. More...
Properties inherited from CSF.Zpt.BatchRendering.IBatchRenderingOptions
Stream	InputStream [get]
	Gets the input stream, or a null reference if it is unset. More...
IEnumerable< FileSystemInfo >	InputPaths [get]
	Gets the input paths, which may be an empty set if it is unset. More...
IEnumerable< DirectoryInfo >	IgnoredPaths [get]
	Gets a collection of ignored paths, which shall be excluded when examining the InputPaths. More...
string	InputSearchPattern [get]
	Gets a glob search pattern for examining the InputPaths. More...
RenderingMode	RenderingMode [get]
	Gets an optional value acting as an override for auto-detection of the rendering mode. More...
Stream	OutputStream [get]
	Gets the output stream, or a null reference if it is unset. More...
FileSystemInfo	OutputPath [get]
	Gets the output path, or a null reference if it is unset. More...
string	OutputExtensionOverride [get]
	Gets an optional override for setting the file extension of written output files. More...

Detailed Description

Concrete implementation of IBatchRenderingOptions.

Constructor & Destructor Documentation

CSF.Zpt.BatchRendering.BatchRenderingOptions.BatchRenderingOptions ( Stream  inputStream = null, Stream  outputStream = null, IEnumerable< FileSystemInfo >  inputPaths = null, FileSystemInfo  outputPath = null, string  inputSearchPattern = null, string  outputExtensionOverride = null, IEnumerable< DirectoryInfo >  ignoredPaths = null, RenderingMode?  renderingMode = null  )

inline

Initializes a new instance of the CSF.Zpt.BatchRendering.BatchRenderingOptions class.

Parameters

inputStream	Input stream.
outputStream	Output stream.
inputPaths	Input paths.
outputPath	Output path.
inputSearchPattern	Input search pattern.
outputExtensionOverride	Output extension override.
ignoredPaths	Ignored paths.
renderingMode	The rendering mode override.

Member Function Documentation

static IBatchOptionsInputHelper CSF.Zpt.BatchRendering.BatchRenderingOptions.Build ( )

inlinestatic

Create and return a 'builder' instance which helps construct valid instance of IBatchRenderingOptions.

void CSF.Zpt.BatchRendering.BatchRenderingOptions.Dispose ( )

inline

Releases all resource used by the CSF.Zpt.BatchRendering.BatchRenderingOptions object.

Call Dispose when you are finished using the CSF.Zpt.BatchRendering.BatchRenderingOptions. The Dispose method leaves the CSF.Zpt.BatchRendering.BatchRenderingOptions in an unusable state. After calling Dispose, you must release all references to the CSF.Zpt.BatchRendering.BatchRenderingOptions so the garbage collector can reclaim the memory that the CSF.Zpt.BatchRendering.BatchRenderingOptions was occupying.

Property Documentation

IEnumerable<DirectoryInfo> CSF.Zpt.BatchRendering.BatchRenderingOptions.IgnoredPaths

get

Gets a collection of ignored paths, which shall be excluded when examining the InputPaths.

The ignored paths.

IEnumerable<FileSystemInfo> CSF.Zpt.BatchRendering.BatchRenderingOptions.InputPaths

get

Gets the input paths, which may be an empty set if it is unset.

The input paths.

string CSF.Zpt.BatchRendering.BatchRenderingOptions.InputSearchPattern

get

Gets a glob search pattern for examining the InputPaths.

The input search pattern.

Stream CSF.Zpt.BatchRendering.BatchRenderingOptions.InputStream

get

Gets the input stream, or a null reference if it is unset.

The input stream.

string CSF.Zpt.BatchRendering.BatchRenderingOptions.OutputExtensionOverride

get

Gets an optional override for setting the file extension of written output files.

The output extension override.

FileSystemInfo CSF.Zpt.BatchRendering.BatchRenderingOptions.OutputPath

get

Gets the output path, or a null reference if it is unset.

The output path.

Stream CSF.Zpt.BatchRendering.BatchRenderingOptions.OutputStream

get

Gets the output stream, or a null reference if it is unset.

The output stream.

RenderingMode CSF.Zpt.BatchRendering.BatchRenderingOptions.RenderingMode

get

Gets an optional value acting as an override for auto-detection of the rendering mode.

The rendering mode.

---

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

• /home/craig/Projects/CSF.Zpt/CSF.Zpt/BatchRendering/BatchRenderingOptions.cs