PrintQueue クラス

定義

プリンターと印刷ジョブを管理します。Manages printers and print jobs.

public ref class PrintQueue : System::Printing::PrintSystemObject
public class PrintQueue : System.Printing.PrintSystemObject
type PrintQueue = class
    inherit PrintSystemObject
Public Class PrintQueue
Inherits PrintSystemObject
継承

注釈

PrintQueue オブジェクトの一部のプロパティは、コンピューターで実行される印刷キューユーティリティの特性を表しますが、他のプロパティはプリンター自体の機能や状態を表します。Some properties of the PrintQueue object represent characteristics of the print queue utility that runs on the computer, but others represent features or states of the printer itself. たとえば、NumberOfJobs は印刷キューの特性ですが、Location はプリンターのプロパティです。For example, NumberOfJobs is a characteristic of the print queue, but Location is a property of the printer. ユーザーに注意する必要があるかどうかなど、プリンターのプロパティの多くは、プリンター自体から PrintQueue オブジェクトへの Refresh 方法を使用して渡す必要があります。Many of the properties of the printer, such as whether it needs user attention, need to be passed, by means of the Refresh method, from the printer itself to the PrintQueue object. これは、対応するプロパティ (NeedUserIntervention) がプログラムによって読み取られる前に実行する必要があります。This should be done before the corresponding property (NeedUserIntervention) is read by your program. 同様に、プログラムが PrintQueue オブジェクトの1つまたは複数のプロパティの値を変更する場合は、その変更をコンピューターの実際の印刷キューユーティリティに書き込む必要があります。Similarly, when your program changes the values of one or more properties of a PrintQueue object, the change must be written to the actual print queue utility on the computer. これを行うには、Commit メソッドを使用します。Do this with the Commit method.

注意事項

System.Printing 名前空間内のクラスは、Windows サービスまたは ASP.NET アプリケーションまたはサービス内での使用はサポートされていません。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.

Windows フォームアプリケーションから印刷する場合は、System.Drawing.Printing 名前空間を参照してください。If you want to print from a Windows Forms application, see the System.Drawing.Printing namespace.

コンストラクター

PrintQueue(PrintServer, String)

指定した PrintQueue とキュー名を使用して、PrintServer クラスの新しいインスタンスを初期化します。Initializes a new instance of PrintQueue class using the specified PrintServer and queue name.

PrintQueue(PrintServer, String, Int32)

指定した PrintQueue、キュー名、および印刷スキーマのバージョンを使用して、PrintServer クラスの新しいインスタンスを初期化します。Initializes a new instance of PrintQueue class using the specified PrintServer, queue name, and print schema version.

PrintQueue(PrintServer, String, Int32, PrintSystemDesiredAccess)

指定した PrintQueue、キュー名、印刷スキーマのバージョン、および必要なアクセスを使用して、PrintServer クラスの新しいインスタンスを初期化します。Initializes a new instance of PrintQueue class using the specified PrintServer, queue name, print schema version, and desired access.

PrintQueue(PrintServer, String, PrintQueueIndexedProperty[])

指定した PrintQueue、キュー名、および初期化する PrintServer 値の配列を使用して、PrintQueueIndexedProperty クラスの新しいインスタンスを初期化します。Initializes a new instance of PrintQueue class using the specified PrintServer, queue name, and array of PrintQueueIndexedProperty values to initialize.

PrintQueue(PrintServer, String, PrintQueueIndexedProperty[], PrintSystemDesiredAccess)

指定した PrintQueue、キュー名、初期化する PrintServer 値の配列、および必要なアクセスを使用して、PrintQueueIndexedProperty クラスの新しいインスタンスを初期化します。Initializes a new instance of PrintQueue class with the specified PrintServer, queue name, array of PrintQueueIndexedProperty values to initialize, and desired access.

PrintQueue(PrintServer, String, PrintSystemDesiredAccess)

指定した PrintQueue、キュー名、および必要なアクセスを使用して、PrintServer クラスの新しいインスタンスを初期化します。Initializes a new instance of PrintQueue class using the specified PrintServer, queue name, and desired access.

PrintQueue(PrintServer, String, String[])

指定した PrintQueue、キュー名、および初期化するプロパティ名の配列を使用して、PrintServer クラスの新しいインスタンスを初期化します。Initializes a new instance of PrintQueue class using the specified PrintServer, queue name, and array of property names to initialize.

PrintQueue(PrintServer, String, String[], PrintSystemDesiredAccess)

指定した PrintQueue、キュー名、プロパティ フィルター、および必要なアクセスを使用して、PrintServer クラスの新しいインスタンスを初期化します。Initializes a new instance of PrintQueue class using the specified PrintServer, queue name, property filter, and desired access.

プロパティ

AveragePagesPerMinute

ページ/分で測定されたプリンターの速度を取得します。Gets the speed of the printer measured in pages per minute.

ClientPrintSchemaVersion

印刷スキーマのバージョンを取得します。Gets the version of the Print Schema.

Comment

プリンターに関するコメントを取得または設定します。Gets or sets a comment about the printer.

CurrentJobSettings

現在の印刷ジョブの構成設定を格納するオブジェクトを取得します。Gets an object that contains the configuration settings for the current print job.

DefaultPrintTicket

この PrintQueue に関連付けられている既定のプリンター オプションを取得または設定します。Gets or sets the default printer options associated with this PrintQueue.

DefaultPriority

新たにキューに追加される各印刷ジョブに割り当てられる既定の優先順位を取得または設定します。Gets or sets the default priority that is given to each new print job added to the queue.

Description

印刷キューの説明を取得します。Gets a description of the print queue.

FullName

キューの完全な名前を取得します。Gets the complete name of the queue.

HasPaperProblem

特定できない用紙の問題がプリンターで発生しているかどうかを示す値を取得します。Gets a value that indicates if the printer is having an unspecified paper problem.

HasToner

プリンターにトナーがあるかどうかを示す値を取得します。Gets a value that indicates if the printer has toner.

HostingPrintServer

印刷キューを制御するプリント サーバーを取得または設定 (protected) します。Gets or sets (protected) the print server that controls the print queue.

InPartialTrust

キューが部分信頼モード (より高いレベルの信頼) で動作しているかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the queue is operating in a partially trusted mode, a higher level of trust.

IsBidiEnabled

プリンターとの双方向通信が有効かどうかを示す値を取得します。Gets a value that indicates whether bidirectional communication with the printer is enabled.

IsBusy

印刷デバイスがビジーかどうかを示す値を取得します。Gets a value that indicates whether the printing device is busy.

IsDevQueryEnabled

ドキュメントとプリンターの構成が一致しない場合にキューでドキュメントを保持するかどうかを示す値を取得します。Gets a value that indicates whether the queue holds documents when document and printer configurations do not match.

IsDirect

キューから直接プリンターに印刷するかドキュメントをスプールしてから印刷するかを示す値を取得します。Gets a value that indicates whether the queue prints directly to the printer or spools documents first and then prints them.

IsDisposed

オブジェクトが破棄されたかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the object has been disposed.

(継承元 PrintSystemObject)
IsDoorOpened

プリンターのドアが開いているかどうかを示す値を取得します。Gets a value that indicates whether a door is open on the printer.

IsHidden

アプリケーションのユーザー インターフェイスで印刷キューが非表示になっているかどうかを示す値を取得します。Gets a value that indicates whether the print queue is hidden in your application's user interface.

IsInError

プリンターやデバイスがエラー状態になっているかどうかを示す値を取得します。Gets a value that indicates whether the printer or device is in an error condition.

IsInitializing

プリンターが初期化中かどうかを示す値を取得します。Gets a value that indicates whether the printer is initializing itself.

IsIOActive

プリンターがデータやシグナルを送受信しているかどうかを示す値を取得します。Gets a value that indicates whether the printer is receiving or sending data or signals.

IsManualFeedRequired

現在の印刷ジョブで、プリンターに手差しで給紙する必要があるかどうかを示す値を取得します。Gets a value that indicates whether the printer needs to be manually fed paper for the current print job.

IsNotAvailable

プリンターが使用可能かどうかを示す値を取得します。Gets a value that indicates whether the printer is available.

IsOffline

プリンターがオフラインであるかどうかを示す値を取得します。Gets a value that indicates whether the printer is offline.

IsOutOfMemory

プリンターのメモリが不足しているかどうかを示す値を取得します。Gets a value that indicates whether the printer is out of memory.

IsOutOfPaper

現在のジョブに必要なサイズの用紙をプリンターに補充する必要があるかどうかを示す値を取得します。Gets a value that indicates whether the printer needs to be reloaded with paper of the size required for the current job.

IsOutputBinFull

プリンターの出力領域がいっぱいになっているかどうかを示す値を取得します。Gets a value that indicates whether the output area of the printer is in danger of overflowing.

IsPaperJammed

プリンターで紙詰まりが発生しているかどうかを示す値を取得します。Gets a value that indicates whether the current sheet of paper is stuck in the printer.

IsPaused

印刷キューが一時停止されているかどうかを示す値を取得します。Gets a value that indicates whether the print queue has been paused.

IsPendingDeletion

プリンターが印刷ジョブの削除中かどうかを示す値を取得します。Gets a value that indicates whether the printer is in the process of deleting a print job.

IsPowerSaveOn

プリンターが省電力モードかどうかを示す値を取得します。Gets a value that indicates whether the printer is in power save mode.

IsPrinting

ジョブが印刷中かどうかを示す値を取得します。Gets a value that indicates whether a job is printing.

IsProcessing

プリンターが印刷ジョブを処理しているかどうかを示す値を取得します。Gets a value that indicates whether the printer is processing a print job.

IsPublished

プリンターが他のネットワーク ユーザーに表示されるかどうかを示す値を取得します。Gets a value that indicates whether the printer is visible to other network users.

IsQueued

一度に複数の印刷ジョブを含むキューがプリンターでサポートされているかどうかを示す値を取得します。Gets a value that indicates whether the printer can support a queue with more than one print job in it at a time.

IsRawOnlyEnabled

印刷元のアプリケーションから Windows スプーラーへのデータ フローを高速化できる EMF (拡張メタファイル) を印刷キューで使用できるかどうかを示す値を取得します。Gets a value that indicates whether the print queue can use EMF (Enhanced Meta File) that enables faster data flow from a printing application to the Windows spooler.

IsServerUnknown

プリンターがエラー状態になっているかどうかを示す値を取得します。Gets a value that indicates whether the printer is in an error state.

IsShared

ネットワーク上の他のコンピューターがこのプリンターを使用できるかどうかを示す値を取得します。Gets a value that indicates whether the printer is available for use by other computers on the network.

IsTonerLow

プリンターのトナーが不足しているかどうかを示す値を取得します。Gets a value that indicates whether the printer is running short of toner.

IsWaiting

キューがジョブの追加を待機しているかどうかを示す値を取得します。Gets a value that indicates whether the queue is waiting for a job to be added.

IsWarmingUp

プリンターがウォームアップ中かどうかを示す値を取得します。Gets a value that indicates whether the printer is warming up.

IsXpsDevice

プリンターのドライバーが、XPSDrv モデルに基づいて構築されている (したがって、ページ記述言語として XML Paper Specification (XPS) が使用されている) かどうかを示す値を取得します。Gets a value that indicates whether the printer's driver is built on the XPSDrv model so it uses XML Paper Specification (XPS) as its page description language.

KeepPrintedJobs

キューでプリンター言語ファイルを印刷後に削除せずに保存するかどうかを示す値を取得します。Gets a value that indicates whether the queue is saving the printer language file instead of deleting it following printing.

Location

プリンターの物理的な場所を取得または設定します。Gets or sets the printer's physical location.

MaxPrintSchemaVersion

キューで使用できる印刷スキーマの最新のバージョン番号を取得します。Gets the most recent possible version number of the Print Schema that the queue can use.

Name

印刷キューの名前を取得または設定します。Gets or sets the print queue's name.

NeedUserIntervention

プリンターが人の介入を必要とするかどうかを示す値を取得します。Gets a value that indicates whether the printer needs the attention of a human being.

NumberOfJobs

印刷キューに並んでいるジョブの合計数を取得します。Gets the total number of jobs lined up in the print queue.

PagePunt

プリンターで現在のページを印刷できないかどうかを示す値を取得します。Gets a value that indicates whether the printer is unable to print the current page.

Parent

オブジェクトの親を取得します。Gets the parent of the object.

(継承元 PrintSystemObject)
PrintingIsCancelled

現在の印刷ジョブをキャンセルするかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the current print job is being cancelled.

Priority

同じプリント サーバーでホストされており、同じ物理プリンターを使用する他の印刷キューと比較した場合の、この印刷キューの優先順位を取得または設定します。Gets or sets the priority of the print queue relative to other print queues that are hosted by the same print server and that use the same physical printer.

PropertiesCollection

属性と値のペアのコレクションを取得します。Gets a collection of attribute and value pairs.

(継承元 PrintSystemObject)
QueueAttributes

印刷キューのプロパティを取得します。Gets the properties of the print queue.

QueueDriver

キューのプリンター ドライバーを取得または設定します。Gets or sets the printer driver for the queue.

QueuePort

キューが使用するポートを取得または設定します。Gets or sets the port that the queue uses.

QueuePrintProcessor

キューが使用するプリント プロセッサを取得または設定します。Gets or sets the print processor that the queue uses.

QueueStatus

プリンターのステータスを表す値を取得しますGets a value that represents the status of the printer. ("ウォームアップ中"、"初期化中"、"印刷中" など)。These include "warming up," "initializing," "printing," and others.

ScheduleCompletedJobsFirst

プリンターで、キューに入った順序や優先順位に関係なく、スプール処理が完了したジョブから先に印刷するかどうかを示す値を取得します。Gets a value that indicates whether the printer prints jobs that have completed the spooling process before jobs that have not fully spooled even if the latter entered the queue first or have a higher priority.

SeparatorFile

各印刷ジョブの先頭に挿入されるファイルのパスとファイル名を取得または設定します。Gets or sets the path and file name of a file that is inserted at the beginning of each print job.

ShareName

プリンターが共有されている場合にネットワーク上のユーザーに表示されるプリンターの名前を取得または設定します。Gets or sets a name for the printer that is seen by users on the network when it is shared.

StartTimeOfDay

プリンターがジョブを印刷する最も早い時刻を取得または設定します。この時刻は、協定世界時刻 (UTC) (グリニッジ標準時 [GMT] とも呼ばれます) の午前 0 時からの分数で表現されます。Gets or sets 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 printer will print a job.

UntilTimeOfDay

プリンターがジョブを印刷する最も遅い時刻を取得または設定します。この時刻は、協定世界時刻 (UTC) (グリニッジ標準時 [GMT] とも呼ばれます) の午前 0 時からの分数で表現されます。Gets or sets the latest time, expressed as the number of minutes after midnight Coordinated Universal Time (UTC) (also called Greenwich Mean Time [GMT]), that the printer will print a job.

UserPrintTicket

現在のユーザーの既定の PrintTicket オブジェクトを取得または設定します。このオブジェクトには、印刷ジョブに関する詳細情報が格納されます。Gets or sets the current user's default PrintTicket object which contains detailed information about the print job.

メソッド

AddJob()

Byte 配列の内容を持つ新しい (汎用的な名前が付いた) 印刷ジョブをキューに挿入します。Inserts a new (generically named) print job, whose content is a Byte array, into the queue.

AddJob(String)

Byte 配列の内容を持つ新しい印刷ジョブをキューに挿入します。Inserts a new print job, whose content is a Byte array, into the queue.

AddJob(String, PrintTicket)

XML Paper Specification (XPS)XML Paper Specification (XPS) ドキュメントの新しい印刷ジョブをキューに挿入し、指定した名前と設定を適用します。Inserts a new print job for an XML Paper Specification (XPS)XML Paper Specification (XPS) Document into the queue, and gives it the specified name and settings.

AddJob(String, String, Boolean)

XML Paper Specification (XPS)XML Paper Specification (XPS) ドキュメントの新しい印刷ジョブをキューに挿入し、指定した名前を付けて、検証する必要があるかどうかを指定します。Inserts a new print job for an XML Paper Specification (XPS)XML Paper Specification (XPS) Document into the queue, gives it the specified name, and specifies whether or not it should be validated.

AddJob(String, String, Boolean, PrintTicket)

XML Paper Specification (XPS)XML Paper Specification (XPS) ドキュメントの新しい印刷ジョブをキューに挿入し、指定した名前と設定を与え、検証する必要があるかどうかを指定します。Inserts a new print job for an XML Paper Specification (XPS)XML Paper Specification (XPS) Document into the queue, gives it the specified name and settings, and specifies whether or not it should be validated.

Commit()

PrintQueue オブジェクトの現在のプロパティをプリント サーバーの実際の印刷キューに書き込みます。Writes the current properties of the PrintQueue object to the actual print queue on the print server.

CreateXpsDocumentWriter(Double, Double)

指定したサイズで XpsDocumentWriter オブジェクトを作成します。Creates an XpsDocumentWriter object with the specified dimensions.

CreateXpsDocumentWriter(PrintDocumentImageableArea)

XpsDocumentWriter オブジェクトを作成し、Windows のコモン印刷ダイアログを開き、イメージ可能領域とメディアのサイズに関する情報を表す ref (Visual Basic の場合は ByRef) パラメーターを返します。Creates an XpsDocumentWriter object, opens a Windows common print dialog and returns a ref (ByRef in Visual Basic) parameter that represents information about the imageable area and the dimensions of the media.

CreateXpsDocumentWriter(PrintDocumentImageableArea, PageRangeSelection, PageRange)

XpsDocumentWriter オブジェクトを作成し、Windows のコモン印刷ダイアログを開いてページの範囲と印刷ジョブの説明を指定し、イメージ可能領域とメディアのサイズに関する情報を表す ref (Visual Basic の場合は ByRef) パラメーターを返します。Creates an XpsDocumentWriter object, opens a Windows common print dialog, provides the dialog with a page range and a description of the print job, and returns a ref (ByRef in Visual Basic) parameter that represents information about the imageable area and the dimensions of the media.

CreateXpsDocumentWriter(PrintQueue)

XpsDocumentWriter オブジェクトを作成し、指定した印刷キューに関連付けます。Creates an XpsDocumentWriter object and associates it with the specified print queue.

CreateXpsDocumentWriter(String, PrintDocumentImageableArea)

XpsDocumentWriter オブジェクトを作成し、Windows のコモン印刷ダイアログを開いてジョブの説明を指定し、イメージ可能領域とメディアのサイズに関する情報を表す ref (Visual Basic の場合は ByRef) パラメーターを返します。Creates an XpsDocumentWriter object, opens a Windows common print dialog (and provides it a job description) and returns a ref (ByRef in Visual Basic) parameter that represents information about the imageable area and the dimensions of the media.

CreateXpsDocumentWriter(String, PrintDocumentImageableArea, PageRangeSelection, PageRange)

XpsDocumentWriter オブジェクトを作成し、Windows のコモン印刷ダイアログを開いてページの範囲を指定し、イメージ可能領域とメディアのサイズに関する情報を表す ref (Visual Basic の場合は ByRef) パラメーターを返します。Creates an XpsDocumentWriter object, opens a Windows common print dialog, provides the dialog with a page range, and returns a ref (ByRef in Visual Basic) parameter that represents information about the imageable area and the dimensions of the media.

Dispose()

PrintSystemObject によって使用されているすべてのリソースを解放します。Releases all resources used by the PrintSystemObject.

(継承元 PrintSystemObject)
Dispose(Boolean)

PrintSystemObject によって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。Releases the unmanaged resources used by the PrintSystemObject and optionally releases the managed resources.

(継承元 PrintSystemObject)
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetJob(Int32)

指定した ID 番号の印刷ジョブを取得します。Gets the print job with the specified ID number.

GetPrintCapabilities()

プリンターの機能を識別する PrintCapabilities オブジェクトを取得します。Gets a PrintCapabilities object that identifies the capabilities of the printer.

GetPrintCapabilities(PrintTicket)

プリンターの機能を識別する PrintCapabilities オブジェクトを取得します。Gets a PrintCapabilities object that identifies the capabilities of the printer.

GetPrintCapabilitiesAsXml()

印刷スキーマに従う XML ストリームとしてプリンターの機能を指定する MemoryStream オブジェクトを取得します。Gets a MemoryStream object that specifies the printer's capabilities as an XML stream that complies with the Print Schema.

GetPrintCapabilitiesAsXml(PrintTicket)

印刷スキーマに従う XML 形式のプリンターの機能を指定する MemoryStream オブジェクトを取得します。Gets a MemoryStream object that specifies the printer's capabilities in an XML format that complies with the Print Schema.

GetPrintJobInfoCollection()

キュー内の各ジョブの PrintSystemJobInfo オブジェクトを格納するコレクションを作成します。Creates a collection that contains a PrintSystemJobInfo object for each job in the queue.

GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
Initialize()

PrintSystemObject のプロパティを初期化します。Initializes the properties of the PrintSystemObject.

(継承元 PrintSystemObject)
InternalDispose(Boolean)

PrintQueue によって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。Releases the unmanaged resources used by the PrintQueue and optionally releases the managed resources.

MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
MergeAndValidatePrintTicket(PrintTicket, PrintTicket)

2 つの PrintTicket がマージされ、結果の PrintTicket は有効な印刷チケットであり、プリンターのサポート対象外となる印刷機能は要求されないことが保証されます。Merges two PrintTickets and guarantees that the resulting PrintTicket is valid and does not ask for any printing functionality that the printer does not support.

MergeAndValidatePrintTicket(PrintTicket, PrintTicket, PrintTicketScope)

2 つの PrintTicket がマージされ、結果の PrintTicket は有効な印刷チケットであり、プリンターのサポート対象外となる印刷機能は要求されないこと、および指定したスコープに制限されることが保証されます。Merges two PrintTickets and guarantees that the resulting PrintTicket is valid, does not ask for any printing functionality that the printer does not support, and is limited to the specified scope.

Pause()

印刷キューを一時停止します。Pauses the print queue. 印刷キューは、Resume() を実行するまで一時停止したままになります。It remains paused until Resume() is executed.

Purge()

印刷キューのすべてのジョブを削除します。Removes all the jobs in the print queue.

Refresh()

PrintQueue オブジェクトのプロパティを、プリンターの値とコンピューターで実行されている印刷キュー ユーティリティの値で更新します。Updates the properties of the PrintQueue object with values from the printer and the print queue utility that runs on the computer.

Resume()

一時停止された印刷キューを再開します。Restarts a print queue that was paused.

ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

適用対象

こちらもご覧ください