This topic has not yet been rated - Rate this topic

PrintSystemJobInfo Class

Defines a print job in detail.

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

Namespace:  System.Printing
Assembly:  System.Printing (in System.Printing.dll)
public class PrintSystemJobInfo : PrintSystemObject

The PrintSystemJobInfo type exposes the following members.

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

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.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ