Export (0) Print
Expand All
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.

  NameDescription
Public propertyHostingPrintQueueGets the print queue that is hosting the print job.
Public propertyHostingPrintServerGets the print server that is hosting the print queue for the print job.
Public propertyIsBlockedGets a value that indicates whether the print job is blocked and therefore, not printing.
Public propertyIsCompletedGets a value that indicates whether the print job is finished.
Public propertyIsDeletedGets a value that indicates whether the print job, which is represented by the PrintSystemJobInfo object, was deleted from the print queue.
Public propertyIsDeletingGets a value that indicates whether the print job is being deleted from the print queue.
Protected propertyIsDisposedGets or sets a value that indicates whether the object has been disposed. (Inherited from PrintSystemObject.)
Public propertyIsInErrorGets a value that indicates whether an error condition is associated with the print job.
Public propertyIsOfflineGets a value that indicates whether the printer is offline.
Public propertyIsPaperOutGets a value that indicates whether the printer has run out of the paper size and type that the print job requires.
Public propertyIsPausedGets a value that indicates whether the print job is paused.
Public propertyIsPrintedGets a value that indicates whether the print job printed.
Public propertyIsPrintingGets a value that indicates whether the print job is being printed.
Public propertyIsRestartedGets a value that indicates whether the print job has been restarted.
Public propertyIsRetainedGets a value that indicates whether the print job was saved in the queue after it printed.
Public propertyIsSpoolingGets a value that indicates whether the print job is being spooled.
Public propertyIsUserInterventionRequiredGets a value that indicates whether the printer needs user intervention.
Public propertyJobIdentifierGets the identification number for the print job.
Public propertyJobNameGets or sets a name for the print job.
Public propertyJobSizeGet the size, in bytes, of the print job.
Public propertyJobStatusGets the current status of the print job.
Public propertyJobStreamGets a reference to the Stream of the print job.
Public propertyNameGets the name of the object. (Inherited from PrintSystemObject.)
Public propertyNumberOfPagesGets the number of pages in the print job.
Public propertyNumberOfPagesPrintedGets the number of pages that have already printed.
Public propertyParentGets the parent of the object. (Inherited from PrintSystemObject.)
Public propertyPositionInPrintQueueGets the print job's place in the print queue.
Public propertyPriorityGets a non-numerical expression that represents the priority of the print job relative to other jobs in the print queue.
Public propertyPropertiesCollectionGets a collection of attribute and value pairs. (Inherited from PrintSystemObject.)
Public propertyStartTimeOfDayGets 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 propertySubmitterGets the name of the user who submitted the print job.
Public propertyTimeJobSubmittedGets the date and time that the print job is submitted.
Public propertyTimeSinceStartedPrintingGets the time, in milliseconds, since the print job started printing.
Public propertyUntilTimeOfDayGets 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
  NameDescription
Public methodCancelCancels the print job.
Public methodCommitWrites any changes to the properties of the PrintSystemJobInfo object to the actual print job that the object represents. (Overrides PrintSystemObject.Commit().)
Public methodDispose()Releases all resources used by the PrintSystemObject. (Inherited from PrintSystemObject.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the PrintSystemObject and optionally releases the managed resources. (Inherited from PrintSystemObject.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeReleases the resources that are being used by the PrintSystemObject. (Inherited from PrintSystemObject.)
Public methodStatic memberGetGets the PrintSystemJobInfo for the specified job in the specified PrintQueue.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitializeInitializes the properties of the PrintSystemObject. (Inherited from PrintSystemObject.)
Protected methodInternalDisposeReleases the unmanaged resources that are used by the PrintSystemJobInfo and optionally, releases the managed resources. (Overrides PrintSystemObject.InternalDispose(Boolean).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPauseHalts printing of the job until Resume runs.
Public methodRefreshUpdates 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 methodRestartRestarts a print job from the beginning.
Public methodResumeResumes the printing of a paused print job.
Public methodToStringReturns 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.

Caution noteCaution

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

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft. All rights reserved.