Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PdfPrintJobStatus

OfficeIMO.Workflows

Namespace
OfficeIMO.Workflows
Assembly
OfficeIMO.Workflows
Source revision
ac7e6e1bad8a with working tree changes
Implements
IEquatable<PdfPrintJobStatus>
Modifiers
sealed

A job's state as reported by its queue or printer.

Inheritance

  • object
  • PdfPrintJobStatus

Usage

Explore 12 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 5

Constructors

public PdfPrintJobStatus(string PrinterName, string JobId, PdfPrintJobState State) #

A job's state as reported by its queue or printer.

Parameters

PrinterName string required
The printer name or URI the job was submitted to.
JobId string required
The receipt's job identifier.
State OfficeIMO.Workflows.PdfPrintJobState required
Current state.

Methods

public PdfPrintJobStatus <Clone>$() #
public void Deconstruct(out string PrinterName, out string JobId, out PdfPrintJobState State) #

Parameters

PrinterName string required
JobId string required
State PdfPrintJobState required
Equals 2 overloads
public override bool Equals(object? obj) #

Parameters

obj object? required

Returns

bool
public bool Equals(PdfPrintJobStatus? other) #

Parameters

other PdfPrintJobStatus? required

Returns

bool
public override int GetHashCode() #

Returns

int
public static bool op_Equality(PdfPrintJobStatus? left, PdfPrintJobStatus? right) #

Parameters

left PdfPrintJobStatus? required
right PdfPrintJobStatus? required

Returns

bool
public static bool op_Inequality(PdfPrintJobStatus? left, PdfPrintJobStatus? right) #

Parameters

left PdfPrintJobStatus? required
right PdfPrintJobStatus? required

Returns

bool
public override string ToString() #

Returns

string

Properties

public string PrinterName { get; init; } #

The printer name or URI the job was submitted to.

public string JobId { get; init; } #

The receipt's job identifier.

public PdfPrintJobState State { get; init; } #

Current state.

public IReadOnlyList<string> StateReasons { get; init; } #

Machine-readable reasons, such as job-printing, media-empty or paused.

public string? StateMessage { get; init; } #

Human-readable status text from the printer or spooler.

public bool IsTerminal { get; } #

True for canceled, aborted, completed and removed jobs, whose state no longer changes.