-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ZipPackage.xml
312 lines (302 loc) · 20.3 KB
/
ZipPackage.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
<Type Name="ZipPackage" FullName="System.IO.Packaging.ZipPackage">
<TypeSignature Language="C#" Value="public sealed class ZipPackage : System.IO.Packaging.Package" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ZipPackage extends System.IO.Packaging.Package" />
<TypeSignature Language="DocId" Value="T:System.IO.Packaging.ZipPackage" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ZipPackage
Inherits Package" />
<TypeSignature Language="F#" Value="type ZipPackage = class
 inherit Package" />
<TypeSignature Language="C++ CLI" Value="public ref class ZipPackage sealed : System::IO::Packaging::Package" />
<AssemblyInfo>
<AssemblyName>System.IO.Packaging</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.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>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="System.IO.Packaging" FromVersion="9.0.0.0" To="WindowsBase" ToVersion="4.0.0.0" FrameworkAlternate="netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<TypeForwarding From="WindowsBase" FromVersion="4.0.0.0" To="System.IO.Packaging" ToVersion="4.0.4.0" FrameworkAlternate="windowsdesktop-3.0" />
<TypeForwarding From="WindowsBase" FromVersion="4.0.0.0" To="System.IO.Packaging" ToVersion="4.0.5.0" FrameworkAlternate="windowsdesktop-3.1" />
<TypeForwarding From="WindowsBase" FromVersion="5.0.0.0" To="System.IO.Packaging" ToVersion="5.0.0.0" FrameworkAlternate="windowsdesktop-5.0" />
<TypeForwarding From="WindowsBase" FromVersion="6.0.0.0" To="System.IO.Packaging" ToVersion="6.0.0.0" FrameworkAlternate="windowsdesktop-6.0" />
<TypeForwarding From="WindowsBase" FromVersion="7.0.0.0" To="System.IO.Packaging" ToVersion="7.0.0.0" FrameworkAlternate="windowsdesktop-7.0" />
<TypeForwarding From="WindowsBase" FromVersion="8.0.0.0" To="System.IO.Packaging" ToVersion="8.0.0.0" FrameworkAlternate="windowsdesktop-8.0" />
<TypeForwarding From="WindowsBase" FromVersion="9.0.0.0" To="System.IO.Packaging" ToVersion="9.0.0.0" FrameworkAlternate="windowsdesktop-9.0" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.IO.Packaging.Package</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0;windowsdesktop-8.0;windowsdesktop-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0;windowsdesktop-8.0;windowsdesktop-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Implements a derived subclass of the abstract <see cref="T:System.IO.Packaging.Package" /> base class - the <see cref="T:System.IO.Packaging.ZipPackage" /> class uses a ZIP archive as the container store. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The **Package**.<xref:System.IO.Packaging.Package.Open%2A> method uses <xref:System.IO.Packaging.ZipPackage> containers by default.
## Examples
This example shows how to create a basic <xref:System.IO.Packaging.ZipPackage>.
The example creates a package that contains a single document part which is defined as the package's root element by a package-level <xref:System.IO.Packaging.PackageRelationship>.
The package also contains an image part and a second <xref:System.IO.Packaging.PackageRelationship> which defines an association between the source document part and the target image part. (The image is a resource that is used with the document).
:::code language="csharp" source="~/snippets/csharp/System.IO.Packaging/Package/Overview/PackageWrite.cs" id="Snippetpackagewritecreatepackage":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PackageWrite/visualbasic/packagewrite.vb" id="Snippetpackagewritecreatepackage":::
]]></format>
</remarks>
<altmember cref="T:System.IO.Packaging.PackagePart" />
</Docs>
<Members>
<Member MemberName="CreatePartCore">
<MemberSignature Language="C#" Value="protected override System.IO.Packaging.PackagePart CreatePartCore (Uri partUri, string contentType, System.IO.Packaging.CompressionOption compressionOption);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IO.Packaging.PackagePart CreatePartCore(class System.Uri partUri, string contentType, valuetype System.IO.Packaging.CompressionOption compressionOption) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Packaging.ZipPackage.CreatePartCore(System.Uri,System.String,System.IO.Packaging.CompressionOption)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function CreatePartCore (partUri As Uri, contentType As String, compressionOption As CompressionOption) As PackagePart" />
<MemberSignature Language="F#" Value="override this.CreatePartCore : Uri * string * System.IO.Packaging.CompressionOption -> System.IO.Packaging.PackagePart" Usage="zipPackage.CreatePartCore (partUri, contentType, compressionOption)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::IO::Packaging::PackagePart ^ CreatePartCore(Uri ^ partUri, System::String ^ contentType, System::IO::Packaging::CompressionOption compressionOption);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Packaging</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.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>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Packaging.PackagePart</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partUri" Type="System.Uri" />
<Parameter Name="contentType" Type="System.String" />
<Parameter Name="compressionOption" Type="System.IO.Packaging.CompressionOption" />
</Parameters>
<Docs>
<param name="partUri">The Uri that represents the <see cref="T:System.IO.Packaging.PackagePart" />.</param>
<param name="contentType">A string representing the content type of the <see cref="T:System.IO.Packaging.PackagePart" />.</param>
<param name="compressionOption">The compression option to be used for this <see cref="T:System.IO.Packaging.PackagePart" />.</param>
<summary>Custom implementation for the underlying file format. Adds a new item to the zip archive corresponding to the <see cref="T:System.IO.Packaging.PackagePart" /> in the <see cref="T:System.IO.Packaging.ZipPackage" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="partUri" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="partUri" /> does not have a valid <see cref="T:System.Uri" /> syntax.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="compressionOption" /> does not have a valid <see cref="T:System.IO.Packaging.CompressionOption" /> value.</exception>
</Docs>
</Member>
<Member MemberName="DeletePartCore">
<MemberSignature Language="C#" Value="protected override void DeletePartCore (Uri partUri);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void DeletePartCore(class System.Uri partUri) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Packaging.ZipPackage.DeletePartCore(System.Uri)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub DeletePartCore (partUri As Uri)" />
<MemberSignature Language="F#" Value="override this.DeletePartCore : Uri -> unit" Usage="zipPackage.DeletePartCore partUri" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void DeletePartCore(Uri ^ partUri);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Packaging</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.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>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partUri" Type="System.Uri" />
</Parameters>
<Docs>
<param name="partUri">The Uri that represents the <see cref="T:System.IO.Packaging.PackagePart" />.</param>
<summary>This method is for a custom implementation specific to the file format. Deletes the <see cref="T:System.IO.Packaging.PackagePart" /> corresponding to the <see cref="T:System.Uri" /> specified. Attempting to delete a part that does not exist is not an error and so does not throw an exception.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="partUri" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="partUri" /> does not have a valid <see cref="T:System.Uri" /> syntax.</exception>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Packaging.ZipPackage.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="override this.Dispose : bool -> unit" Usage="zipPackage.Dispose disposing" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void Dispose(bool disposing);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Packaging</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.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>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.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" /> if called during <see cref="M:System.IO.Packaging.ZipPackage.Dispose" />, <see langword="false" /> if called during <see cref="M:System.IO.Packaging.ZipPackage.Finalize" />.</param>
<summary>Closes the underlying <see cref="T:System.IO.Packaging.ZipPackage" /> object for this container.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FlushCore">
<MemberSignature Language="C#" Value="protected override void FlushCore ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void FlushCore() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Packaging.ZipPackage.FlushCore" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub FlushCore ()" />
<MemberSignature Language="F#" Value="override this.FlushCore : unit -> unit" Usage="zipPackage.FlushCore " />
<MemberSignature Language="C++ CLI" Value="protected:
 override void FlushCore();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Packaging</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.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>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>This method is for a custom implementation corresponding to the underlying zip file format.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetPartCore">
<MemberSignature Language="C#" Value="protected override System.IO.Packaging.PackagePart? GetPartCore (Uri partUri);" FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netstandard-2.0;windowsdesktop-5.0;windowsdesktop-6.0;windowsdesktop-7.0;windowsdesktop-8.0;windowsdesktop-9.0" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IO.Packaging.PackagePart GetPartCore(class System.Uri partUri) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Packaging.ZipPackage.GetPartCore(System.Uri)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function GetPartCore (partUri As Uri) As PackagePart" />
<MemberSignature Language="F#" Value="override this.GetPartCore : Uri -> System.IO.Packaging.PackagePart" Usage="zipPackage.GetPartCore partUri" />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::IO::Packaging::PackagePart ^ GetPartCore(Uri ^ partUri);" />
<MemberSignature Language="C#" Value="protected override System.IO.Packaging.PackagePart GetPartCore (Uri partUri);" FrameworkAlternate="netcore-1.0;netcore-1.1;netframework-3.0;netframework-3.5;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;windowsdesktop-3.0;windowsdesktop-3.1" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Packaging</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.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>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Packaging.PackagePart</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partUri" Type="System.Uri" />
</Parameters>
<Docs>
<param name="partUri">The Uri that represents the <see cref="T:System.IO.Packaging.PackagePart" />.</param>
<summary>This method is for a custom implementation specific to the file format. Returns a <see cref="T:System.IO.Packaging.PackagePart" /> after reading the actual physical bits. The method returns <see langword="null" /> to indicate that the part corresponding to the specified <see cref="T:System.Uri" /> was not found in the container. This method does not throw an exception if a part does not exist.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetPartsCore">
<MemberSignature Language="C#" Value="protected override System.IO.Packaging.PackagePart[] GetPartsCore ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IO.Packaging.PackagePart[] GetPartsCore() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Packaging.ZipPackage.GetPartsCore" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function GetPartsCore () As PackagePart()" />
<MemberSignature Language="F#" Value="override this.GetPartsCore : unit -> System.IO.Packaging.PackagePart[]" Usage="zipPackage.GetPartsCore " />
<MemberSignature Language="C++ CLI" Value="protected:
 override cli::array <System::IO::Packaging::PackagePart ^> ^ GetPartsCore();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Packaging</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.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>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Packaging.PackagePart[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>This method is for a custom implementation specific to the file format. This method retrieves the actual parts from the underlying <see cref="T:System.IO.Packaging.ZipPackage" />.</summary>
<returns>An array of <see cref="T:System.IO.Packaging.ZipPackagePart" /> objects.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Some or all of the parts may be interleaved. The Part object for an interleaved part encapsulates the Uri of the proper part name and the ZipFileInfo of the initial piece. This function does not go through the extra work of checking piece naming validity throughout the package.
This means that interleaved parts without an initial piece will be silently ignored. Other naming anomalies are caught at the stream level when an I/O operation involves an anomalous or missing piece.
This function reads directly from the underlying IO layer and is supposed to be called just once in the lifetime of a package (at initialization time).
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>