Class PrintResult

Namespace

combit.Reporting.Printing.Pdf

Assembly

combit.ListLabel31.CrossPlatform.Printing.Pdf.dll

Represents the outcome of a PDF print operation, including whether the operation succeeded, the method used, and optional error or diagnostic information.

public sealed class PrintResult

Inheritance

object

PrintResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DiagnosticLog

Gets optional diagnostic log text that records the decisions and steps taken during the print pipeline, useful for troubleshooting.

public string? DiagnosticLog { get; }

Property Value

string

ErrorMessage

Gets an error message describing why the print operation failed, or null when the operation succeeded.

public string? ErrorMessage { get; }

Property Value

string

MethodUsed

Gets the printing method that was used to deliver the document to the printer.

public PrintMethod MethodUsed { get; }

Property Value

PrintMethod

Success

Gets a value indicating whether the print operation completed successfully.

public bool Success { get; }

Property Value

bool

Methods

Failed(string, string?)

Creates a PrintResult that indicates a failed print operation.

public static PrintResult Failed(string errorMessage, string? diagnosticLog = null)

Parameters

errorMessage string

A human-readable description of the failure.

diagnosticLog string

Optional diagnostic log text.

Returns

PrintResult

A failed PrintResult instance.

PartialSuccess(PrintMethod, string?)

Creates a PrintResult that indicates a partially successful print operation, for example when passthrough failed but rasterized printing succeeded.

public static PrintResult PartialSuccess(PrintMethod methodUsed, string? diagnosticLog = null)

Parameters

methodUsed PrintMethod

The fallback method that ultimately completed the job.

diagnosticLog string

Optional diagnostic log text describing the fallback path taken.

Returns

PrintResult

A successful PrintResult with diagnostic information about the fallback.

Succeeded(PrintMethod, string?)

Creates a PrintResult that indicates a fully successful print operation.

public static PrintResult Succeeded(PrintMethod methodUsed, string? diagnosticLog = null)

Parameters

methodUsed PrintMethod

The printing method that completed the job.

diagnosticLog string

Optional diagnostic log text.

Returns

PrintResult

A successful PrintResult instance.