XpsDocumentWriter.WriteAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
XpsDocumentを作成したPrintQueueまたはXpsDocumentWriterに非同期的に書き込みます。
オーバーロード
WriteAsync(FixedPage, Object)
指定した FixedPage をターゲット XpsDocument または PrintQueueに非同期的に書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedPage ^ fixedPage, System::Object ^ userSuppliedState);
public override void WriteAsync(System.Windows.Documents.FixedPage fixedPage, object userSuppliedState);
override this.WriteAsync : System.Windows.Documents.FixedPage * obj -> unit
Public Overrides Sub WriteAsync (fixedPage As FixedPage, userSuppliedState As Object)
パラメーター
- fixedPage
- FixedPage
書き込まれるページ。
- userSuppliedState
- Object
非同期操作を識別して関連付けるユーザー指定のオブジェクト。
適用対象
WriteAsync(FixedPage, PrintTicket)
指定した FixedPage を PrintTicket と共に非同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedPage ^ fixedPage, System::Printing::PrintTicket ^ printTicket);
public override void WriteAsync(System.Windows.Documents.FixedPage fixedPage, System.Printing.PrintTicket printTicket);
override this.WriteAsync : System.Windows.Documents.FixedPage * System.Printing.PrintTicket -> unit
Public Overrides Sub WriteAsync (fixedPage As FixedPage, printTicket As PrintTicket)
パラメーター
- fixedPage
- FixedPage
書き込まれるページ。
- printTicket
- PrintTicket
ページの既定の印刷設定を表す PrintTicket 。
注釈
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(FixedPage, PrintTicket)によってスローされる例外を参照してください。
適用対象
WriteAsync(Visual, Object)
指定した Visual をターゲット XpsDocument または PrintQueueに非同期的に書き込みます。
public:
override void WriteAsync(System::Windows::Media::Visual ^ visual, System::Object ^ userSuppliedState);
public override void WriteAsync(System.Windows.Media.Visual visual, object userSuppliedState);
override this.WriteAsync : System.Windows.Media.Visual * obj -> unit
Public Overrides Sub WriteAsync (visual As Visual, userSuppliedState As Object)
パラメーター
- userSuppliedState
- Object
非同期操作を識別して関連付けるユーザー指定のオブジェクト。
注釈
Visualをバッチ書き込むには、VisualsToXpsDocumentを使用します。
適用対象
WriteAsync(Visual, PrintTicket)
指定した Visual を PrintTicket と共に非同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void WriteAsync(System::Windows::Media::Visual ^ visual, System::Printing::PrintTicket ^ printTicket);
public override void WriteAsync(System.Windows.Media.Visual visual, System.Printing.PrintTicket printTicket);
override this.WriteAsync : System.Windows.Media.Visual * System.Printing.PrintTicket -> unit
Public Overrides Sub WriteAsync (visual As Visual, printTicket As PrintTicket)
パラメーター
- printTicket
- PrintTicket
ドキュメントの既定の印刷設定を表す PrintTicket 。
注釈
Visualをバッチ書き込むには、VisualsToXpsDocumentを使用します。
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(Visual, PrintTicket)によってスローされる例外を参照してください。
適用対象
WriteAsync(FixedDocumentSequence, PrintTicket, Object)
指定した FixedDocumentSequence を PrintTicket と共に非同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence, System::Printing::PrintTicket ^ printTicket, System::Object ^ userSuppliedState);
public override void WriteAsync(System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence, System.Printing.PrintTicket printTicket, object userSuppliedState);
override this.WriteAsync : System.Windows.Documents.FixedDocumentSequence * System.Printing.PrintTicket * obj -> unit
Public Overrides Sub WriteAsync (fixedDocumentSequence As FixedDocumentSequence, printTicket As PrintTicket, userSuppliedState As Object)
パラメーター
- fixedDocumentSequence
- FixedDocumentSequence
書き込むドキュメントのセット。
- printTicket
- PrintTicket
一連のドキュメントの既定の印刷設定を表す PrintTicket 。
- userSuppliedState
- Object
非同期操作を識別して関連付けるユーザー指定のオブジェクト。
注釈
WriteAsyncは、XpsDocumentを作成したPrintQueueまたはXpsDocumentWriterに、一連のドキュメントを非同期的に書き込みます。 書き込まれるデータには、呼び出し元がイベント ハンドラーに渡す PrintTicket と追加情報が含まれます。
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、既存のシーケンスに FixedDocument または一連の FixedDocument 要素を追加します。
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
適用対象
WriteAsync(FixedDocument, PrintTicket, Object)
指定した FixedDocument を PrintTicket と共に非同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedDocument ^ fixedDocument, System::Printing::PrintTicket ^ printTicket, System::Object ^ userSuppliedState);
public override void WriteAsync(System.Windows.Documents.FixedDocument fixedDocument, System.Printing.PrintTicket printTicket, object userSuppliedState);
override this.WriteAsync : System.Windows.Documents.FixedDocument * System.Printing.PrintTicket * obj -> unit
Public Overrides Sub WriteAsync (fixedDocument As FixedDocument, printTicket As PrintTicket, userSuppliedState As Object)
パラメーター
- fixedDocument
- FixedDocument
書き込まれるドキュメント。
- printTicket
- PrintTicket
ドキュメントの既定の印刷設定を表す PrintTicket 。
- userSuppliedState
- Object
非同期操作を識別して関連付けるユーザー指定のオブジェクト。
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、セットに FixedDocument を追加します。
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
適用対象
WriteAsync(FixedPage, PrintTicket, Object)
指定した FixedPage を PrintTicket と共に非同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedPage ^ fixedPage, System::Printing::PrintTicket ^ printTicket, System::Object ^ userSuppliedState);
public override void WriteAsync(System.Windows.Documents.FixedPage fixedPage, System.Printing.PrintTicket printTicket, object userSuppliedState);
override this.WriteAsync : System.Windows.Documents.FixedPage * System.Printing.PrintTicket * obj -> unit
Public Overrides Sub WriteAsync (fixedPage As FixedPage, printTicket As PrintTicket, userSuppliedState As Object)
パラメーター
- fixedPage
- FixedPage
書き込まれるページ。
- printTicket
- PrintTicket
ページの既定の印刷設定を表す PrintTicket 。
- userSuppliedState
- Object
非同期操作を識別して関連付けるユーザー指定のオブジェクト。
注釈
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
適用対象
WriteAsync(Visual, PrintTicket, Object)
指定した Visual を PrintTicket と共に非同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void WriteAsync(System::Windows::Media::Visual ^ visual, System::Printing::PrintTicket ^ printTicket, System::Object ^ userSuppliedState);
public override void WriteAsync(System.Windows.Media.Visual visual, System.Printing.PrintTicket printTicket, object userSuppliedState);
override this.WriteAsync : System.Windows.Media.Visual * System.Printing.PrintTicket * obj -> unit
Public Overrides Sub WriteAsync (visual As Visual, printTicket As PrintTicket, userSuppliedState As Object)
パラメーター
- printTicket
- PrintTicket
ドキュメントの既定の印刷設定を表す PrintTicket 。
- userSuppliedState
- Object
非同期操作を識別して関連付けるユーザー指定のオブジェクト。
注釈
複数の Visual 要素を記述する場合は、 VisualsToXpsDocumentを使用します。
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
適用対象
WriteAsync(FixedDocumentSequence, PrintTicket)
指定した FixedDocumentSequence を PrintTicket と共に非同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence, System::Printing::PrintTicket ^ printTicket);
public override void WriteAsync(System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence, System.Printing.PrintTicket printTicket);
override this.WriteAsync : System.Windows.Documents.FixedDocumentSequence * System.Printing.PrintTicket -> unit
Public Overrides Sub WriteAsync (fixedDocumentSequence As FixedDocumentSequence, printTicket As PrintTicket)
パラメーター
- fixedDocumentSequence
- FixedDocumentSequence
書き込まれるドキュメントのセット。
- printTicket
- PrintTicket
一連のドキュメントの既定の印刷設定を表す PrintTicket 。
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、既存のセットに FixedDocument または一連の FixedDocument 要素を追加します。
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(FixedDocumentSequence, PrintTicket)によってスローされる例外を参照してください。
適用対象
WriteAsync(DocumentPaginator, PrintTicket, Object)
指定した DocumentPaginator から非同期的にページ分割されたコンテンツを PrintTicket と共にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void WriteAsync(System::Windows::Documents::DocumentPaginator ^ documentPaginator, System::Printing::PrintTicket ^ printTicket, System::Object ^ userSuppliedState);
public override void WriteAsync(System.Windows.Documents.DocumentPaginator documentPaginator, System.Printing.PrintTicket printTicket, object userSuppliedState);
override this.WriteAsync : System.Windows.Documents.DocumentPaginator * System.Printing.PrintTicket * obj -> unit
Public Overrides Sub WriteAsync (documentPaginator As DocumentPaginator, printTicket As PrintTicket, userSuppliedState As Object)
パラメーター
- documentPaginator
- DocumentPaginator
未承認のソース マテリアルへのポインターを含むオブジェクト。には、マテリアルを改ページ分割するためのメソッドも含まれています。
- printTicket
- PrintTicket
素材の既定の印刷設定を表す PrintTicket 。
- userSuppliedState
- Object
非同期操作を識別して関連付けるユーザー指定のオブジェクト。
注釈
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
適用対象
WriteAsync(FixedDocumentSequence, Object)
指定した FixedDocumentSequence をターゲット XpsDocument または PrintQueueに非同期的に書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence, System::Object ^ userSuppliedState);
public override void WriteAsync(System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence, object userSuppliedState);
override this.WriteAsync : System.Windows.Documents.FixedDocumentSequence * obj -> unit
Public Overrides Sub WriteAsync (fixedDocumentSequence As FixedDocumentSequence, userSuppliedState As Object)
パラメーター
- fixedDocumentSequence
- FixedDocumentSequence
書き込まれるドキュメントのセット。
- userSuppliedState
- Object
非同期操作を識別して関連付けるユーザー指定のオブジェクト。
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、既存のセットに FixedDocument または一連の FixedDocument 要素を追加します。
適用対象
WriteAsync(FixedDocumentSequence)
指定した FixedDocumentSequence をターゲット XpsDocument または PrintQueueに非同期的に書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence);
public override void WriteAsync(System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence);
override this.WriteAsync : System.Windows.Documents.FixedDocumentSequence -> unit
Public Overrides Sub WriteAsync (fixedDocumentSequence As FixedDocumentSequence)
パラメーター
- fixedDocumentSequence
- FixedDocumentSequence
書き込まれるドキュメントのセット。
例
次の例は、このメソッドを使用して XPS ドキュメントに書き込む方法を示しています。
private void SaveMultipleFixedContentDocumentsAsync(
XpsDocumentWriter xpsdw, FixedDocumentSequence fds)
{
_xpsdwActive = xpsdw;
xpsdw.WritingCompleted +=
new WritingCompletedEventHandler(AsyncSaveCompleted);
xpsdw.WritingProgressChanged +=
new WritingProgressChangedEventHandler(AsyncSavingProgress);
// Write the FixedDocumentSequence as a
// collection of documents asynchronously.
xpsdw.WriteAsync(fds);
}
Private Sub SaveMultipleFixedContentDocumentsAsync(ByVal xpsdw As XpsDocumentWriter, ByVal fds As FixedDocumentSequence)
_xpsdwActive = xpsdw
AddHandler xpsdw.WritingCompleted, AddressOf AsyncSaveCompleted
AddHandler xpsdw.WritingProgressChanged, AddressOf AsyncSavingProgress
' Write the FixedDocumentSequence as a
' collection of documents asynchronously.
xpsdw.WriteAsync(fds)
End Sub
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、既存のセットに FixedDocument または一連の FixedDocument 要素を追加します。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(FixedDocumentSequence)によってスローされる例外を参照してください。
適用対象
WriteAsync(FixedDocument, Object)
指定した FixedDocument をターゲット XpsDocument または PrintQueueに非同期的に書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedDocument ^ fixedDocument, System::Object ^ userSuppliedState);
public override void WriteAsync(System.Windows.Documents.FixedDocument fixedDocument, object userSuppliedState);
override this.WriteAsync : System.Windows.Documents.FixedDocument * obj -> unit
Public Overrides Sub WriteAsync (fixedDocument As FixedDocument, userSuppliedState As Object)
パラメーター
- fixedDocument
- FixedDocument
書き込まれるドキュメント。
- userSuppliedState
- Object
非同期操作を識別して関連付けるユーザー指定のオブジェクト。
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、セットに FixedDocument を追加します。
適用対象
WriteAsync(DocumentPaginator, PrintTicket)
指定した DocumentPaginator から非同期的にページ分割されたコンテンツを PrintTicket と共にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void WriteAsync(System::Windows::Documents::DocumentPaginator ^ documentPaginator, System::Printing::PrintTicket ^ printTicket);
public override void WriteAsync(System.Windows.Documents.DocumentPaginator documentPaginator, System.Printing.PrintTicket printTicket);
override this.WriteAsync : System.Windows.Documents.DocumentPaginator * System.Printing.PrintTicket -> unit
Public Overrides Sub WriteAsync (documentPaginator As DocumentPaginator, printTicket As PrintTicket)
パラメーター
- documentPaginator
- DocumentPaginator
未承認のソース マテリアルへのポインターを含み、マテリアルを改ページ分割するメソッドも含むオブジェクト。
- printTicket
- PrintTicket
素材の既定の印刷設定を表す PrintTicket 。
注釈
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(DocumentPaginator, PrintTicket)によってスローされる例外を参照してください。
適用対象
WriteAsync(DocumentPaginator, Object)
指定した DocumentPaginator からターゲット XpsDocument または PrintQueueに非同期的にページ分割されたコンテンツを書き込みます。
public:
override void WriteAsync(System::Windows::Documents::DocumentPaginator ^ documentPaginator, System::Object ^ userSuppliedState);
public override void WriteAsync(System.Windows.Documents.DocumentPaginator documentPaginator, object userSuppliedState);
override this.WriteAsync : System.Windows.Documents.DocumentPaginator * obj -> unit
Public Overrides Sub WriteAsync (documentPaginator As DocumentPaginator, userSuppliedState As Object)
パラメーター
- documentPaginator
- DocumentPaginator
未承認のソース マテリアルへのポインターを含むオブジェクト。には、マテリアルを改ページ分割するためのメソッドも含まれています。
- userSuppliedState
- Object
非同期操作を識別して関連付けるユーザー指定のオブジェクト。
適用対象
WriteAsync(String, XpsDocumentNotificationLevel)
通知オプションを使用して、指定した XPS ドキュメントをターゲット XpsDocument または PrintQueueに非同期的に書き込みます。
public:
void WriteAsync(System::String ^ documentPath, System::Windows::Xps::XpsDocumentNotificationLevel notificationLevel);
public void WriteAsync(string documentPath, System.Windows.Xps.XpsDocumentNotificationLevel notificationLevel);
override this.WriteAsync : string * System.Windows.Xps.XpsDocumentNotificationLevel -> unit
Public Sub WriteAsync (documentPath As String, notificationLevel As XpsDocumentNotificationLevel)
パラメーター
- documentPath
- String
ソース ドキュメントのパス。
- notificationLevel
- XpsDocumentNotificationLevel
通知が有効になっているかどうかを示します。
注釈
notificationLevelを無効にすると、XpsDocumentWriterはシリアル化された XPS ドキュメントを、XpsDocumentを作成したターゲット PrintQueueまたはXpsDocumentWriterにコピーします。
notificationLevelが有効になっている場合、XpsDocumentWriterは最初にドキュメントを逆シリアル化し、次にドキュメントを再シリアル化してから、各ページが出力されるときに進行状況通知を含むターゲットに書き込みます。
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、ソース内のFixedDocument要素をターゲット FixedDocumentまたはXpsDocument内のPrintQueue要素のシーケンスに追加します。
notificationLevelがReceiveNotificationEnabledとして指定されている場合、通知はドキュメントがシリアル化されたときにのみ生成され、印刷されません。 通知を受信するには、ドキュメントを再送信する必要があります。 ドキュメントを再シリアル化すると、Package で保持する必要のないのすべてのコンテンツが削除されます。 再配信では、拡張 XPS コンテンツを含め、 FixedPage マークアップからすべての拡張機能も削除されます。
notificationLevelがReceiveNotificationDisabledとして指定されている場合、ドキュメントは再シリアル化されず、印刷時でも拡張コンテンツは保持されます。
設計上、この WriteAsync メソッドは WritingPrintTicketRequired イベントを呼び出しません。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(String, XpsDocumentNotificationLevel)によってスローされる例外を参照してください。
適用対象
WriteAsync(Visual)
指定した Visual をターゲット XpsDocument または PrintQueueに非同期的に書き込みます。
public:
override void WriteAsync(System::Windows::Media::Visual ^ visual);
public override void WriteAsync(System.Windows.Media.Visual visual);
override this.WriteAsync : System.Windows.Media.Visual -> unit
Public Overrides Sub WriteAsync (visual As Visual)
パラメーター
例
次の例は、このメソッドを使用して XPS ドキュメントに Visual を書き込む方法を示しています。
private void SaveVisualAsync(XpsDocumentWriter xpsdw, Visual v)
{
_xpsdwActive = xpsdw;
xpsdw.WritingCompleted +=
new WritingCompletedEventHandler(AsyncSaveCompleted);
xpsdw.WriteAsync(v); // Write visual to single page.
}
Private Sub SaveVisualAsync(ByVal xpsdw As XpsDocumentWriter, ByVal v As Visual)
_xpsdwActive = xpsdw
AddHandler xpsdw.WritingCompleted, AddressOf AsyncSaveCompleted
xpsdw.WriteAsync(v) ' Write visual to single page.
End Sub
注釈
Visualをバッチ書き込むには、VisualsToXpsDocumentを使用します。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(Visual)によってスローされる例外を参照してください。
適用対象
WriteAsync(FixedPage)
指定した FixedPage をターゲット XpsDocument または PrintQueueに非同期的に書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedPage ^ fixedPage);
public override void WriteAsync(System.Windows.Documents.FixedPage fixedPage);
override this.WriteAsync : System.Windows.Documents.FixedPage -> unit
Public Overrides Sub WriteAsync (fixedPage As FixedPage)
パラメーター
- fixedPage
- FixedPage
書き込まれるページ。
注釈
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(FixedPage)によってスローされる例外を参照してください。
適用対象
WriteAsync(FixedDocument)
指定した FixedDocument をターゲット XpsDocument または PrintQueueに非同期的に書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedDocument ^ fixedDocument);
public override void WriteAsync(System.Windows.Documents.FixedDocument fixedDocument);
override this.WriteAsync : System.Windows.Documents.FixedDocument -> unit
Public Overrides Sub WriteAsync (fixedDocument As FixedDocument)
パラメーター
- fixedDocument
- FixedDocument
書き込まれるドキュメント。
例
次の例は、このメソッドを使用して XPS ドキュメントに書き込む方法を示しています。
private void SaveSingleFixedContentDocumentAsync(
XpsDocumentWriter xpsdw, FixedDocument fd)
{
_xpsdwActive = xpsdw;
xpsdw.WritingCompleted +=
new WritingCompletedEventHandler(AsyncSaveCompleted);
// Write the FixedDocument as a document.
xpsdw.WriteAsync(fd);
}
Private Sub SaveSingleFixedContentDocumentAsync(ByVal xpsdw As XpsDocumentWriter, ByVal fd As FixedDocument)
_xpsdwActive = xpsdw
AddHandler xpsdw.WritingCompleted, AddressOf AsyncSaveCompleted
' Write the FixedDocument as a document.
xpsdw.WriteAsync(fd)
End Sub
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、セットに FixedDocument を追加します。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(FixedDocument)によってスローされる例外を参照してください。
適用対象
WriteAsync(DocumentPaginator)
指定した DocumentPaginator からターゲット XpsDocument または PrintQueueに非同期的にページ分割されたコンテンツを書き込みます。
public:
override void WriteAsync(System::Windows::Documents::DocumentPaginator ^ documentPaginator);
public override void WriteAsync(System.Windows.Documents.DocumentPaginator documentPaginator);
override this.WriteAsync : System.Windows.Documents.DocumentPaginator -> unit
Public Overrides Sub WriteAsync (documentPaginator As DocumentPaginator)
パラメーター
- documentPaginator
- DocumentPaginator
未承認のソース マテリアルへのポインターを含み、マテリアルを改ページ分割するメソッドも含むオブジェクト。
例
次の例は、このメソッドを使用して XPS ドキュメントに書き込む方法を示しています。
private void SaveSingleFlowContentDocumentAsync(
XpsDocumentWriter xpsdw, DocumentPaginator idp)
{
_xpsdwActive = xpsdw;
xpsdw.WritingCompleted +=
new WritingCompletedEventHandler(AsyncSaveCompleted);
// Write the IDP as a document.
xpsdw.WriteAsync(idp);
}
Private Sub SaveSingleFlowContentDocumentAsync(ByVal xpsdw As XpsDocumentWriter, ByVal idp As DocumentPaginator)
_xpsdwActive = xpsdw
AddHandler xpsdw.WritingCompleted, AddressOf AsyncSaveCompleted
' Write the IDP as a document.
xpsdw.WriteAsync(idp)
End Sub
注釈
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(DocumentPaginator)によってスローされる例外を参照してください。
適用対象
WriteAsync(String)
指定した XPS ドキュメントをターゲット XpsDocument または PrintQueueに非同期的に書き込みます。
public:
void WriteAsync(System::String ^ documentPath);
public void WriteAsync(string documentPath);
override this.WriteAsync : string -> unit
Public Sub WriteAsync (documentPath As String)
パラメーター
- documentPath
- String
ソース ドキュメントのパス。
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、ソース内のFixedDocument要素をターゲット FixedDocumentまたはXpsDocument内のPrintQueue要素のセットに追加します。
このWriteAsyncメソッドは、指定した XPS ドキュメントを再シリアル化します。これにより、Package で保持する必要のないからすべてのコンテンツが削除されます。 再配信では、拡張 XPS コンテンツを含め、 FixedPage マークアップからすべての拡張機能も削除されます。
設計上、この WriteAsync メソッドは WritingPrintTicketRequired イベントを呼び出しません。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(String)によってスローされる例外を参照してください。
適用対象
WriteAsync(FixedDocument, PrintTicket)
指定した FixedDocument を PrintTicket と共に非同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void WriteAsync(System::Windows::Documents::FixedDocument ^ fixedDocument, System::Printing::PrintTicket ^ printTicket);
public override void WriteAsync(System.Windows.Documents.FixedDocument fixedDocument, System.Printing.PrintTicket printTicket);
override this.WriteAsync : System.Windows.Documents.FixedDocument * System.Printing.PrintTicket -> unit
Public Overrides Sub WriteAsync (fixedDocument As FixedDocument, printTicket As PrintTicket)
パラメーター
- fixedDocument
- FixedDocument
書き込まれるドキュメント。
- printTicket
- PrintTicket
ドキュメントの既定の印刷設定を表す PrintTicket 。
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、セットに FixedDocument を追加します。
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Write(FixedDocument, PrintTicket)によってスローされる例外を参照してください。