PrintSystemJobInfo Class
TOC
Collapse the table of content
Expand the table of content

PrintSystemJobInfo Class

 

Defines a print job in detail.

Namespace:   System.Printing
Assembly:  System.Printing (in System.Printing.dll)

System.Object
  System.Printing.PrintSystemObject
    System.Printing.PrintSystemJobInfo

public class PrintSystemJobInfo : PrintSystemObject

NameDescription
System_CAPS_pubpropertyHostingPrintQueue

Gets the print queue that is hosting the print job.

System_CAPS_pubpropertyHostingPrintServer

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

System_CAPS_pubpropertyIsBlocked

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

System_CAPS_pubpropertyIsCompleted

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

System_CAPS_pubpropertyIsDeleted

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

System_CAPS_pubpropertyIsDeleting

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

System_CAPS_protpropertyIsDisposed

Gets or sets a value that indicates whether the object has been disposed. (Inherited from PrintSystemObject.)

System_CAPS_pubpropertyIsInError

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

System_CAPS_pubpropertyIsOffline

Gets a value that indicates whether the printer is offline.

System_CAPS_pubpropertyIsPaperOut

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

System_CAPS_pubpropertyIsPaused

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

System_CAPS_pubpropertyIsPrinted

Gets a value that indicates whether the print job printed.

System_CAPS_pubpropertyIsPrinting

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

System_CAPS_pubpropertyIsRestarted

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

System_CAPS_pubpropertyIsRetained

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

System_CAPS_pubpropertyIsSpooling

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

System_CAPS_pubpropertyIsUserInterventionRequired

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

System_CAPS_pubpropertyJobIdentifier

Gets the identification number for the print job.

System_CAPS_pubpropertyJobName

Gets or sets a name for the print job.

System_CAPS_pubpropertyJobSize

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

System_CAPS_pubpropertyJobStatus

Gets the current status of the print job.

System_CAPS_pubpropertyJobStream

Gets a reference to the Stream of the print job.

System_CAPS_pubpropertyName

Gets the name of the object. (Inherited from PrintSystemObject.)

System_CAPS_pubpropertyNumberOfPages

Gets the number of pages in the print job.

System_CAPS_pubpropertyNumberOfPagesPrinted

Gets the number of pages that have already printed.

System_CAPS_pubpropertyParent

Gets the parent of the object. (Inherited from PrintSystemObject.)

System_CAPS_pubpropertyPositionInPrintQueue

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

System_CAPS_pubpropertyPriority

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

System_CAPS_pubpropertyPropertiesCollection

Gets a collection of attribute and value pairs. (Inherited from PrintSystemObject.)

System_CAPS_pubpropertyStartTimeOfDay

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.

System_CAPS_pubpropertySubmitter

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

System_CAPS_pubpropertyTimeJobSubmitted

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

System_CAPS_pubpropertyTimeSinceStartedPrinting

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

System_CAPS_pubpropertyUntilTimeOfDay

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.

NameDescription
System_CAPS_pubmethodCancel()

Cancels the print job.

System_CAPS_pubmethodCommit()

Writes any changes to the properties of the PrintSystemJobInfo object to the actual print job that the object represents.(Overrides PrintSystemObject.Commit().)

System_CAPS_pubmethodDispose()

Releases all resources used by the PrintSystemObject. (Inherited from PrintSystemObject.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the PrintSystemObject and optionally releases the managed resources. (Inherited from PrintSystemObject.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases the resources that are being used by the PrintSystemObject. (Inherited from PrintSystemObject.)

System_CAPS_pubmethodSystem_CAPS_staticGet(PrintQueue, Int32)

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

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodInitialize()

Initializes the properties of the PrintSystemObject. (Inherited from PrintSystemObject.)

System_CAPS_protmethodInternalDispose(Boolean)

Releases the unmanaged resources that are used by the PrintSystemJobInfo and optionally, releases the managed resources.(Overrides PrintSystemObject.InternalDispose(Boolean).)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodPause()

Halts printing of the job until Resume runs.

System_CAPS_pubmethodRefresh()

Updates the properties of the PrintSystemJobInfo object so that their values match the values of the actual print job that the object represents.(Overrides PrintSystemObject.Refresh().)

System_CAPS_pubmethodRestart()

Restarts a print job from the beginning.

System_CAPS_pubmethodResume()

Resumes the printing of a paused print job.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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.

System_CAPS_cautionCaution

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.

.NET Framework
Available since 3.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft