PrintSystemJobInfo PrintSystemJobInfo PrintSystemJobInfo PrintSystemJobInfo Class

Definition

Defines a print job in detail.

public ref class PrintSystemJobInfo : System::Printing::PrintSystemObject
public class PrintSystemJobInfo : System.Printing.PrintSystemObject
type PrintSystemJobInfo = class
    inherit PrintSystemObject
Public Class PrintSystemJobInfo
Inherits PrintSystemObject
Inheritance
PrintSystemJobInfoPrintSystemJobInfoPrintSystemJobInfoPrintSystemJobInfo

Remarks

This class has no public constructor. To get a reference to a PrintSystemJobInfo object, use the static PrintSystemJobInfo.Get method or one of the following PrintQueue instance methods: GetJob, GetPrintJobInfoCollection, or AddJob.

Many print job properties, such as whether a job is completed, must be passed from the printer to the PrintSystemJobInfo object before your application reads the corresponding property (IsCompleted). The Refresh method provides this functionality.

Similarly, when your application changes the value of the JobName property, the change must be written to the print queue utility on the computer. The Commit method provides this functionality.

If you derive a class from PrintSystemJobInfo that has additional writable properties, then you must implement an override of the Refresh and Commit methods.

Caution

Classes within the System.Printing namespace are not supported for use within a Windows service or ASP.NET application or service. Attempting to use these classes from within one of these application types may produce unexpected problems, such as diminished service performance and run-time exceptions.

If you want to print from a Windows Forms application, see the System.Drawing.Printing namespace.

Properties

HostingPrintQueue HostingPrintQueue HostingPrintQueue HostingPrintQueue

Gets the print queue that is hosting the print job.

HostingPrintServer HostingPrintServer HostingPrintServer HostingPrintServer

Gets the print server that is hosting the print queue for the print job.

IsBlocked IsBlocked IsBlocked IsBlocked

Gets a value that indicates whether the print job is blocked and therefore, not printing.

IsCompleted IsCompleted IsCompleted IsCompleted

Gets a value that indicates whether the print job is finished.

IsDeleted IsDeleted IsDeleted IsDeleted

Gets a value that indicates whether the print job, which is represented by the PrintSystemJobInfo object, was deleted from the print queue.

IsDeleting IsDeleting IsDeleting IsDeleting

Gets a value that indicates whether the print job is being deleted from the print queue.

IsDisposed IsDisposed IsDisposed IsDisposed

Gets or sets a value that indicates whether the object has been disposed.

(Inherited from PrintSystemObject)
IsInError IsInError IsInError IsInError

Gets a value that indicates whether an error condition is associated with the print job.

IsOffline IsOffline IsOffline IsOffline

Gets a value that indicates whether the printer is offline.

IsPaperOut IsPaperOut IsPaperOut IsPaperOut

Gets a value that indicates whether the printer has run out of the paper size and type that the print job requires.

IsPaused IsPaused IsPaused IsPaused

Gets a value that indicates whether the print job is paused.

IsPrinted IsPrinted IsPrinted IsPrinted

Gets a value that indicates whether the print job printed.

IsPrinting IsPrinting IsPrinting IsPrinting

Gets a value that indicates whether the print job is being printed.

IsRestarted IsRestarted IsRestarted IsRestarted

Gets a value that indicates whether the print job has been restarted.

IsRetained IsRetained IsRetained IsRetained

Gets a value that indicates whether the print job was saved in the queue after it printed.

IsSpooling IsSpooling IsSpooling IsSpooling

Gets a value that indicates whether the print job is being spooled.

IsUserInterventionRequired IsUserInterventionRequired IsUserInterventionRequired IsUserInterventionRequired

Gets a value that indicates whether the printer needs user intervention.

JobIdentifier JobIdentifier JobIdentifier JobIdentifier

Gets the identification number for the print job.

JobName JobName JobName JobName

Gets or sets a name for the print job.

JobSize JobSize JobSize JobSize

Get the size, in bytes, of the print job.

JobStatus JobStatus JobStatus JobStatus

Gets the current status of the print job.

JobStream JobStream JobStream JobStream

Gets a reference to the Stream of the print job.

Name Name Name Name

Gets the name of the object.

(Inherited from PrintSystemObject)
NumberOfPages NumberOfPages NumberOfPages NumberOfPages

Gets the number of pages in the print job.

NumberOfPagesPrinted NumberOfPagesPrinted NumberOfPagesPrinted NumberOfPagesPrinted

Gets the number of pages that have already printed.

Parent Parent Parent Parent

Gets the parent of the object.

(Inherited from PrintSystemObject)
PositionInPrintQueue PositionInPrintQueue PositionInPrintQueue PositionInPrintQueue

Gets the print job's place in the print queue.

Priority Priority Priority Priority

Gets a non-numerical expression that represents the priority of the print job relative to other jobs in the print queue.

PropertiesCollection PropertiesCollection PropertiesCollection PropertiesCollection

Gets a collection of attribute and value pairs.

(Inherited from PrintSystemObject)
StartTimeOfDay StartTimeOfDay StartTimeOfDay StartTimeOfDay

Gets the earliest time of day, expressed as the number of minutes after midnight Coordinated Universal Time (UTC) (also called Greenwich Mean Time [GMT]), that the print job can begin printing.

Submitter Submitter Submitter Submitter

Gets the name of the user who submitted the print job.

TimeJobSubmitted TimeJobSubmitted TimeJobSubmitted TimeJobSubmitted

Gets the date and time that the print job is submitted.

TimeSinceStartedPrinting TimeSinceStartedPrinting TimeSinceStartedPrinting TimeSinceStartedPrinting

Gets the time, in milliseconds, since the print job started printing.

UntilTimeOfDay UntilTimeOfDay UntilTimeOfDay UntilTimeOfDay

Gets the last time of day, expressed as the number of minutes after midnight Coordinated Universal Time (UTC) (also called Greenwich Mean Time [GMT]), that the print job can begin printing.

Methods

Cancel() Cancel() Cancel() Cancel()

Cancels the print job.

Commit() Commit() Commit() Commit()

Writes any changes to the properties of the PrintSystemJobInfo object to the actual print job that the object represents.

Dispose() Dispose() Dispose() Dispose()

Releases all resources used by the PrintSystemObject.

(Inherited from PrintSystemObject)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Releases the unmanaged resources used by the PrintSystemObject and optionally releases the managed resources.

(Inherited from PrintSystemObject)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Get(PrintQueue, Int32) Get(PrintQueue, Int32) Get(PrintQueue, Int32) Get(PrintQueue, Int32)

Gets the PrintSystemJobInfo for the specified job in the specified PrintQueue.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
Initialize() Initialize() Initialize() Initialize()

Initializes the properties of the PrintSystemObject.

(Inherited from PrintSystemObject)
InternalDispose(Boolean) InternalDispose(Boolean) InternalDispose(Boolean) InternalDispose(Boolean)

Releases the unmanaged resources that are used by the PrintSystemJobInfo and optionally, releases the managed resources.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Pause() Pause() Pause() Pause()

Halts printing of the job until Resume() runs.

Refresh() Refresh() Refresh() Refresh()

Updates the properties of the PrintSystemJobInfo object so that their values match the values of the actual print job that the object represents.

Restart() Restart() Restart() Restart()

Restarts a print job from the beginning.

Resume() Resume() Resume() Resume()

Resumes the printing of a paused print job.

ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to