Class BulkRenderingFileResult

Describes the result of a bulk-rendering operation for a single input file.

Inheritance

System.Object

BulkRenderingFileResult

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 BulkRenderingFileResult

Properties

Exception

Gets the exception encountered whilst rendering this file, if IsSuccess is false.

Declaration

public Exception Exception { get; }

Property Value

Type	Description
System.Exception	The rendering exception.

InputFile

Gets the path to the input file.

Declaration

public string InputFile { get; }

Property Value

Type	Description
System.String	The input file path.

IsSuccess

Gets a value indicating whether or not this file was successfully rendered and saved.

Declaration

public bool IsSuccess { get; }

Property Value

Type	Description
System.Boolean

OutputFile

Gets the path to the output file, if IsSuccess is true.

Declaration

public string OutputFile { get; }

Property Value

Type	Description
System.String	The output file path.

Methods

Error(String, Exception)

Creates an instance of BulkRenderingFileResult for a failed rendering.

Declaration

public static BulkRenderingFileResult Error(string inputFile, Exception exception)

Parameters

Type	Name	Description
System.String	inputFile	The input file path.
System.Exception	exception	The exception encountered whilst rendering.

Returns

Type	Description
BulkRenderingFileResult	A bulk-rendering file result.

Success(String, String)

Creates an instance of BulkRenderingFileResult for a successful rendering.

Declaration

public static BulkRenderingFileResult Success(string inputFile, string outputFile)

Parameters

Type	Name	Description
System.String	inputFile	The input file path.
System.String	outputFile	The output file path.

Returns

Type	Description
BulkRenderingFileResult	A bulk-rendering file result.