CSF.Zpt.BatchRendering.IBatchOptionsInputHelper Interface Reference

Interface for a type which enables selection of the input options for IBatchRenderingOptions. More...

Inheritance diagram for CSF.Zpt.BatchRendering.IBatchOptionsInputHelper:

Public Member Functions
IBatchOptionsSingleInputOutputHelper	FromStream (Stream stream, RenderingMode mode)
	Specifies that the batch options are to be built from a System.IO.Stream. More...
IBatchOptionsSingleInputOutputHelper	FromFile (string path, RenderingMode?mode)
	Specifies that the batch options are to be built from a single input file. More...
IBatchOptionsSingleInputOutputHelper	FromFile (FileInfo file, RenderingMode?mode)
	Specifies that the batch options are to be built from a single input file. More...
IBatchOptionsMultipleInputOutputHelper	FromFiles (IEnumerable< string > paths, RenderingMode?mode)
	Specifies that the batch options are to be built from a collection of input files. More...
IBatchOptionsMultipleInputOutputHelper	FromFiles (IEnumerable< FileInfo > files, RenderingMode?mode)
	Specifies that the batch options are to be built from a collection of input files. More...
IBatchOptionsMultipleInputOutputHelper	FromDirectory (string path, RenderingMode?mode, IEnumerable< string > ignoredPaths=null, string searchPattern=null)
	Specifies that the batch options are to be built from the files found within a directory path. More...
IBatchOptionsMultipleInputOutputHelper	FromDirectory (DirectoryInfo directory, RenderingMode?mode, IEnumerable< DirectoryInfo > ignoredPaths=null, string searchPattern=null)
	Specifies that the batch options are to be built from the files found within a directory path. More...

Detailed Description

Interface for a type which enables selection of the input options for IBatchRenderingOptions.

Member Function Documentation

IBatchOptionsMultipleInputOutputHelper CSF.Zpt.BatchRendering.IBatchOptionsInputHelper.FromDirectory	(	string	path,
		RenderingMode?	mode,
		IEnumerable< string >	ignoredPaths = null,
		string	searchPattern = null
	)

Specifies that the batch options are to be built from the files found within a directory path.

Returns

The output options helper.

Parameters

path	The directory path.
mode	An optional rendering mode.
ignoredPaths	An optional collection of ignored paths.
searchPattern	An optional search pattern for files within the directory.

IBatchOptionsMultipleInputOutputHelper CSF.Zpt.BatchRendering.IBatchOptionsInputHelper.FromDirectory	(	DirectoryInfo	directory,
		RenderingMode?	mode,
		IEnumerable< DirectoryInfo >	ignoredPaths = null,
		string	searchPattern = null
	)

Specifies that the batch options are to be built from the files found within a directory path.

Returns

The output options helper.

Parameters

directory	The directory.
mode	An optional rendering mode.
ignoredPaths	An optional collection of ignored directories.
searchPattern	An optional search pattern for files within the directory.

IBatchOptionsSingleInputOutputHelper CSF.Zpt.BatchRendering.IBatchOptionsInputHelper.FromFile	(	string	path,
		RenderingMode?	mode
	)

Specifies that the batch options are to be built from a single input file.

Returns

The output options helper.

Parameters

path	The file path.
mode	An optional rendering mode.

IBatchOptionsSingleInputOutputHelper CSF.Zpt.BatchRendering.IBatchOptionsInputHelper.FromFile	(	FileInfo	file,
		RenderingMode?	mode
	)

Specifies that the batch options are to be built from a single input file.

Returns

The output options helper.

Parameters

file	The file.
mode	An optional rendering mode.

IBatchOptionsMultipleInputOutputHelper CSF.Zpt.BatchRendering.IBatchOptionsInputHelper.FromFiles	(	IEnumerable< string >	paths,
		RenderingMode?	mode
	)

Specifies that the batch options are to be built from a collection of input files.

Returns

The output options helper.

Parameters

paths	The file paths.
mode	An optional rendering mode.

IBatchOptionsMultipleInputOutputHelper CSF.Zpt.BatchRendering.IBatchOptionsInputHelper.FromFiles	(	IEnumerable< FileInfo >	files,
		RenderingMode?	mode
	)

Specifies that the batch options are to be built from a collection of input files.

Returns

The output options helper.

Parameters

files	The files.
mode	An optional rendering mode.

IBatchOptionsSingleInputOutputHelper CSF.Zpt.BatchRendering.IBatchOptionsInputHelper.FromStream	(	Stream	stream,
		RenderingMode	mode
	)

Specifies that the batch options are to be built from a System.IO.Stream.

Returns

The output options helper.

Parameters

stream	The stream.
mode	The rendering mode.

---

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

• /home/craig/Projects/CSF.Zpt/CSF.Zpt.Abstractions/BatchRendering/IBatchOptionsInputHelper.cs