XpsDocumentWriter.Write メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
Write(Visual, PrintTicket)
指定した Visual と PrintTicket を同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void Write(System::Windows::Media::Visual ^ visual, System::Printing::PrintTicket ^ printTicket);
public override void Write(System.Windows.Media.Visual visual, System.Printing.PrintTicket printTicket);
override this.Write : System.Windows.Media.Visual * System.Printing.PrintTicket -> unit
Public Overrides Sub Write (visual As Visual, printTicket As PrintTicket)
パラメーター
- printTicket
- PrintTicket
ドキュメントの既定の印刷設定を表す PrintTicket 。
注釈
Visualをバッチ書き込むには、VisualsToXpsDocumentを使用します。
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
適用対象
Write(FixedPage, PrintTicket)
指定した FixedPage と PrintTicket を同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void Write(System::Windows::Documents::FixedPage ^ fixedPage, System::Printing::PrintTicket ^ printTicket);
public override void Write(System.Windows.Documents.FixedPage fixedPage, System.Printing.PrintTicket printTicket);
override this.Write : System.Windows.Documents.FixedPage * System.Printing.PrintTicket -> unit
Public Overrides Sub Write (fixedPage As FixedPage, printTicket As PrintTicket)
パラメーター
- fixedPage
- FixedPage
書き込まれるページ。
- printTicket
- PrintTicket
ページの既定の印刷設定を表す PrintTicket 。
注釈
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
適用対象
Write(FixedDocumentSequence, PrintTicket)
指定した FixedDocumentSequence と PrintTicket を同期的にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void Write(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence, System::Printing::PrintTicket ^ printTicket);
public override void Write(System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence, System.Printing.PrintTicket printTicket);
override this.Write : System.Windows.Documents.FixedDocumentSequence * System.Printing.PrintTicket -> unit
Public Overrides Sub Write (fixedDocumentSequence As FixedDocumentSequence, printTicket As PrintTicket)
パラメーター
- fixedDocumentSequence
- FixedDocumentSequence
書き込まれるドキュメントのセット。
- printTicket
- PrintTicket
一連のドキュメントの既定の印刷設定を表す PrintTicket 。
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、既存のセットに FixedDocument または一連の FixedDocument 要素を追加します。
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
適用対象
Write(FixedDocument, PrintTicket)
FixedDocumentとPrintTicketを同期的にターゲット XpsDocumentまたはPrintQueueに書き込みます。
public:
override void Write(System::Windows::Documents::FixedDocument ^ fixedDocument, System::Printing::PrintTicket ^ printTicket);
public override void Write(System.Windows.Documents.FixedDocument fixedDocument, System.Printing.PrintTicket printTicket);
override this.Write : System.Windows.Documents.FixedDocument * System.Printing.PrintTicket -> unit
Public Overrides Sub Write (fixedDocument As FixedDocument, printTicket As PrintTicket)
パラメーター
- fixedDocument
- FixedDocument
書き込まれるドキュメント。
- printTicket
- PrintTicket
ドキュメントの既定の印刷設定を表す PrintTicket 。
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、セットに FixedDocument を追加します。
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
適用対象
Write(String, XpsDocumentNotificationLevel)
指定した XPS ドキュメントをターゲット XpsDocument または PrintQueueに同期的に書き込みます。
public:
void Write(System::String ^ documentPath, System::Windows::Xps::XpsDocumentNotificationLevel notificationLevel);
public void Write(string documentPath, System.Windows.Xps.XpsDocumentNotificationLevel notificationLevel);
override this.Write : string * System.Windows.Xps.XpsDocumentNotificationLevel -> unit
Public Sub Write (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として指定されている場合、ドキュメントは再シリアル化されず、印刷時でも拡張コンテンツは保持されます。
設計上、この Write メソッドは WritingPrintTicketRequired イベントを呼び出しません。
適用対象
Write(DocumentPaginator, PrintTicket)
指定した DocumentPaginator から同期的にページ分割されたコンテンツを PrintTicket と共にターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void Write(System::Windows::Documents::DocumentPaginator ^ documentPaginator, System::Printing::PrintTicket ^ printTicket);
public override void Write(System.Windows.Documents.DocumentPaginator documentPaginator, System.Printing.PrintTicket printTicket);
override this.Write : System.Windows.Documents.DocumentPaginator * System.Printing.PrintTicket -> unit
Public Overrides Sub Write (documentPaginator As DocumentPaginator, printTicket As PrintTicket)
パラメーター
- documentPaginator
- DocumentPaginator
未承認のソース マテリアルへのポインターを含み、マテリアルを改ページ分割するメソッドも含むオブジェクト。
- printTicket
- PrintTicket
素材の既定の印刷設定を表す PrintTicket 。
注釈
このメソッドは、特定のprintTicketに対して指定されたPrintQueueを検証または変更しません。 必要に応じて、MergeAndValidatePrintTicket メソッドを使用して、PrintTicketに固有で、指定したプリンターに対して有効なPrintQueueを作成します。
適用対象
Write(FixedPage)
指定した FixedPage をターゲット XpsDocument または PrintQueueに同期的に書き込みます。
public:
override void Write(System::Windows::Documents::FixedPage ^ fixedPage);
public override void Write(System.Windows.Documents.FixedPage fixedPage);
override this.Write : System.Windows.Documents.FixedPage -> unit
Public Overrides Sub Write (fixedPage As FixedPage)
パラメーター
- fixedPage
- FixedPage
XpsDocumentに書き込まれるページ。
適用対象
Write(FixedDocumentSequence)
指定した FixedDocumentSequence をターゲット XpsDocument または PrintQueueに同期的に書き込みます。
public:
override void Write(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence);
public override void Write(System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence);
override this.Write : System.Windows.Documents.FixedDocumentSequence -> unit
Public Overrides Sub Write (fixedDocumentSequence As FixedDocumentSequence)
パラメーター
- fixedDocumentSequence
- FixedDocumentSequence
XpsDocumentに書き込まれるドキュメントのセット。
例
次の例では、 Write メソッドを使用して XPS ドキュメントのシーケンスを記述する方法を示します。
private void SaveMultipleFixedContentDocuments(
XpsDocumentWriter xpsdw, FixedDocumentSequence fds)
{
// Write the FixedDocumentSequence as a collection of documents
xpsdw.Write(fds);
}
Private Sub SaveMultipleFixedContentDocuments(ByVal xpsdw As XpsDocumentWriter, ByVal fds As FixedDocumentSequence)
' Write the FixedDocumentSequence as a collection of documents
xpsdw.Write(fds)
End Sub
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、既存のセットに FixedDocument または一連の FixedDocument 要素を追加します。
適用対象
Write(FixedDocument)
指定した FixedDocument をターゲット XpsDocument または PrintQueueに同期的に書き込みます。
public:
override void Write(System::Windows::Documents::FixedDocument ^ fixedDocument);
public override void Write(System.Windows.Documents.FixedDocument fixedDocument);
override this.Write : System.Windows.Documents.FixedDocument -> unit
Public Overrides Sub Write (fixedDocument As FixedDocument)
パラメーター
- fixedDocument
- FixedDocument
XpsDocumentに書き込まれるドキュメント。
例
次の例は、このメソッドを使用して XPS ドキュメントに書き込む方法を示しています。
private void SaveSingleFixedContentDocument(
XpsDocumentWriter xpsdw, FixedDocument fd)
{
xpsdw.Write(fd); // Write the FixedDocument as a document.
}
Private Sub SaveSingleFixedContentDocument(ByVal xpsdw As XpsDocumentWriter, ByVal fd As FixedDocument)
xpsdw.Write(fd) ' Write the FixedDocument as a document.
End Sub
注釈
XpsDocument クラスには単一の名前がありますが、XpsDocumentには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、セットに FixedDocument を追加します。
適用対象
Write(DocumentPaginator)
指定した DocumentPaginator から同期的にページ分割されたコンテンツをターゲット XpsDocument または PrintQueueに書き込みます。
public:
override void Write(System::Windows::Documents::DocumentPaginator ^ documentPaginator);
public override void Write(System.Windows.Documents.DocumentPaginator documentPaginator);
override this.Write : System.Windows.Documents.DocumentPaginator -> unit
Public Overrides Sub Write (documentPaginator As DocumentPaginator)
パラメーター
- documentPaginator
- DocumentPaginator
未承認のソース マテリアルへのポインターを含み、マテリアルを改ページ分割するメソッドも含むオブジェクト。
例
次の例は、 Write メソッドを使用して XPS ドキュメントに書き込む方法を示しています。
private void SaveSingleFlowContentDocument(
XpsDocumentWriter xpsdw, DocumentPaginator docPaginator)
{
xpsdw.Write(docPaginator); // Write the DocPaginator as a document.
}
Private Sub SaveSingleFlowContentDocument(ByVal xpsdw As XpsDocumentWriter, ByVal docPaginator As DocumentPaginator)
xpsdw.Write(docPaginator) ' Write the DocPaginator as a document.
End Sub
適用対象
Write(String)
指定した XPS ドキュメントをターゲット XpsDocument または PrintQueueに同期的に書き込みます。
public:
void Write(System::String ^ documentPath);
public void Write(string documentPath);
override this.Write : string -> unit
Public Sub Write (documentPath As String)
パラメーター
- documentPath
- String
ソース ドキュメントのパス。
注釈
XpsDocumentWriter クラスには単一の名前がありますが、XpsDocumentWriterには 1 つのFixedDocumentまたは複数のドキュメントのセットを指定できます。 このメソッドは、ソース内のFixedDocument要素をターゲット FixedDocumentまたはXpsDocumentWriter内のPrintQueue要素のセットに追加します。
このWriteメソッドは、指定された XPS ドキュメントを再シリアル化します。これにより、Package で保持する必要がないからすべてのコンテンツが削除されます。
再配信では、拡張 XPS コンテンツを含め、 FixedPage マークアップからすべての拡張機能も削除されます。
設計上、この Write メソッドは WritingPrintTicketRequired イベントを発生させません。
適用対象
Write(Visual)
指定した Visual をターゲット XpsDocument または PrintQueueに同期的に書き込みます。
public:
override void Write(System::Windows::Media::Visual ^ visual);
public override void Write(System.Windows.Media.Visual visual);
override this.Write : System.Windows.Media.Visual -> unit
Public Overrides Sub Write (visual As Visual)
パラメーター
例
次の例は、 Write メソッドを使用して XPS ドキュメントに Visual を書き込む方法を示しています。
private void SaveVisual(XpsDocumentWriter xpsdw, Visual v)
{
xpsdw.Write(v); // Write visual to single page
}
Private Sub SaveVisual(ByVal xpsdw As XpsDocumentWriter, ByVal v As Visual)
xpsdw.Write(v) ' Write visual to single page
End Sub
注釈
Visualをバッチ書き込むには、VisualsToXpsDocumentを使用します。