XpsDocumentWriter.WriteAsync 方法

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)

參數

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)

參數

備註

此方法不會驗證或修改特定 printTicket的指定PrintQueue值。 如有必要，使用MergeAndValidatePrintTicket該方法建立PrintTicketPrintQueue特定且適用於指定印表機的方法。

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 Write(FixedPage, PrintTicket)拋出的例外。

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)

參數

備註

批次寫入 Visual時，請使用 VisualsToXpsDocument。

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)

參數

備註

批次寫入 Visual時，請使用 VisualsToXpsDocument。

此方法不會驗證或修改特定 printTicket的指定PrintQueue值。 如有必要，使用MergeAndValidatePrintTicket該方法建立PrintTicketPrintQueue特定且適用於指定印表機的方法。

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 Write(Visual, PrintTicket)拋出的例外。

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)

參數

備註

WriteAsync非同步寫入一組文件到 XpsDocument 創建 PrintQueue的 或 XpsDocumentWriter 。 所寫入的資料包含 PrintTicket 呼叫者希望傳遞給事件處理器的額外資訊。

雖然類別 XpsDocument 名稱單一，但 an XpsDocument 可以是一份 FixedDocument 文件或多份文件集合。 此方法會在現有序列中加入一 FixedDocument 組或一組 FixedDocument 元素。

此方法不會驗證或修改特定 printTicket的指定PrintQueue值。 如有必要，使用MergeAndValidatePrintTicket該方法建立PrintTicketPrintQueue特定且適用於指定印表機的方法。

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)

參數

備註

雖然類別 XpsDocument 名稱單一，但 an XpsDocument 可以是一份 FixedDocument 文件或多份文件集合。 此方法將 a FixedDocument 加入集合。

此方法不會驗證或修改特定 printTicket的指定PrintQueue值。 如有必要，使用MergeAndValidatePrintTicket該方法建立PrintTicketPrintQueue特定且適用於指定印表機的方法。

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)

參數

備註

此方法不會驗證或修改特定 printTicket的指定PrintQueue值。 如有必要，使用MergeAndValidatePrintTicket該方法建立PrintTicketPrintQueue特定且適用於指定印表機的方法。

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)

參數

備註

若要撰寫多個 Visual 元素，請使用 VisualsToXpsDocument。

此方法不會驗證或修改特定 printTicket的指定PrintQueue值。 如有必要，使用MergeAndValidatePrintTicket該方法建立PrintTicketPrintQueue特定且適用於指定印表機的方法。

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)

參數

備註

雖然類別 XpsDocument 名稱單一，但 an XpsDocument 可以是一份 FixedDocument 文件或多份文件集合。 此方法會在現有元素集中加入一 FixedDocument 組或一組 FixedDocument 元素。

此方法不會驗證或修改特定 printTicket的指定PrintQueue值。 如有必要，使用MergeAndValidatePrintTicket該方法建立PrintTicketPrintQueue特定且適用於指定印表機的方法。

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 Write(FixedDocumentSequence, PrintTicket)拋出的例外。

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)

參數

備註

此方法不會驗證或修改特定 printTicket的指定PrintQueue值。 如有必要，使用MergeAndValidatePrintTicket該方法建立PrintTicketPrintQueue特定且適用於指定印表機的方法。

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)

參數

備註

雖然類別 XpsDocument 名稱單一，但 an XpsDocument 可以是一份 FixedDocument 文件或多份文件集合。 此方法會在現有元素集中加入一 FixedDocument 組或一組 FixedDocument 元素。

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)

參數

範例

以下範例說明如何使用此方法寫入 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 名稱單一，但 an XpsDocument 可以是一份 FixedDocument 文件或多份文件集合。 此方法會在現有元素集中加入一 FixedDocument 組或一組 FixedDocument 元素。

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 Write(FixedDocumentSequence)拋出的例外。

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)

參數

備註

雖然類別 XpsDocument 名稱單一，但 an XpsDocument 可以是一份 FixedDocument 文件或多份文件集合。 此方法將 a FixedDocument 加入集合。

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)

參數

備註

此方法不會驗證或修改特定 printTicket的指定PrintQueue值。 如有必要，使用MergeAndValidatePrintTicket該方法建立PrintTicketPrintQueue特定且適用於指定印表機的方法。

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 Write(DocumentPaginator, PrintTicket)拋出的例外。

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)

參數

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)

參數

備註

當 notificationLevel 被停用時，會XpsDocumentWriter將序列化的 XPS 文件複製到建立 XpsDocument的目標PrintQueueXpsDocumentWriter或。 啟用時 notificationLevel ，先將 XpsDocumentWriter 文件反序列化，接著重新序列化，然後在每頁輸出時寫入目標並發送進度通知。

雖然類別 XpsDocument 名稱單一，但 an XpsDocument 可以是一份 FixedDocument 文件或多份文件集合。 此方法將FixedDocument來源中的元素加入目標FixedDocument或 XpsDocument的元素序列PrintQueue中。

若 notificationLevel 指定為 ReceiveNotificationEnabled，則僅在文件序列化時產生通知，而非列印。 要接收通知，文件必須重新序列化。 當文件被重新序列化時，所有 Package 不需要依 XML 紙本規範 保留的內容都會被移除。 重新序列化同時移除標記中的所有擴充， FixedPage 包括任何擴充的 XPS 內容。

若 notificationLevel 指定為 ReceiveNotificationDisabled ，文件將不會重新序列化，且任何延伸內容即使列印後也會被保留。

此方法設計WriteAsync上不會呼叫事件。WritingPrintTicketRequired

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 Write(String, XpsDocumentNotificationLevel)拋出的例外。

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)

參數

範例

以下範例說明如何使用此方法將 a Visual 寫入 XPS 文件。

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)拋出的例外。

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)

參數

備註

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 Write(FixedPage)拋出的例外。

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)

參數

範例

以下範例說明如何使用此方法寫入 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 名稱單一，但 an XpsDocument 可以是一份 FixedDocument 文件或多份文件集合。 此方法將 a FixedDocument 加入集合。

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 Write(FixedDocument)拋出的例外。

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)

參數

範例

以下範例說明如何使用此方法寫入 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)拋出的例外。

public:
 void WriteAsync(System::String ^ documentPath);

public void WriteAsync(string documentPath);

override this.WriteAsync : string -> unit

Public Sub WriteAsync (documentPath As String)

參數

備註

雖然類別 XpsDocument 名稱單一，但 an XpsDocument 可以是一份 FixedDocument 文件或多份文件集合。 此方法將FixedDocument來源中的元素加入目標FixedDocument或 XpsDocument的元素集合PrintQueue。

此 WriteAsync 方法會重新序列化指定的 XPS 文件，移除所有 Package XML 論文 規範中不需要保留的內容。 重新序列化同時移除標記中的所有擴充， FixedPage 包括任何擴充的 XPS 內容。

此方法設計WriteAsync上不會呼叫事件。WritingPrintTicketRequired

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 Write(String)拋出的例外。

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)

參數

備註

雖然類別 XpsDocument 名稱單一，但 an XpsDocument 可以是一份 FixedDocument 文件或多份文件集合。 此方法將 a FixedDocument 加入集合。

此方法不會驗證或修改特定 printTicket的指定PrintQueue值。 如有必要，使用MergeAndValidatePrintTicket該方法建立PrintTicketPrintQueue特定且適用於指定印表機的方法。

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 Write(FixedDocument, PrintTicket)拋出的例外。