Class BulkRenderingRequest

Represents a request to render many template files in bulk.

Inheritance

System.Object

BulkRenderingRequest

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: ZptSharp.BulkRendering

Assembly: ZptSharp.Abstractions.dll

Syntax

public class BulkRenderingRequest

Properties

ExcludedPaths

Gets or sets a collection of paths/glob patterns used to match files which should be excluded from the operation. The files matched by these exclusions are subtracted from IncludedPaths before rendering begins.

Declaration

public ICollection<string> ExcludedPaths { get; set; }

Property Value

Type	Description
System.Collections.Generic.ICollection<System.String>	The excluded paths.

IncludedPaths

Gets or sets a collection of paths/glob patterns used to match valid input templates.

Declaration

public ICollection<string> IncludedPaths { get; set; }

Property Value

Type	Description
System.Collections.Generic.ICollection<System.String>	The included paths where input templates are found.

InputRootPath

Gets or sets a single directory path, used as reference for the 'root' input directory. This will be used to determine each input file's relative path from the input. This allows it to be written to the same relative path for output.

Declaration

public string InputRootPath { get; set; }

Property Value

Type	Description
System.String	The root path for the input files.

Remarks

If left null or empty, then the current working directory will be used as the root path. Note that any input files which are not descendents of the root path will not be included in the rendering operation.

Model

Gets or sets the model object to be used when rendering the templates.

Declaration

public object Model { get; set; }

Property Value

Type	Description
System.Object	The model.

OutputFileExtension

If set, then output files will have their file extension replaced with this extension, instead of their previous extension.

Declaration

public string OutputFileExtension { get; set; }

Property Value

Type	Description
System.String	The output file extension.

OutputPath

Gets the directory path to where the files shall be output once they are rendered.

Declaration

public string OutputPath { get; set; }

Property Value

Type	Description
System.String	The output path.

RenderingConfig

Gets or sets the rendering configuration to be used when rendering the templates.

Declaration

public RenderingConfig RenderingConfig { get; set; }

Property Value

Type	Description
RenderingConfig	The rendering config.