PrintSystemJobInfo Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
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 |
Gets the print queue that is hosting the print job. |
HostingPrintServer |
Gets the print server that is hosting the print queue for the print job. |
IsBlocked |
Gets a value that indicates whether the print job is blocked and therefore, not printing. |
IsCompleted |
Gets a value that indicates whether the print job is finished. |
IsDeleted |
Gets a value that indicates whether the print job, which is represented by the PrintSystemJobInfo object, was deleted from the print queue. |
IsDeleting |
Gets a value that indicates whether the print job is being deleted from the print queue. |
IsDisposed |
Gets or sets a value that indicates whether the object has been disposed. (Inherited from PrintSystemObject) |
IsInError |
Gets a value that indicates whether an error condition is associated with the print job. |
IsOffline |
Gets a value that indicates whether the printer is offline. |
IsPaperOut |
Gets a value that indicates whether the printer has run out of the paper size and type that the print job requires. |
IsPaused |
Gets a value that indicates whether the print job is paused. |
IsPrinted |
Gets a value that indicates whether the print job printed. |
IsPrinting |
Gets a value that indicates whether the print job is being printed. |
IsRestarted |
Gets a value that indicates whether the print job has been restarted. |
IsRetained |
Gets a value that indicates whether the print job was saved in the queue after it printed. |
IsSpooling |
Gets a value that indicates whether the print job is being spooled. |
IsUserInterventionRequired |
Gets a value that indicates whether the printer needs user intervention. |
JobIdentifier |
Gets the identification number for the print job. |
JobName |
Gets or sets a name for the print job. |
JobSize |
Get the size, in bytes, of the print job. |
JobStatus |
Gets the current status of the print job. |
JobStream |
Gets a reference to the Stream of the print job. |
Name |
Gets the name of the object. (Inherited from PrintSystemObject) |
NumberOfPages |
Gets the number of pages in the print job. |
NumberOfPagesPrinted |
Gets the number of pages that have already printed. |
Parent |
Gets the parent of the object. (Inherited from PrintSystemObject) |
PositionInPrintQueue |
Gets the print job's place in the print queue. |
Priority |
Gets a non-numerical expression that represents the priority of the print job relative to other jobs in the print queue. |
PropertiesCollection |
Gets a collection of attribute and value pairs. (Inherited from PrintSystemObject) |
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 |
Gets the name of the user who submitted the print job. |
TimeJobSubmitted |
Gets the date and time that the print job is submitted. |
TimeSinceStartedPrinting |
Gets the time, in milliseconds, since the print job started printing. |
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() |
Cancels the print job. |
Commit() |
Writes any changes to the properties of the PrintSystemJobInfo object to the actual print job that the object represents. |
Dispose() |
Releases all resources used by the PrintSystemObject. (Inherited from PrintSystemObject) |
Dispose(Boolean) |
Releases the unmanaged resources used by the PrintSystemObject and optionally releases the managed resources. (Inherited from PrintSystemObject) |
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
Get(PrintQueue, Int32) |
Gets the PrintSystemJobInfo for the specified job in the specified PrintQueue. |
GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
Initialize() |
Initializes the properties of the PrintSystemObject. (Inherited from PrintSystemObject) |
InternalDispose(Boolean) |
Releases the unmanaged resources that are used by the PrintSystemJobInfo and optionally, releases the managed resources. |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
Pause() |
Halts printing of the job until Resume() runs. |
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() |
Restarts a print job from the beginning. |
Resume() |
Resumes the printing of a paused print job. |
ToString() |
Returns a string that represents the current object. (Inherited from Object) |