-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
XpsDocument.xml
1037 lines (945 loc) · 71.5 KB
/
XpsDocument.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="XpsDocument" FullName="System.Windows.Xps.Packaging.XpsDocument">
<TypeSignature Language="C#" Value="public class XpsDocument : System.Windows.Xps.Packaging.XpsPartBase, IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit XpsDocument extends System.Windows.Xps.Packaging.XpsPartBase implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:System.Windows.Xps.Packaging.XpsDocument" />
<TypeSignature Language="VB.NET" Value="Public Class XpsDocument
Inherits XpsPartBase
Implements IDisposable" />
<TypeSignature Language="F#" Value="type XpsDocument = class
 inherit XpsPartBase
 interface IDisposable" />
<TypeSignature Language="C++ CLI" Value="public ref class XpsDocument : System::Windows::Xps::Packaging::XpsPartBase, IDisposable" />
<AssemblyInfo>
<AssemblyName>ReachFramework</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.Xps.Packaging.XpsPartBase</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Provides a <see cref="T:System.IO.Packaging.Package" /> that holds the content of an XPS document.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An <xref:System.Windows.Xps.Packaging.XpsDocument> contains a <xref:System.Windows.Documents.FixedDocumentSequence> that comprises one or more <xref:System.Windows.Documents.FixedDocument> elements.
The <xref:System.Windows.Xps.Packaging.XpsDocument.%23ctor%2A> constructor is passed a reference to a <xref:System.IO.Packaging.Package> for writing, storing, and reading the content elements of the document.
A new empty XPS <xref:System.IO.Packaging.Package> is created by using the <xref:System.IO.Packaging.Package.%23ctor%2A> constructor.
An existing XPS <xref:System.IO.Packaging.Package> is opened by using the <xref:System.IO.Packaging.Package.Open%2A?displayProperty=nameWithType> method.
A <xref:System.Windows.Documents.FixedDocumentSequence> root is added to an empty XPS <xref:System.IO.Packaging.Package> by calling the <xref:System.Windows.Xps.Packaging.XpsDocument.AddFixedDocumentSequence%2A> method.
<xref:System.Printing.PrintTicket> elements with printer information and control can also be associated with the <xref:System.Windows.Documents.FixedDocumentSequence>, or on individual <xref:System.Windows.Documents.FixedDocument> and <xref:System.Windows.Documents.FixedPage> elements that are stored in the <xref:System.Windows.Xps.Packaging.XpsDocument>.
For more information about XPS, see the [XML Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/).
]]></format>
</remarks>
<altmember cref="N:System.IO.Packaging" />
<related type="ExternalDocumentation" href="https://www.ecma-international.org/publications-and-standards/standards/ecma-376/">Open Packaging Conventions (OPC) Specification</related>
<related type="ExternalDocumentation" href="https://www.ecma-international.org/publications-and-standards/standards/ecma-388/">XML Paper Specification (XPS)</related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>ReachFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreatepackageopen":::
:::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreatepackageopen":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreatepackageopen":::
The following example also shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializelinked":::
]]></format>
</remarks>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public XpsDocument (System.IO.Packaging.Package package);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Packaging.Package package) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.#ctor(System.IO.Packaging.Package)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (package As Package)" />
<MemberSignature Language="F#" Value="new System.Windows.Xps.Packaging.XpsDocument : System.IO.Packaging.Package -> System.Windows.Xps.Packaging.XpsDocument" Usage="new System.Windows.Xps.Packaging.XpsDocument package" />
<MemberSignature Language="C++ CLI" Value="public:
 XpsDocument(System::IO::Packaging::Package ^ package);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="package" Type="System.IO.Packaging.Package" />
</Parameters>
<Docs>
<param name="package">The target XPS package for the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> class with access to a specified XML Paper Specification (XPS) <see cref="T:System.IO.Packaging.Package" /> and default interleaving, resource, and compression options.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreatepackageopen":::
:::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreatepackageopen":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreatepackageopen":::
The following example also shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializelinked":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public XpsDocument (System.IO.Packaging.Package package, System.IO.Packaging.CompressionOption compressionOption);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Packaging.Package package, valuetype System.IO.Packaging.CompressionOption compressionOption) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.#ctor(System.IO.Packaging.Package,System.IO.Packaging.CompressionOption)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (package As Package, compressionOption As CompressionOption)" />
<MemberSignature Language="F#" Value="new System.Windows.Xps.Packaging.XpsDocument : System.IO.Packaging.Package * System.IO.Packaging.CompressionOption -> System.Windows.Xps.Packaging.XpsDocument" Usage="new System.Windows.Xps.Packaging.XpsDocument (package, compressionOption)" />
<MemberSignature Language="C++ CLI" Value="public:
 XpsDocument(System::IO::Packaging::Package ^ package, System::IO::Packaging::CompressionOption compressionOption);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="package" Type="System.IO.Packaging.Package" />
<Parameter Name="compressionOption" Type="System.IO.Packaging.CompressionOption" />
</Parameters>
<Docs>
<param name="package">The target package for the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</param>
<param name="compressionOption">The package compression option.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> class that is contained in a specified <see cref="T:System.IO.Packaging.Package" /> with specified default interleaving, resource, and compression options.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreatepackageopen":::
:::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreatepackageopen":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreatepackageopen":::
The following example also shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializelinked":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public XpsDocument (string path, System.IO.FileAccess packageAccess);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path, valuetype System.IO.FileAccess packageAccess) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.#ctor(System.String,System.IO.FileAccess)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (path As String, packageAccess As FileAccess)" />
<MemberSignature Language="F#" Value="new System.Windows.Xps.Packaging.XpsDocument : string * System.IO.FileAccess -> System.Windows.Xps.Packaging.XpsDocument" Usage="new System.Windows.Xps.Packaging.XpsDocument (path, packageAccess)" />
<MemberSignature Language="C++ CLI" Value="public:
 XpsDocument(System::String ^ path, System::IO::FileAccess packageAccess);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="path" Type="System.String" />
<Parameter Name="packageAccess" Type="System.IO.FileAccess" />
</Parameters>
<Docs>
<param name="path">The path and file name of the target <see cref="T:System.IO.Packaging.Package" /> for the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</param>
<param name="packageAccess">The file I/O mode in which to open the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> class that is contained in a specified <see cref="T:System.IO.Packaging.Package" /> file with default interleaving, resource, and compression options.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreatepackageopen":::
:::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreatepackageopen":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreatepackageopen":::
The following example also shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializelinked":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public XpsDocument (System.IO.Packaging.Package package, System.IO.Packaging.CompressionOption compressionOption, string path);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Packaging.Package package, valuetype System.IO.Packaging.CompressionOption compressionOption, string path) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.#ctor(System.IO.Packaging.Package,System.IO.Packaging.CompressionOption,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (package As Package, compressionOption As CompressionOption, path As String)" />
<MemberSignature Language="F#" Value="new System.Windows.Xps.Packaging.XpsDocument : System.IO.Packaging.Package * System.IO.Packaging.CompressionOption * string -> System.Windows.Xps.Packaging.XpsDocument" Usage="new System.Windows.Xps.Packaging.XpsDocument (package, compressionOption, path)" />
<MemberSignature Language="C++ CLI" Value="public:
 XpsDocument(System::IO::Packaging::Package ^ package, System::IO::Packaging::CompressionOption compressionOption, System::String ^ path);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<Parameters>
<Parameter Name="package" Type="System.IO.Packaging.Package" />
<Parameter Name="compressionOption" Type="System.IO.Packaging.CompressionOption" />
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="package">The target package for the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</param>
<param name="compressionOption">The package compression option.</param>
<param name="path">The uniform resource identifier (URI) for the document as a string.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> class that is contained in a specified <see cref="T:System.IO.Packaging.Package" /> with the specified default interleaving, resource, and compression options.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreatepackageopen":::
:::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreatepackageopen":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreatepackageopen":::
The following example also shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializelinked":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public XpsDocument (string path, System.IO.FileAccess packageAccess, System.IO.Packaging.CompressionOption compressionOption);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path, valuetype System.IO.FileAccess packageAccess, valuetype System.IO.Packaging.CompressionOption compressionOption) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.#ctor(System.String,System.IO.FileAccess,System.IO.Packaging.CompressionOption)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (path As String, packageAccess As FileAccess, compressionOption As CompressionOption)" />
<MemberSignature Language="F#" Value="new System.Windows.Xps.Packaging.XpsDocument : string * System.IO.FileAccess * System.IO.Packaging.CompressionOption -> System.Windows.Xps.Packaging.XpsDocument" Usage="new System.Windows.Xps.Packaging.XpsDocument (path, packageAccess, compressionOption)" />
<MemberSignature Language="C++ CLI" Value="public:
 XpsDocument(System::String ^ path, System::IO::FileAccess packageAccess, System::IO::Packaging::CompressionOption compressionOption);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<Parameters>
<Parameter Name="path" Type="System.String" />
<Parameter Name="packageAccess" Type="System.IO.FileAccess" />
<Parameter Name="compressionOption" Type="System.IO.Packaging.CompressionOption" />
</Parameters>
<Docs>
<param name="path">The path and file name of the target <see cref="T:System.IO.Packaging.Package" /> for the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</param>
<param name="packageAccess">The file I/O mode in which to open the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</param>
<param name="compressionOption">The package compression option.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> class that is contained in a specified <see cref="T:System.IO.Packaging.Package" /> file with default interleaving, resource, and compression options.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreatepackageopen":::
:::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreatepackageopen":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreatepackageopen":::
The following example also shows how to create and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializelinked":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="AddFixedDocumentSequence">
<MemberSignature Language="C#" Value="public System.Windows.Xps.Packaging.IXpsFixedDocumentSequenceWriter AddFixedDocumentSequence ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Xps.Packaging.IXpsFixedDocumentSequenceWriter AddFixedDocumentSequence() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.AddFixedDocumentSequence" />
<MemberSignature Language="VB.NET" Value="Public Function AddFixedDocumentSequence () As IXpsFixedDocumentSequenceWriter" />
<MemberSignature Language="F#" Value="member this.AddFixedDocumentSequence : unit -> System.Windows.Xps.Packaging.IXpsFixedDocumentSequenceWriter" Usage="xpsDocument.AddFixedDocumentSequence " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Windows::Xps::Packaging::IXpsFixedDocumentSequenceWriter ^ AddFixedDocumentSequence();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Windows.Xps.Packaging.IXpsFixedDocumentSequenceWriter</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Adds a root <see cref="T:System.Windows.Documents.FixedDocumentSequence" /> to the package and returns a writer.</summary>
<returns>The XML Paper Specification (XPS) fixed-document sequence writer for this <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Although this class uses a singular name, an <xref:System.Windows.Xps.Packaging.XpsDocument> can be a set (sequence) of one <xref:System.Windows.Documents.FixedDocument> or multiple documents.
## Examples
The following example shows how to use the <xref:System.Windows.Xps.Packaging.XpsDocument.AddFixedDocumentSequence%2A> method to insert content into an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpkgcontent":::
:::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpkgcontent":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpkgcontent":::
]]></format>
</remarks>
<altmember cref="P:System.Windows.Xps.Packaging.XpsDocument.FixedDocumentSequenceReader" />
</Docs>
</Member>
<Member MemberName="AddThumbnail">
<MemberSignature Language="C#" Value="public System.Windows.Xps.Packaging.XpsThumbnail AddThumbnail (System.Windows.Xps.Packaging.XpsImageType imageType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Xps.Packaging.XpsThumbnail AddThumbnail(valuetype System.Windows.Xps.Packaging.XpsImageType imageType) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.AddThumbnail(System.Windows.Xps.Packaging.XpsImageType)" />
<MemberSignature Language="VB.NET" Value="Public Function AddThumbnail (imageType As XpsImageType) As XpsThumbnail" />
<MemberSignature Language="F#" Value="member this.AddThumbnail : System.Windows.Xps.Packaging.XpsImageType -> System.Windows.Xps.Packaging.XpsThumbnail" Usage="xpsDocument.AddThumbnail imageType" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Windows::Xps::Packaging::XpsThumbnail ^ AddThumbnail(System::Windows::Xps::Packaging::XpsImageType imageType);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Windows.Xps.Packaging.XpsThumbnail</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="imageType" Type="System.Windows.Xps.Packaging.XpsImageType" />
</Parameters>
<Docs>
<param name="imageType">The format of the image.</param>
<summary>Adds a thumbnail image to the package.</summary>
<returns>The newly added <see cref="T:System.Windows.Xps.Packaging.XpsThumbnail" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Close">
<MemberSignature Language="C#" Value="public void Close ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Close() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.Close" />
<MemberSignature Language="VB.NET" Value="Public Sub Close ()" />
<MemberSignature Language="F#" Value="member this.Close : unit -> unit" Usage="xpsDocument.Close " />
<MemberSignature Language="C++ CLI" Value="public:
 void Close();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Closes the XPS document <see cref="T:System.IO.Packaging.Package" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the <xref:System.Windows.Xps.Packaging.XpsDocument> was opened for write access, data buffers are written to the store and the physical document <xref:System.IO.Packaging.Package> is closed.
After <xref:System.Windows.Xps.Packaging.XpsDocument.Close%2A> has been called, no parts of the document can be accessed with this <xref:System.Windows.Xps.Packaging.XpsDocument> instance.
## Examples
The following example shows how to open, insert content, and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreatepackageopen":::
:::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreatepackageopen":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreatepackageopen":::
The following example also shows how to open, write to, and close an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializelinked":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CoreDocumentProperties">
<MemberSignature Language="C#" Value="public System.IO.Packaging.PackageProperties CoreDocumentProperties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IO.Packaging.PackageProperties CoreDocumentProperties" />
<MemberSignature Language="DocId" Value="P:System.Windows.Xps.Packaging.XpsDocument.CoreDocumentProperties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CoreDocumentProperties As PackageProperties" />
<MemberSignature Language="F#" Value="member this.CoreDocumentProperties : System.IO.Packaging.PackageProperties" Usage="System.Windows.Xps.Packaging.XpsDocument.CoreDocumentProperties" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IO::Packaging::PackageProperties ^ CoreDocumentProperties { System::IO::Packaging::PackageProperties ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.IO.Packaging.PackageProperties</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the core <see cref="T:System.IO.Packaging.PackageProperties" /> of the XPS document.</summary>
<value>The core properties of the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /><see cref="T:System.IO.Packaging.Package" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateXpsDocumentWriter">
<MemberSignature Language="C#" Value="public static System.Windows.Xps.XpsDocumentWriter CreateXpsDocumentWriter (System.Windows.Xps.Packaging.XpsDocument xpsDocument);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Windows.Xps.XpsDocumentWriter CreateXpsDocumentWriter(class System.Windows.Xps.Packaging.XpsDocument xpsDocument) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.CreateXpsDocumentWriter(System.Windows.Xps.Packaging.XpsDocument)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateXpsDocumentWriter (xpsDocument As XpsDocument) As XpsDocumentWriter" />
<MemberSignature Language="F#" Value="static member CreateXpsDocumentWriter : System.Windows.Xps.Packaging.XpsDocument -> System.Windows.Xps.XpsDocumentWriter" Usage="System.Windows.Xps.Packaging.XpsDocument.CreateXpsDocumentWriter xpsDocument" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::Windows::Xps::XpsDocumentWriter ^ CreateXpsDocumentWriter(System::Windows::Xps::Packaging::XpsDocument ^ xpsDocument);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Windows.Xps.XpsDocumentWriter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="xpsDocument" Type="System.Windows.Xps.Packaging.XpsDocument" />
</Parameters>
<Docs>
<param name="xpsDocument">The XPS document to write.</param>
<summary>Creates an <see cref="T:System.Windows.Xps.XpsDocumentWriter" /> for writing an <see cref="T:System.Windows.Xps.Packaging.XpsDocument" />.</summary>
<returns>The <see cref="T:System.Windows.Xps.XpsDocumentWriter" /> to use for writing the XML Paper Specification (XPS) document.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to use the <xref:System.Windows.Xps.Packaging.XpsDocument.CreateXpsDocumentWriter%2A> method in order to write an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializelinked":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="xpsDocument.Dispose disposing" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual void Dispose(bool disposing);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<summary>Releases the unmanaged resources that are used by the <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> and optionally, releases the managed resources.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is called by the public `Dispose()` method and the <xref:System.Object.Finalize> method, if it has been overridden. `Dispose()` invokes this method with the `disposing` parameter set to `true`. `Finalize` invokes this method with `disposing` set to `false`.
When the `disposing` parameter is true, this method releases all resources that are held by any managed objects that this <xref:System.Windows.Xps.Packaging.XpsDocument> references. This method invokes the `Dispose()` method of each referenced object.
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>Other objects can call <see langword="Dispose" /> multiple times. When you override <see langword="Dispose(Boolean)" />, be careful not to reference objects that were previously disposed of in an earlier call to <see langword="Dispose" />. For more information about how to implement <see langword="Dispose(Boolean)" />, see [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose).
For more information about <see langword="Dispose" /> and <see cref="M:System.Object.Finalize" />, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Overriding the Finalize Method](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ddae83kx(v=vs.100)).</para>
</block>
</Docs>
</Member>
<Member MemberName="FixedDocumentSequenceReader">
<MemberSignature Language="C#" Value="public System.Windows.Xps.Packaging.IXpsFixedDocumentSequenceReader FixedDocumentSequenceReader { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Xps.Packaging.IXpsFixedDocumentSequenceReader FixedDocumentSequenceReader" />
<MemberSignature Language="DocId" Value="P:System.Windows.Xps.Packaging.XpsDocument.FixedDocumentSequenceReader" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property FixedDocumentSequenceReader As IXpsFixedDocumentSequenceReader" />
<MemberSignature Language="F#" Value="member this.FixedDocumentSequenceReader : System.Windows.Xps.Packaging.IXpsFixedDocumentSequenceReader" Usage="System.Windows.Xps.Packaging.XpsDocument.FixedDocumentSequenceReader" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Xps::Packaging::IXpsFixedDocumentSequenceReader ^ FixedDocumentSequenceReader { System::Windows::Xps::Packaging::IXpsFixedDocumentSequenceReader ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Windows.Xps.Packaging.IXpsFixedDocumentSequenceReader</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets an <see cref="T:System.Windows.Xps.Packaging.IXpsFixedDocumentSequenceReader" /> for reading the document.</summary>
<value>An <see cref="T:System.Windows.Xps.Packaging.IXpsFixedDocumentSequenceReader" /> for reading the document.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Although this class uses a singular name, an <xref:System.Windows.Xps.Packaging.XpsDocument> can be a set (sequence) of one <xref:System.Windows.Documents.FixedDocument> or multiple documents.
## Examples
The following example shows how to get a <xref:System.Windows.Xps.Packaging.XpsDocument.FixedDocumentSequenceReader%2A> in order to access <xref:System.Windows.Documents.FixedDocument> parts in an <xref:System.Windows.Xps.Packaging.XpsDocument>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Documents.DocumentStructures/FigureStructure/Overview/Window1.xaml.cs" id="Snippetdocstrucfixeddoc":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/DocumentStructure/visualbasic/window1.xaml.vb" id="Snippetdocstrucfixeddoc":::
]]></format>
</remarks>
<altmember cref="M:System.Windows.Xps.Packaging.XpsDocument.GetFixedDocumentSequence" />
<altmember cref="M:System.Windows.Xps.Packaging.XpsDocument.AddFixedDocumentSequence" />
</Docs>
</Member>
<Member MemberName="GetFixedDocumentSequence">
<MemberSignature Language="C#" Value="public System.Windows.Documents.FixedDocumentSequence GetFixedDocumentSequence ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Documents.FixedDocumentSequence GetFixedDocumentSequence() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.GetFixedDocumentSequence" />
<MemberSignature Language="VB.NET" Value="Public Function GetFixedDocumentSequence () As FixedDocumentSequence" />
<MemberSignature Language="F#" Value="member this.GetFixedDocumentSequence : unit -> System.Windows.Documents.FixedDocumentSequence" Usage="xpsDocument.GetFixedDocumentSequence " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Windows::Documents::FixedDocumentSequence ^ GetFixedDocumentSequence();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Windows.Documents.FixedDocumentSequence</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the fixed-document sequence at the root of the package.</summary>
<returns>The <see cref="T:System.Windows.Documents.FixedDocumentSequence" /> of the package.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Although this class uses a singular name, an <xref:System.Windows.Xps.Packaging.XpsDocument> can be a set (sequence) of one <xref:System.Windows.Documents.FixedDocument> or multiple documents.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IsReader">
<MemberSignature Language="C#" Value="public bool IsReader { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsReader" />
<MemberSignature Language="DocId" Value="P:System.Windows.Xps.Packaging.XpsDocument.IsReader" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsReader As Boolean" />
<MemberSignature Language="F#" Value="member this.IsReader : bool" Usage="System.Windows.Xps.Packaging.XpsDocument.IsReader" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsReader { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether the package is readable.</summary>
<value>
<see langword="true" /> if the package is readable; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<altmember cref="P:System.Windows.Xps.Packaging.XpsDocument.IsWriter" />
</Docs>
</Member>
<Member MemberName="IsSignable">
<MemberSignature Language="C#" Value="public bool IsSignable { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsSignable" />
<MemberSignature Language="DocId" Value="P:System.Windows.Xps.Packaging.XpsDocument.IsSignable" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsSignable As Boolean" />
<MemberSignature Language="F#" Value="member this.IsSignable : bool" Usage="System.Windows.Xps.Packaging.XpsDocument.IsSignable" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsSignable { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether the package can be digitally signed.</summary>
<value>
<see langword="true" /> if the package can be signed; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsWriter">
<MemberSignature Language="C#" Value="public bool IsWriter { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsWriter" />
<MemberSignature Language="DocId" Value="P:System.Windows.Xps.Packaging.XpsDocument.IsWriter" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsWriter As Boolean" />
<MemberSignature Language="F#" Value="member this.IsWriter : bool" Usage="System.Windows.Xps.Packaging.XpsDocument.IsWriter" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsWriter { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether the package is writable.</summary>
<value>
<see langword="true" /> if the package is writable; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<altmember cref="P:System.Windows.Xps.Packaging.XpsDocument.IsReader" />
</Docs>
</Member>
<Member MemberName="RemoveSignature">
<MemberSignature Language="C#" Value="public void RemoveSignature (System.Windows.Xps.Packaging.XpsDigitalSignature signature);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveSignature(class System.Windows.Xps.Packaging.XpsDigitalSignature signature) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.RemoveSignature(System.Windows.Xps.Packaging.XpsDigitalSignature)" />
<MemberSignature Language="VB.NET" Value="Public Sub RemoveSignature (signature As XpsDigitalSignature)" />
<MemberSignature Language="F#" Value="member this.RemoveSignature : System.Windows.Xps.Packaging.XpsDigitalSignature -> unit" Usage="xpsDocument.RemoveSignature signature" />
<MemberSignature Language="C++ CLI" Value="public:
 void RemoveSignature(System::Windows::Xps::Packaging::XpsDigitalSignature ^ signature);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="signature" Type="System.Windows.Xps.Packaging.XpsDigitalSignature" />
</Parameters>
<Docs>
<param name="signature">The signature that is deleted.</param>
<summary>Deletes a signature from the package.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Signatures">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.ReadOnlyCollection<System.Windows.Xps.Packaging.XpsDigitalSignature> Signatures { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.ReadOnlyCollection`1<class System.Windows.Xps.Packaging.XpsDigitalSignature> Signatures" />
<MemberSignature Language="DocId" Value="P:System.Windows.Xps.Packaging.XpsDocument.Signatures" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Signatures As ReadOnlyCollection(Of XpsDigitalSignature)" />
<MemberSignature Language="F#" Value="member this.Signatures : System.Collections.ObjectModel.ReadOnlyCollection<System.Windows.Xps.Packaging.XpsDigitalSignature>" Usage="System.Windows.Xps.Packaging.XpsDocument.Signatures" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::ObjectModel::ReadOnlyCollection<System::Windows::Xps::Packaging::XpsDigitalSignature ^> ^ Signatures { System::Collections::ObjectModel::ReadOnlyCollection<System::Windows::Xps::Packaging::XpsDigitalSignature ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.ReadOnlyCollection<System.Windows.Xps.Packaging.XpsDigitalSignature></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a collection of XML Paper Specification (XPS) signatures that are associated with the package.</summary>
<value>A <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1" /> of <see cref="T:System.Windows.Xps.Packaging.XpsDigitalSignature" /> objects that represent the signatures that are associated with the package.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Windows.Xps.Packaging.XpsDocument.Signatures%2A> list identifies what parts are signed and whether the signatures are valid.
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="SignDigitally">
<AssemblyInfo>
<AssemblyName>ReachFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Signs a collection of package parts by using a specified X.509 certificate.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to use the <xref:System.Windows.Xps.Packaging.XpsDocument.SignDigitally%2A> method.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/SignatureDefinitionsAndSigning.cs" id="Snippetsignxpsdocument":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsReadWriteSign/visualbasic/signaturedefinitionsandsigning.vb" id="Snippetsignxpsdocument":::
]]></format>
</remarks>
</Docs>
</MemberGroup>
<Member MemberName="SignDigitally">
<MemberSignature Language="C#" Value="public System.Windows.Xps.Packaging.XpsDigitalSignature SignDigitally (System.Security.Cryptography.X509Certificates.X509Certificate certificate, bool embedCertificate, System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions restrictions);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Xps.Packaging.XpsDigitalSignature SignDigitally(class System.Security.Cryptography.X509Certificates.X509Certificate certificate, bool embedCertificate, valuetype System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions restrictions) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.SignDigitally(System.Security.Cryptography.X509Certificates.X509Certificate,System.Boolean,System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions)" />
<MemberSignature Language="VB.NET" Value="Public Function SignDigitally (certificate As X509Certificate, embedCertificate As Boolean, restrictions As XpsDigSigPartAlteringRestrictions) As XpsDigitalSignature" />
<MemberSignature Language="F#" Value="member this.SignDigitally : System.Security.Cryptography.X509Certificates.X509Certificate * bool * System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions -> System.Windows.Xps.Packaging.XpsDigitalSignature" Usage="xpsDocument.SignDigitally (certificate, embedCertificate, restrictions)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Windows::Xps::Packaging::XpsDigitalSignature ^ SignDigitally(System::Security::Cryptography::X509Certificates::X509Certificate ^ certificate, bool embedCertificate, System::Windows::Xps::Packaging::XpsDigSigPartAlteringRestrictions restrictions);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Windows.Xps.Packaging.XpsDigitalSignature</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate" />
<Parameter Name="embedCertificate" Type="System.Boolean" />
<Parameter Name="restrictions" Type="System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions" />
</Parameters>
<Docs>
<param name="certificate">The X.509 certificate to use in signing each part; or <see langword="null" /> to prompt the user to select an installed certificate.</param>
<param name="embedCertificate">
<see langword="true" /> to store the certificate in the package; otherwise, <see langword="false" />.</param>
<param name="restrictions">Flags that indicate what dependent parts must be excluded from the signing.</param>
<summary>Signs a collection of package parts with a specified X.509 certificate.</summary>
<returns>An <see cref="T:System.Windows.Xps.Packaging.XpsDigitalSignature" /> that contains information about the signature.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If `certificate` is `null`, a dialog box appears that enables the user to select an installed X.509 certificate, such as from a smart card reader.
## Examples
The following example shows how to use the <xref:System.Windows.Xps.Packaging.XpsDocument.SignDigitally%2A> method.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/SignatureDefinitionsAndSigning.cs" id="Snippetsignxpsdocument":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsReadWriteSign/visualbasic/signaturedefinitionsandsigning.vb" id="Snippetsignxpsdocument":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SignDigitally">
<MemberSignature Language="C#" Value="public System.Windows.Xps.Packaging.XpsDigitalSignature SignDigitally (System.Security.Cryptography.X509Certificates.X509Certificate certificate, bool embedCertificate, System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions restrictions, Guid id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Xps.Packaging.XpsDigitalSignature SignDigitally(class System.Security.Cryptography.X509Certificates.X509Certificate certificate, bool embedCertificate, valuetype System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions restrictions, valuetype System.Guid id) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.SignDigitally(System.Security.Cryptography.X509Certificates.X509Certificate,System.Boolean,System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions,System.Guid)" />
<MemberSignature Language="VB.NET" Value="Public Function SignDigitally (certificate As X509Certificate, embedCertificate As Boolean, restrictions As XpsDigSigPartAlteringRestrictions, id As Guid) As XpsDigitalSignature" />
<MemberSignature Language="F#" Value="member this.SignDigitally : System.Security.Cryptography.X509Certificates.X509Certificate * bool * System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions * Guid -> System.Windows.Xps.Packaging.XpsDigitalSignature" Usage="xpsDocument.SignDigitally (certificate, embedCertificate, restrictions, id)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Windows::Xps::Packaging::XpsDigitalSignature ^ SignDigitally(System::Security::Cryptography::X509Certificates::X509Certificate ^ certificate, bool embedCertificate, System::Windows::Xps::Packaging::XpsDigSigPartAlteringRestrictions restrictions, Guid id);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Windows.Xps.Packaging.XpsDigitalSignature</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate" />
<Parameter Name="embedCertificate" Type="System.Boolean" />
<Parameter Name="restrictions" Type="System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions" />
<Parameter Name="id" Type="System.Guid" />
</Parameters>
<Docs>
<param name="certificate">The X.509 certificate to use in signing each part; or <see langword="null" /> to prompt the user to select an installed certificate.</param>
<param name="embedCertificate">
<see langword="true" /> to store the certificate in the package; otherwise, <see langword="false" />.</param>
<param name="restrictions">Flags that indicate what dependent parts are excluded from the signing.</param>
<param name="id">The ID to assign to the signature.</param>
<summary>Signs a collection of package parts by using a specified X.509 certificate.</summary>
<returns>An <see cref="T:System.Windows.Xps.Packaging.XpsDigitalSignature" /> that contains information about the signature.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If `certificate` is `null`, a dialog box appears that enables the user to select an installed X.509 certificate, such as from a smart card reader.
## Examples
The following example shows how to use the <xref:System.Windows.Xps.Packaging.XpsDocument.SignDigitally%2A> method.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/SignatureDefinitionsAndSigning.cs" id="Snippetsignxpsdocument":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsReadWriteSign/visualbasic/signaturedefinitionsandsigning.vb" id="Snippetsignxpsdocument":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SignDigitally">
<MemberSignature Language="C#" Value="public System.Windows.Xps.Packaging.XpsDigitalSignature SignDigitally (System.Security.Cryptography.X509Certificates.X509Certificate certificate, bool embedCertificate, System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions restrictions, Guid id, bool testIsSignable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Xps.Packaging.XpsDigitalSignature SignDigitally(class System.Security.Cryptography.X509Certificates.X509Certificate certificate, bool embedCertificate, valuetype System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions restrictions, valuetype System.Guid id, bool testIsSignable) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.SignDigitally(System.Security.Cryptography.X509Certificates.X509Certificate,System.Boolean,System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions,System.Guid,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function SignDigitally (certificate As X509Certificate, embedCertificate As Boolean, restrictions As XpsDigSigPartAlteringRestrictions, id As Guid, testIsSignable As Boolean) As XpsDigitalSignature" />
<MemberSignature Language="F#" Value="member this.SignDigitally : System.Security.Cryptography.X509Certificates.X509Certificate * bool * System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions * Guid * bool -> System.Windows.Xps.Packaging.XpsDigitalSignature" Usage="xpsDocument.SignDigitally (certificate, embedCertificate, restrictions, id, testIsSignable)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Windows::Xps::Packaging::XpsDigitalSignature ^ SignDigitally(System::Security::Cryptography::X509Certificates::X509Certificate ^ certificate, bool embedCertificate, System::Windows::Xps::Packaging::XpsDigSigPartAlteringRestrictions restrictions, Guid id, bool testIsSignable);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>ReachFramework</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>
<ReturnValue>
<ReturnType>System.Windows.Xps.Packaging.XpsDigitalSignature</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate" />
<Parameter Name="embedCertificate" Type="System.Boolean" />
<Parameter Name="restrictions" Type="System.Windows.Xps.Packaging.XpsDigSigPartAlteringRestrictions" />
<Parameter Name="id" Type="System.Guid" />
<Parameter Name="testIsSignable" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="certificate">The X.509 certificate to use in signing each part; or <see langword="null" /> to prompt the user to select an installed certificate.</param>
<param name="embedCertificate">
<see langword="true" /> to store the certificate in the package; otherwise, <see langword="false" />.</param>
<param name="restrictions">Flags that indicate what dependent parts to exclude from the signing.</param>
<param name="id">The ID to assign to the signature.</param>
<param name="testIsSignable">
<see langword="true" /> to verify that <see cref="P:System.Windows.Xps.Packaging.XpsDocument.IsSignable" /> is <see langword="true" /> before signing; otherwise, <see langword="false" />.</param>
<summary>Signs a collection of package parts with a specified X.509 certificate.</summary>
<returns>An <see cref="T:System.Windows.Xps.Packaging.XpsDigitalSignature" /> that contains information about the signature.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If `certificate` is `null`, a dialog box is presented that enables the user to select an installed X.509 certificate, such as from a smart card reader.
<xref:System.Security.Cryptography.CryptographicException> is thrown if `certificate` is `null` and no certificates are installed.
## Examples
The following example shows how to use the <xref:System.Windows.Xps.Packaging.XpsDocument.SignDigitally%2A> method.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/SignatureDefinitionsAndSigning.cs" id="Snippetsignxpsdocument":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsReadWriteSign/visualbasic/signaturedefinitionsandsigning.vb" id="Snippetsignxpsdocument":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.IDisposable.Dispose">
<MemberSignature Language="C#" Value="void IDisposable.Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.IDisposable.Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Xps.Packaging.XpsDocument.System#IDisposable#Dispose" />
<MemberSignature Language="VB.NET" Value="Sub Dispose () Implements IDisposable.Dispose" />
<MemberSignature Language="F#" Value="abstract member System.IDisposable.Dispose : unit -> unit
override this.System.IDisposable.Dispose : unit -> unit" Usage="xpsDocument.System.IDisposable.Dispose " />
<MemberSignature Language="C++ CLI" Value=" virtual void System.IDisposable.Dispose() = IDisposable::Dispose;" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>ReachFramework</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">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>