-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
XpsDocumentWriter.xml
2124 lines (1968 loc) · 162 KB
/
XpsDocumentWriter.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<Type Name="XpsDocumentWriter" FullName="System.Windows.Xps.XpsDocumentWriter">
<TypeSignature Language="C#" Value="public class XpsDocumentWriter : System.Windows.Documents.Serialization.SerializerWriter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit XpsDocumentWriter extends System.Windows.Documents.Serialization.SerializerWriter" />
<TypeSignature Language="DocId" Value="T:System.Windows.Xps.XpsDocumentWriter" />
<TypeSignature Language="VB.NET" Value="Public Class XpsDocumentWriter
Inherits SerializerWriter" />
<TypeSignature Language="F#" Value="type XpsDocumentWriter = class
 inherit SerializerWriter" />
<TypeSignature Language="C++ CLI" Value="public ref class XpsDocumentWriter : System::Windows::Documents::Serialization::SerializerWriter" />
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Documents.Serialization.SerializerWriter</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides methods to write to an XPS document or print queue.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Windows.Xps.XpsDocumentWriter> has no constructor. To create an <xref:System.Windows.Xps.XpsDocumentWriter>, use the static <xref:System.Windows.Xps.Packaging.XpsDocument.CreateXpsDocumentWriter%2A> method of the <xref:System.Windows.Xps.Packaging.XpsDocument> class or use one of the static <xref:System.Printing.PrintQueue.CreateXpsDocumentWriter%2A> methods of the <xref:System.Printing.PrintQueue> class. The document or the queue that creates the <xref:System.Windows.Xps.XpsDocumentWriter> becomes the target to which it writes.
## Examples
The following example shows how to create an instance of the <xref:System.Windows.Xps.XpsDocumentWriter> class.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetcreatexpsdocumentwriter":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetcreatexpsdocumentwriter":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="CancelAsync">
<MemberSignature Language="C#" Value="public override void CancelAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void CancelAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.CancelAsync" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub CancelAsync ()" />
<MemberSignature Language="F#" Value="override this.CancelAsync : unit -> unit" Usage="xpsDocumentWriter.CancelAsync " />
<MemberSignature Language="C++ CLI" Value="public:
 override void CancelAsync();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Cancels the current <see cref="Overload:System.Windows.Xps.XpsDocumentWriter.WriteAsync" /> operation.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.Windows.Xps.XpsWriterException">No asynchronous write operation is in progress.</exception>
</Docs>
</Member>
<MemberGroup MemberName="CreateVisualsCollator">
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Returns a <see cref="T:System.Windows.Xps.VisualsToXpsDocument" /> that can write <see cref="T:System.Windows.Media.Visual" /> objects to a document or print queue.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Windows.Xps.VisualsToXpsDocument> writes to the same target <xref:System.Windows.Xps.Packaging.XpsDocument> or <xref:System.Printing.PrintQueue> as the <xref:System.Windows.Xps.XpsDocumentWriter> that creates the <xref:System.Windows.Xps.VisualsToXpsDocument>.
## Examples
The following example shows how to use the <xref:System.Windows.Xps.XpsDocumentWriter.CreateVisualsCollator%2A> method.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetcreateandwritetovisualscollator":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator":::
]]></format>
</remarks>
</Docs>
</MemberGroup>
<Member MemberName="CreateVisualsCollator">
<MemberSignature Language="C#" Value="public override System.Windows.Documents.Serialization.SerializerWriterCollator CreateVisualsCollator ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Windows.Documents.Serialization.SerializerWriterCollator CreateVisualsCollator() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.CreateVisualsCollator" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CreateVisualsCollator () As SerializerWriterCollator" />
<MemberSignature Language="F#" Value="override this.CreateVisualsCollator : unit -> System.Windows.Documents.Serialization.SerializerWriterCollator" Usage="xpsDocumentWriter.CreateVisualsCollator " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::Windows::Documents::Serialization::SerializerWriterCollator ^ CreateVisualsCollator();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Documents.Serialization.SerializerWriterCollator</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a <see cref="T:System.Windows.Xps.VisualsToXpsDocument" /> that can write <see cref="T:System.Windows.Media.Visual" /> objects to a document or print queue.</summary>
<returns>The new <see cref="T:System.Windows.Xps.VisualsToXpsDocument" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Windows.Xps.VisualsToXpsDocument> writes to the same target <xref:System.Windows.Xps.Packaging.XpsDocument> or <xref:System.Printing.PrintQueue> as the <xref:System.Windows.Xps.XpsDocumentWriter> that creates the <xref:System.Windows.Xps.VisualsToXpsDocument>.
## Examples
The following example shows how to use the <xref:System.Windows.Xps.XpsDocumentWriter.CreateVisualsCollator%2A> method.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetcreateandwritetovisualscollator":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CreateVisualsCollator">
<MemberSignature Language="C#" Value="public override System.Windows.Documents.Serialization.SerializerWriterCollator CreateVisualsCollator (System.Printing.PrintTicket documentSequencePrintTicket, System.Printing.PrintTicket documentPrintTicket);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Windows.Documents.Serialization.SerializerWriterCollator CreateVisualsCollator(class System.Printing.PrintTicket documentSequencePrintTicket, class System.Printing.PrintTicket documentPrintTicket) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.CreateVisualsCollator(System.Printing.PrintTicket,System.Printing.PrintTicket)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CreateVisualsCollator (documentSequencePrintTicket As PrintTicket, documentPrintTicket As PrintTicket) As SerializerWriterCollator" />
<MemberSignature Language="F#" Value="override this.CreateVisualsCollator : System.Printing.PrintTicket * System.Printing.PrintTicket -> System.Windows.Documents.Serialization.SerializerWriterCollator" Usage="xpsDocumentWriter.CreateVisualsCollator (documentSequencePrintTicket, documentPrintTicket)" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::Windows::Documents::Serialization::SerializerWriterCollator ^ CreateVisualsCollator(System::Printing::PrintTicket ^ documentSequencePrintTicket, System::Printing::PrintTicket ^ documentPrintTicket);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Documents.Serialization.SerializerWriterCollator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="documentSequencePrintTicket" Type="System.Printing.PrintTicket" />
<Parameter Name="documentPrintTicket" Type="System.Printing.PrintTicket" />
</Parameters>
<Docs>
<param name="documentSequencePrintTicket">A <see cref="T:System.Printing.PrintTicket" /> that specifies the default printing preferences for the document sequence.</param>
<param name="documentPrintTicket">A <see cref="T:System.Printing.PrintTicket" /> that represents the default printing preferences for each document.</param>
<summary>Returns a <see cref="T:System.Windows.Xps.VisualsToXpsDocument" /> that can write <see cref="T:System.Windows.Media.Visual" /> objects with <see cref="T:System.Printing.PrintTicket" /> settings to an XPS document or print queue.</summary>
<returns>The new <see cref="T:System.Windows.Xps.VisualsToXpsDocument" /> that writes <see cref="T:System.Windows.Media.Visual" /> elements with <see cref="T:System.Printing.PrintTicket" /> settings to the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Windows.Xps.VisualsToXpsDocument> writes to the same target <xref:System.Windows.Xps.Packaging.XpsDocument> or <xref:System.Printing.PrintQueue> as the <xref:System.Windows.Xps.XpsDocumentWriter> that creates the <xref:System.Windows.Xps.VisualsToXpsDocument>.
This method does not validate or modify the specified `documentPrintTicket` for a particular <xref:System.Printing.PrintQueue>. If necessary, use the <xref:System.Printing.PrintQueue.MergeAndValidatePrintTicket%2A> method to create a <xref:System.Printing.PrintTicket> that is specific to the <xref:System.Printing.PrintQueue> and valid for a specified printer.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="raise_WritingCancelled">
<MemberSignature Language="C#" Value="public virtual void raise_WritingCancelled (object sender, System.Windows.Documents.Serialization.WritingCancelledEventArgs args);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void raise_WritingCancelled(object sender, class System.Windows.Documents.Serialization.WritingCancelledEventArgs args) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.raise_WritingCancelled(System.Object,System.Windows.Documents.Serialization.WritingCancelledEventArgs)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub raise_WritingCancelled (sender As Object, args As WritingCancelledEventArgs)" />
<MemberSignature Language="F#" Value="abstract member raise_WritingCancelled : obj * System.Windows.Documents.Serialization.WritingCancelledEventArgs -> unit
override this.raise_WritingCancelled : obj * System.Windows.Documents.Serialization.WritingCancelledEventArgs -> unit" Usage="xpsDocumentWriter.raise_WritingCancelled (sender, args)" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void raise_WritingCancelled(System::Object ^ sender, System::Windows::Documents::Serialization::WritingCancelledEventArgs ^ args);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="System.Windows.Documents.Serialization.WritingCancelledEventArgs" />
</Parameters>
<Docs>
<param name="sender">The source of the event.</param>
<param name="args">The event data.</param>
<summary>Raises the <see cref="E:System.Windows.Xps.XpsDocumentWriter.WritingCancelled" /> event.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="raise_WritingCompleted">
<MemberSignature Language="C#" Value="public virtual void raise_WritingCompleted (object sender, System.Windows.Documents.Serialization.WritingCompletedEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void raise_WritingCompleted(object sender, class System.Windows.Documents.Serialization.WritingCompletedEventArgs e) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.raise_WritingCompleted(System.Object,System.Windows.Documents.Serialization.WritingCompletedEventArgs)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub raise_WritingCompleted (sender As Object, e As WritingCompletedEventArgs)" />
<MemberSignature Language="F#" Value="abstract member raise_WritingCompleted : obj * System.Windows.Documents.Serialization.WritingCompletedEventArgs -> unit
override this.raise_WritingCompleted : obj * System.Windows.Documents.Serialization.WritingCompletedEventArgs -> unit" Usage="xpsDocumentWriter.raise_WritingCompleted (sender, e)" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void raise_WritingCompleted(System::Object ^ sender, System::Windows::Documents::Serialization::WritingCompletedEventArgs ^ e);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="System.Windows.Documents.Serialization.WritingCompletedEventArgs" />
</Parameters>
<Docs>
<param name="sender">The source of the event.</param>
<param name="e">The event data.</param>
<summary>Raises the <see cref="E:System.Windows.Xps.XpsDocumentWriter.WritingCompleted" /> event.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="raise_WritingPrintTicketRequired">
<MemberSignature Language="C#" Value="public virtual void raise_WritingPrintTicketRequired (object sender, System.Windows.Documents.Serialization.WritingPrintTicketRequiredEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void raise_WritingPrintTicketRequired(object sender, class System.Windows.Documents.Serialization.WritingPrintTicketRequiredEventArgs e) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.raise_WritingPrintTicketRequired(System.Object,System.Windows.Documents.Serialization.WritingPrintTicketRequiredEventArgs)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub raise_WritingPrintTicketRequired (sender As Object, e As WritingPrintTicketRequiredEventArgs)" />
<MemberSignature Language="F#" Value="abstract member raise_WritingPrintTicketRequired : obj * System.Windows.Documents.Serialization.WritingPrintTicketRequiredEventArgs -> unit
override this.raise_WritingPrintTicketRequired : obj * System.Windows.Documents.Serialization.WritingPrintTicketRequiredEventArgs -> unit" Usage="xpsDocumentWriter.raise_WritingPrintTicketRequired (sender, e)" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void raise_WritingPrintTicketRequired(System::Object ^ sender, System::Windows::Documents::Serialization::WritingPrintTicketRequiredEventArgs ^ e);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="System.Windows.Documents.Serialization.WritingPrintTicketRequiredEventArgs" />
</Parameters>
<Docs>
<param name="sender">The source of the event.</param>
<param name="e">The event data.</param>
<summary>Raises the <see cref="E:System.Windows.Xps.XpsDocumentWriter.WritingPrintTicketRequired" /> event.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="raise_WritingProgressChanged">
<MemberSignature Language="C#" Value="public virtual void raise_WritingProgressChanged (object sender, System.Windows.Documents.Serialization.WritingProgressChangedEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void raise_WritingProgressChanged(object sender, class System.Windows.Documents.Serialization.WritingProgressChangedEventArgs e) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.raise_WritingProgressChanged(System.Object,System.Windows.Documents.Serialization.WritingProgressChangedEventArgs)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub raise_WritingProgressChanged (sender As Object, e As WritingProgressChangedEventArgs)" />
<MemberSignature Language="F#" Value="abstract member raise_WritingProgressChanged : obj * System.Windows.Documents.Serialization.WritingProgressChangedEventArgs -> unit
override this.raise_WritingProgressChanged : obj * System.Windows.Documents.Serialization.WritingProgressChangedEventArgs -> unit" Usage="xpsDocumentWriter.raise_WritingProgressChanged (sender, e)" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void raise_WritingProgressChanged(System::Object ^ sender, System::Windows::Documents::Serialization::WritingProgressChangedEventArgs ^ e);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="System.Windows.Documents.Serialization.WritingProgressChangedEventArgs" />
</Parameters>
<Docs>
<param name="sender">The source of the event.</param>
<param name="e">The event data.</param>
<summary>Raises the <see cref="E:System.Windows.Xps.XpsDocumentWriter.WritingProgressChanged" /> event.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public void Write (string documentPath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Write(string documentPath) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub Write (documentPath As String)" />
<MemberSignature Language="F#" Value="override this.Write : string -> unit" Usage="xpsDocumentWriter.Write documentPath" />
<MemberSignature Language="C++ CLI" Value="public:
 void Write(System::String ^ documentPath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="documentPath" Type="System.String" />
</Parameters>
<Docs>
<param name="documentPath">The path of the source document.</param>
<summary>Synchronously writes a specified XPS document to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Although the <xref:System.Windows.Xps.XpsDocumentWriter> class has a singular name, an <xref:System.Windows.Xps.XpsDocumentWriter> can be one <xref:System.Windows.Documents.FixedDocument> or a set of multiple documents.
This method adds the <xref:System.Windows.Documents.FixedDocument> elements in the source to the set of <xref:System.Windows.Documents.FixedDocument> elements in the target <xref:System.Windows.Xps.XpsDocumentWriter> or <xref:System.Printing.PrintQueue>.
This `Write` method reserializes the specified XPS document, which removes all content from the <xref:System.IO.Packaging.Package> that isn't required to be preserved by the [XML Paper Specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/).
The reserialization also removes all extensions from the <xref:System.Windows.Documents.FixedPage> markup, including any extended XPS content.
By design, this `Write` method does not raise the <xref:System.Windows.Xps.XpsDocumentWriter.WritingPrintTicketRequired> event.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (System.Windows.Documents.DocumentPaginator documentPaginator);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.Windows.Documents.DocumentPaginator documentPaginator) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Documents.DocumentPaginator)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (documentPaginator As DocumentPaginator)" />
<MemberSignature Language="F#" Value="override this.Write : System.Windows.Documents.DocumentPaginator -> unit" Usage="xpsDocumentWriter.Write documentPaginator" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(System::Windows::Documents::DocumentPaginator ^ documentPaginator);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="documentPaginator" Type="System.Windows.Documents.DocumentPaginator" />
</Parameters>
<Docs>
<param name="documentPaginator">An object that contains a pointer to unpaginated source material and also contains methods for paginating the material.</param>
<summary>Writes synchronously paginated content from a specified <see cref="T:System.Windows.Documents.DocumentPaginator" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to use the <xref:System.Windows.Xps.XpsDocumentWriter.Write%2A> method to write to an XPS document.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwritetoxpswithdocumentpaginator":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwritetoxpswithdocumentpaginator":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (System.Windows.Documents.FixedDocument fixedDocument);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.Windows.Documents.FixedDocument fixedDocument) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Documents.FixedDocument)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (fixedDocument As FixedDocument)" />
<MemberSignature Language="F#" Value="override this.Write : System.Windows.Documents.FixedDocument -> unit" Usage="xpsDocumentWriter.Write fixedDocument" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(System::Windows::Documents::FixedDocument ^ fixedDocument);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fixedDocument" Type="System.Windows.Documents.FixedDocument" />
</Parameters>
<Docs>
<param name="fixedDocument">A document that is written to the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</param>
<summary>Writes synchronously a specified <see cref="T:System.Windows.Documents.FixedDocument" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Although the <xref:System.Windows.Xps.Packaging.XpsDocument> class has a singular name, an <xref:System.Windows.Xps.Packaging.XpsDocument> can be one <xref:System.Windows.Documents.FixedDocument> or a set of multiple documents. This method adds a <xref:System.Windows.Documents.FixedDocument> to the set.
## Examples
The following example shows how to use this method to write to an XPS document.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwritetoxpswithfixeddocument":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwritetoxpswithfixeddocument":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Documents.FixedDocumentSequence)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (fixedDocumentSequence As FixedDocumentSequence)" />
<MemberSignature Language="F#" Value="override this.Write : System.Windows.Documents.FixedDocumentSequence -> unit" Usage="xpsDocumentWriter.Write fixedDocumentSequence" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fixedDocumentSequence" Type="System.Windows.Documents.FixedDocumentSequence" />
</Parameters>
<Docs>
<param name="fixedDocumentSequence">A set of documents that is written to the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</param>
<summary>Writes synchronously a specified <see cref="T:System.Windows.Documents.FixedDocumentSequence" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Although the <xref:System.Windows.Xps.Packaging.XpsDocument> class has a singular name, an <xref:System.Windows.Xps.Packaging.XpsDocument> can be one <xref:System.Windows.Documents.FixedDocument> or a set of multiple documents. This method adds a <xref:System.Windows.Documents.FixedDocument> or a set of <xref:System.Windows.Documents.FixedDocument> elements to the existing set.
## Examples
The following example shows how to use the <xref:System.Windows.Xps.XpsDocumentWriter.Write%2A> method to write a sequence of XPS documents.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwritetoxpswithfixeddocumentsequence":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwritetoxpswithfixeddocumentsequence":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (System.Windows.Documents.FixedPage fixedPage);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.Windows.Documents.FixedPage fixedPage) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Documents.FixedPage)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (fixedPage As FixedPage)" />
<MemberSignature Language="F#" Value="override this.Write : System.Windows.Documents.FixedPage -> unit" Usage="xpsDocumentWriter.Write fixedPage" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(System::Windows::Documents::FixedPage ^ fixedPage);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fixedPage" Type="System.Windows.Documents.FixedPage" />
</Parameters>
<Docs>
<param name="fixedPage">A page that is written to the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</param>
<summary>Writes synchronously a specified <see cref="T:System.Windows.Documents.FixedPage" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (System.Windows.Media.Visual visual);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.Windows.Media.Visual visual) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Media.Visual)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (visual As Visual)" />
<MemberSignature Language="F#" Value="override this.Write : System.Windows.Media.Visual -> unit" Usage="xpsDocumentWriter.Write visual" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(System::Windows::Media::Visual ^ visual);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="visual" Type="System.Windows.Media.Visual" />
</Parameters>
<Docs>
<param name="visual">The <see cref="T:System.Windows.Media.Visual" /> that is written.</param>
<summary>Writes synchronously a specified <see cref="T:System.Windows.Media.Visual" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To batch write a <xref:System.Windows.Media.Visual>, use <xref:System.Windows.Xps.VisualsToXpsDocument>.
## Examples
The following example shows how to use the <xref:System.Windows.Xps.XpsDocumentWriter.Write%2A> method to write a <xref:System.Windows.Media.Visual> to an XPS document.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwritetoxpswithvisual":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwritetoxpswithvisual":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public void Write (string documentPath, System.Windows.Xps.XpsDocumentNotificationLevel notificationLevel);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Write(string documentPath, valuetype System.Windows.Xps.XpsDocumentNotificationLevel notificationLevel) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.String,System.Windows.Xps.XpsDocumentNotificationLevel)" />
<MemberSignature Language="VB.NET" Value="Public Sub Write (documentPath As String, notificationLevel As XpsDocumentNotificationLevel)" />
<MemberSignature Language="F#" Value="override this.Write : string * System.Windows.Xps.XpsDocumentNotificationLevel -> unit" Usage="xpsDocumentWriter.Write (documentPath, notificationLevel)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Write(System::String ^ documentPath, System::Windows::Xps::XpsDocumentNotificationLevel notificationLevel);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="documentPath" Type="System.String" />
<Parameter Name="notificationLevel" Type="System.Windows.Xps.XpsDocumentNotificationLevel" />
</Parameters>
<Docs>
<param name="documentPath">The path of the source document.</param>
<param name="notificationLevel">An indication of whether notification is enabled.</param>
<summary>Writes synchronously a specified XPS document to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When `notificationLevel` is disabled, the <xref:System.Windows.Xps.XpsDocumentWriter> copies the serializedXPS document to the target <xref:System.Windows.Xps.Packaging.XpsDocument> or <xref:System.Printing.PrintQueue> that created the <xref:System.Windows.Xps.XpsDocumentWriter>. When `notificationLevel` is enabled, the <xref:System.Windows.Xps.XpsDocumentWriter> first deserializes the document, next reserializes it, and then writes it to the target with progress notifications as each page is output.
Although the <xref:System.Windows.Xps.Packaging.XpsDocument> class has a singular name, an <xref:System.Windows.Xps.Packaging.XpsDocument> can be one <xref:System.Windows.Documents.FixedDocument> or a set of multiple documents. This method adds the <xref:System.Windows.Documents.FixedDocument> elements in the source to the sequence of <xref:System.Windows.Documents.FixedDocument> elements in the target <xref:System.Windows.Xps.Packaging.XpsDocument> or <xref:System.Printing.PrintQueue>.
If `notificationLevel` is specified as <xref:System.Windows.Xps.XpsDocumentNotificationLevel.ReceiveNotificationEnabled>, notifications are produced only when the document is serialized, not printed. To receive notifications the document must be reserialized. When a document is reserialized, all content from the <xref:System.IO.Packaging.Package> that's not required to be preserved by the [XML Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/) is removed. The reserialization will also remove all extensions from the <xref:System.Windows.Documents.FixedPage> markup, including any extended XPS content.
If `notificationLevel` is specified as <xref:System.Windows.Xps.XpsDocumentNotificationLevel.ReceiveNotificationDisabled> the document will not be reserialized and any extended content will be preserved, even when printed.
By design this <xref:System.Windows.Xps.XpsDocumentWriter.Write%2A> method does not call the <xref:System.Windows.Xps.XpsDocumentWriter.WritingPrintTicketRequired> event.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (System.Windows.Documents.DocumentPaginator documentPaginator, System.Printing.PrintTicket printTicket);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.Windows.Documents.DocumentPaginator documentPaginator, class System.Printing.PrintTicket printTicket) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Documents.DocumentPaginator,System.Printing.PrintTicket)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (documentPaginator As DocumentPaginator, printTicket As PrintTicket)" />
<MemberSignature Language="F#" Value="override this.Write : System.Windows.Documents.DocumentPaginator * System.Printing.PrintTicket -> unit" Usage="xpsDocumentWriter.Write (documentPaginator, printTicket)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(System::Windows::Documents::DocumentPaginator ^ documentPaginator, System::Printing::PrintTicket ^ printTicket);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="documentPaginator" Type="System.Windows.Documents.DocumentPaginator" />
<Parameter Name="printTicket" Type="System.Printing.PrintTicket" />
</Parameters>
<Docs>
<param name="documentPaginator">An object that contains a pointer to unpaginated source material and also contains methods for paginating the material.</param>
<param name="printTicket">A <see cref="T:System.Printing.PrintTicket" /> that represents the default printing preferences for material.</param>
<summary>Writes synchronously paginated content from a specified <see cref="T:System.Windows.Documents.DocumentPaginator" /> together with a <see cref="T:System.Printing.PrintTicket" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method does not validate or modify the specified `printTicket` for a particular <xref:System.Printing.PrintQueue>. If necessary, use the <xref:System.Printing.PrintQueue.MergeAndValidatePrintTicket%2A> method to create a <xref:System.Printing.PrintTicket> that is specific to the <xref:System.Printing.PrintQueue> and is valid for a specified printer.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (System.Windows.Documents.FixedDocument fixedDocument, System.Printing.PrintTicket printTicket);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.Windows.Documents.FixedDocument fixedDocument, class System.Printing.PrintTicket printTicket) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Documents.FixedDocument,System.Printing.PrintTicket)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (fixedDocument As FixedDocument, printTicket As PrintTicket)" />
<MemberSignature Language="F#" Value="override this.Write : System.Windows.Documents.FixedDocument * System.Printing.PrintTicket -> unit" Usage="xpsDocumentWriter.Write (fixedDocument, printTicket)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(System::Windows::Documents::FixedDocument ^ fixedDocument, System::Printing::PrintTicket ^ printTicket);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fixedDocument" Type="System.Windows.Documents.FixedDocument" />
<Parameter Name="printTicket" Type="System.Printing.PrintTicket" />
</Parameters>
<Docs>
<param name="fixedDocument">The document that is written.</param>
<param name="printTicket">A <see cref="T:System.Printing.PrintTicket" /> that represents the default printing preferences for the document.</param>
<summary>Writes synchronously a <see cref="T:System.Windows.Documents.FixedDocument" /> together with a <see cref="T:System.Printing.PrintTicket" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Although the <xref:System.Windows.Xps.Packaging.XpsDocument> class has a singular name, an <xref:System.Windows.Xps.Packaging.XpsDocument> can be one <xref:System.Windows.Documents.FixedDocument> or a set of multiple documents. This method adds a <xref:System.Windows.Documents.FixedDocument> to the set.
This method does not validate or modify the specified `printTicket` for a particular <xref:System.Printing.PrintQueue>. If necessary, use the <xref:System.Printing.PrintQueue.MergeAndValidatePrintTicket%2A> method to create a <xref:System.Printing.PrintTicket> that is specific to the <xref:System.Printing.PrintQueue> and is valid for a specified printer.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence, System.Printing.PrintTicket printTicket);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence, class System.Printing.PrintTicket printTicket) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Documents.FixedDocumentSequence,System.Printing.PrintTicket)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (fixedDocumentSequence As FixedDocumentSequence, printTicket As PrintTicket)" />
<MemberSignature Language="F#" Value="override this.Write : System.Windows.Documents.FixedDocumentSequence * System.Printing.PrintTicket -> unit" Usage="xpsDocumentWriter.Write (fixedDocumentSequence, printTicket)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence, System::Printing::PrintTicket ^ printTicket);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fixedDocumentSequence" Type="System.Windows.Documents.FixedDocumentSequence" />
<Parameter Name="printTicket" Type="System.Printing.PrintTicket" />
</Parameters>
<Docs>
<param name="fixedDocumentSequence">The set of documents that are written.</param>
<param name="printTicket">A <see cref="T:System.Printing.PrintTicket" /> that represents the default printing preferences for the set of documents.</param>
<summary>Writes synchronously a specified <see cref="T:System.Windows.Documents.FixedDocumentSequence" /> together with a <see cref="T:System.Printing.PrintTicket" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Although the <xref:System.Windows.Xps.Packaging.XpsDocument> class has a singular name, an <xref:System.Windows.Xps.Packaging.XpsDocument> can be one <xref:System.Windows.Documents.FixedDocument> or a set of multiple documents. This method adds a <xref:System.Windows.Documents.FixedDocument> or a set of <xref:System.Windows.Documents.FixedDocument> elements to the existing set.
This method does not validate or modify the specified `printTicket` for a particular <xref:System.Printing.PrintQueue>. If necessary, use the <xref:System.Printing.PrintQueue.MergeAndValidatePrintTicket%2A> method to create a <xref:System.Printing.PrintTicket> that is specific to the <xref:System.Printing.PrintQueue> and is valid for a specified printer.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (System.Windows.Documents.FixedPage fixedPage, System.Printing.PrintTicket printTicket);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.Windows.Documents.FixedPage fixedPage, class System.Printing.PrintTicket printTicket) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Documents.FixedPage,System.Printing.PrintTicket)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (fixedPage As FixedPage, printTicket As PrintTicket)" />
<MemberSignature Language="F#" Value="override this.Write : System.Windows.Documents.FixedPage * System.Printing.PrintTicket -> unit" Usage="xpsDocumentWriter.Write (fixedPage, printTicket)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(System::Windows::Documents::FixedPage ^ fixedPage, System::Printing::PrintTicket ^ printTicket);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fixedPage" Type="System.Windows.Documents.FixedPage" />
<Parameter Name="printTicket" Type="System.Printing.PrintTicket" />
</Parameters>
<Docs>
<param name="fixedPage">The page that is written.</param>
<param name="printTicket">A <see cref="T:System.Printing.PrintTicket" /> that represents the default printing preferences for the page.</param>
<summary>Writes synchronously a specified <see cref="T:System.Windows.Documents.FixedPage" /> together with a <see cref="T:System.Printing.PrintTicket" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method does not validate or modify the specified `printTicket` for a particular <xref:System.Printing.PrintQueue>. If necessary, use the <xref:System.Printing.PrintQueue.MergeAndValidatePrintTicket%2A> method to create a <xref:System.Printing.PrintTicket> that is specific to the <xref:System.Printing.PrintQueue> and is valid for a specified printer.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (System.Windows.Media.Visual visual, System.Printing.PrintTicket printTicket);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.Windows.Media.Visual visual, class System.Printing.PrintTicket printTicket) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Media.Visual,System.Printing.PrintTicket)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (visual As Visual, printTicket As PrintTicket)" />
<MemberSignature Language="F#" Value="override this.Write : System.Windows.Media.Visual * System.Printing.PrintTicket -> unit" Usage="xpsDocumentWriter.Write (visual, printTicket)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(System::Windows::Media::Visual ^ visual, System::Printing::PrintTicket ^ printTicket);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="visual" Type="System.Windows.Media.Visual" />
<Parameter Name="printTicket" Type="System.Printing.PrintTicket" />
</Parameters>
<Docs>
<param name="visual">The <see cref="T:System.Windows.Media.Visual" /> that is written.</param>
<param name="printTicket">A <see cref="T:System.Printing.PrintTicket" /> that represents the default printing preferences for the document.</param>
<summary>Writes synchronously a specified <see cref="T:System.Windows.Media.Visual" /> together with a <see cref="T:System.Printing.PrintTicket" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To batch write a <xref:System.Windows.Media.Visual>, use <xref:System.Windows.Xps.VisualsToXpsDocument>.
This method does not validate or modify the specified `printTicket` for a particular <xref:System.Printing.PrintQueue>. If necessary, use the <xref:System.Printing.PrintQueue.MergeAndValidatePrintTicket%2A> method to create a <xref:System.Printing.PrintTicket> that is specific to the <xref:System.Printing.PrintQueue> and is valid for a specified printer.
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="WriteAsync">
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Writes asynchronously to the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" /> that created the <see cref="T:System.Windows.Xps.XpsDocumentWriter" />.</summary>
</Docs>
</MemberGroup>
<Member MemberName="WriteAsync">
<MemberSignature Language="C#" Value="public void WriteAsync (string documentPath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteAsync(string documentPath) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.WriteAsync(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteAsync (documentPath As String)" />
<MemberSignature Language="F#" Value="override this.WriteAsync : string -> unit" Usage="xpsDocumentWriter.WriteAsync documentPath" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteAsync(System::String ^ documentPath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="documentPath" Type="System.String" />
</Parameters>
<Docs>
<param name="documentPath">The path of the source document.</param>
<summary>Writes asynchronously a specified XPS document to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Although the <xref:System.Windows.Xps.Packaging.XpsDocument> class has a singular name, an <xref:System.Windows.Xps.Packaging.XpsDocument> can be one <xref:System.Windows.Documents.FixedDocument> or a set of multiple documents. This method adds the <xref:System.Windows.Documents.FixedDocument> elements in the source to the set of <xref:System.Windows.Documents.FixedDocument> elements in the target <xref:System.Windows.Xps.Packaging.XpsDocument> or <xref:System.Printing.PrintQueue>.
This <xref:System.Windows.Xps.XpsDocumentWriter.WriteAsync%2A> method reserializes the specified XPS document, which removes all content from the <xref:System.IO.Packaging.Package> that's not required to be preserved by the [XML Paper Specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). The reserialization also removes all extensions from the <xref:System.Windows.Documents.FixedPage> markup, including any extended XPS content.
By design, this <xref:System.Windows.Xps.XpsDocumentWriter.WriteAsync%2A> method does not call the <xref:System.Windows.Xps.XpsDocumentWriter.WritingPrintTicketRequired> event.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <xref:System.ArgumentException>, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <xref:System.Windows.Xps.XpsDocumentWriter.Write(System.String)>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="WriteAsync">
<MemberSignature Language="C#" Value="public override void WriteAsync (System.Windows.Documents.DocumentPaginator documentPaginator);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void WriteAsync(class System.Windows.Documents.DocumentPaginator documentPaginator) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.XpsDocumentWriter.WriteAsync(System.Windows.Documents.DocumentPaginator)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub WriteAsync (documentPaginator As DocumentPaginator)" />
<MemberSignature Language="F#" Value="override this.WriteAsync : System.Windows.Documents.DocumentPaginator -> unit" Usage="xpsDocumentWriter.WriteAsync documentPaginator" />
<MemberSignature Language="C++ CLI" Value="public:
 override void WriteAsync(System::Windows::Documents::DocumentPaginator ^ documentPaginator);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Printing</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="documentPaginator" Type="System.Windows.Documents.DocumentPaginator" />
</Parameters>
<Docs>
<param name="documentPaginator">An object that contains a pointer to unpaginated source material and also contains methods for paginating the material.</param>
<summary>Writes asynchronously paginated content from a specified <see cref="T:System.Windows.Documents.DocumentPaginator" /> to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <xref:System.ArgumentException>, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <xref:System.Windows.Xps.XpsDocumentWriter.Write(System.Windows.Documents.DocumentPaginator)>.
## Examples
The following example shows how to use this method to write to an XPS document.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwriteasynctoxpswithdocumentpaginator":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwriteasynctoxpswithdocumentpaginator":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="WriteAsync">
<MemberSignature Language="C#" Value="public override void WriteAsync (System.Windows.Documents.FixedDocument fixedDocument);" />