markus / lib / RCWPF / 2019.1.220.40 / Telerik.Windows.Zip.Extensions.xml @ 3c04142d
이력 | 보기 | 이력해설 | 다운로드 (17.6 KB)
1 |
<?xml version="1.0"?>
|
---|---|
2 |
<doc>
|
3 |
<assembly>
|
4 |
<name>Telerik.Windows.Zip.Extensions</name> |
5 |
</assembly>
|
6 |
<members>
|
7 |
<member name="T:Telerik.Windows.Zip.Extensions.DotNetPlatformManager"> |
8 |
<summary>
|
9 |
Platform manager which can be used with full version of the .NET Framework. |
10 |
</summary>
|
11 |
</member>
|
12 |
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.#ctor"> |
13 |
<summary>
|
14 |
Initializes a new instance of the DotNetPlatformManager class. |
15 |
</summary>
|
16 |
</member>
|
17 |
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.CreateTemporaryStream"> |
18 |
<summary>
|
19 |
Creates temporary stream. |
20 |
</summary>
|
21 |
<returns>Stream will be used for temporary operations.</returns> |
22 |
</member>
|
23 |
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.DeleteTemporaryStream(System.IO.Stream)"> |
24 |
<summary>
|
25 |
Deletes temporary stream. |
26 |
</summary>
|
27 |
<param name="stream">Stream to delete.</param> |
28 |
</member>
|
29 |
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.GetCryptoProvider(Telerik.Windows.Zip.EncryptionSettings)"> |
30 |
<summary>
|
31 |
Gets crypto provider initialized using given encryption settings. |
32 |
</summary>
|
33 |
<param name="settings">Encryption settings.</param> |
34 |
<returns>Crypto provider.</returns> |
35 |
<exception cref="T:System.NotSupportedException">Specified crypto algorithm is not supported.</exception> |
36 |
</member>
|
37 |
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.IsEncodingSupported(System.Text.Encoding)"> |
38 |
<summary>
|
39 |
Indicates whether specified encoding is supported for this platform. |
40 |
</summary>
|
41 |
<param name="encoding">Encoding.</param> |
42 |
<returns>true if encoding is allowed in the ZIP file.</returns> |
43 |
</member>
|
44 |
<member name="P:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.AltDirectorySeparatorChar"> |
45 |
<summary>
|
46 |
Gets a platform-specific alternate character used to separate directory levels in a path string that reflects a hierarchical file system organization. |
47 |
</summary>
|
48 |
</member>
|
49 |
<member name="P:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.DefaultEncoding"> |
50 |
<summary>
|
51 |
Gets default encoding for this platform. |
52 |
</summary>
|
53 |
</member>
|
54 |
<member name="P:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.DirectorySeparatorChar"> |
55 |
<summary>
|
56 |
Gets a platform-specific character used to separate directory levels in a path string that reflects a hierarchical file system organization. |
57 |
</summary>
|
58 |
</member>
|
59 |
<member name="P:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.TemporaryStreamType"> |
60 |
<summary>
|
61 |
Gets or sets type of the temporary stream. The default value is TemporaryStreamType.Memory. |
62 |
</summary>
|
63 |
</member>
|
64 |
<member name="T:Telerik.Windows.Zip.Extensions.TemporaryStreamType"> |
65 |
<summary>
|
66 |
Type of the temporary stream. |
67 |
</summary>
|
68 |
</member>
|
69 |
<member name="F:Telerik.Windows.Zip.Extensions.TemporaryStreamType.File"> |
70 |
<summary>
|
71 |
The temporary stream represents temporary file in the file system. |
72 |
</summary>
|
73 |
<remarks>It allows manipulations with large archives and minimize memory consumption.</remarks> |
74 |
</member>
|
75 |
<member name="F:Telerik.Windows.Zip.Extensions.TemporaryStreamType.Memory"> |
76 |
<summary>
|
77 |
The temporary stream represents data in the memory. |
78 |
</summary>
|
79 |
<remarks>It is the fastest way of the data manipulation.</remarks> |
80 |
</member>
|
81 |
<member name="T:Telerik.Windows.Zip.Extensions.ZipFile"> |
82 |
<summary>
|
83 |
Provides static methods for creating, extracting, and opening zip archives. |
84 |
</summary>
|
85 |
</member>
|
86 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateEntryFromFile(Telerik.Windows.Zip.ZipArchive,System.String,System.String)"> |
87 |
<summary>
|
88 |
Archives a file by compressing it and adding it to the zip archive. |
89 |
</summary>
|
90 |
<param name="destination">The zip archive to add the file to.</param> |
91 |
<param name="sourceFileName">The path to the file to be archived. You can specify either a relative or an absolute path. A relative path is interpreted as relative to the current working directory.</param> |
92 |
<param name="entryName">The name of the entry to create in the zip archive.</param> |
93 |
<returns>New entry in archive.</returns> |
94 |
</member>
|
95 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateEntryFromFile(Telerik.Windows.Zip.ZipArchive,System.String,System.String,Telerik.Windows.Zip.CompressionLevel)"> |
96 |
<summary>
|
97 |
Archives a file by compressing it using the specified compression level and adding it to the zip archive. |
98 |
</summary>
|
99 |
<param name="destination">The zip archive to add the file to.</param> |
100 |
<param name="sourceFileName">The path to the file to be archived. You can specify either a relative or an absolute path. A relative path is interpreted as relative to the current working directory.</param> |
101 |
<param name="entryName">The name of the entry to create in the zip archive.</param> |
102 |
<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param> |
103 |
<returns>New entry in archive.</returns> |
104 |
</member>
|
105 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateEntryFromFile(Telerik.Windows.Zip.ZipArchive,System.String,System.String,Telerik.Windows.Zip.CompressionSettings)"> |
106 |
<summary>
|
107 |
Archives a file by compressing it using the specified compression settings and adding it to the zip archive. |
108 |
</summary>
|
109 |
<param name="destination">The zip archive to add the file to.</param> |
110 |
<param name="sourceFileName">The path to the file to be archived. You can specify either a relative or an absolute path. A relative path is interpreted as relative to the current working directory.</param> |
111 |
<param name="entryName">The name of the entry to create in the zip archive.</param> |
112 |
<param name="compressionSettings">Compression settings.</param> |
113 |
<returns>New entry in archive.</returns> |
114 |
</member>
|
115 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String)"> |
116 |
<summary>
|
117 |
Creates a zip archive that contains the files and directories from the specified directory. |
118 |
</summary>
|
119 |
<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param> |
120 |
<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param> |
121 |
</member>
|
122 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Windows.Zip.CompressionLevel,System.Boolean)"> |
123 |
<summary>
|
124 |
Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression level, and optionally includes the base directory. |
125 |
</summary>
|
126 |
<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param> |
127 |
<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param> |
128 |
<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param> |
129 |
<param name="includeBaseDirectory">True to include the directory name from sourceDirectoryName at the root of the archive; false to include only the contents of the directory.</param> |
130 |
</member>
|
131 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Windows.Zip.CompressionLevel,System.Boolean,System.Text.Encoding)"> |
132 |
<summary>
|
133 |
Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression level, and optionally includes the base directory. |
134 |
</summary>
|
135 |
<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param> |
136 |
<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param> |
137 |
<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param> |
138 |
<param name="includeBaseDirectory">True to include the directory name from sourceDirectoryName at the root of the archive; false to include only the contents of the directory.</param> |
139 |
<param name="entryNameEncoding">The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names.</param> |
140 |
</member>
|
141 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Windows.Zip.CompressionSettings,System.Boolean,System.Text.Encoding)"> |
142 |
<summary>
|
143 |
Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression settings, and optionally includes the base directory. |
144 |
</summary>
|
145 |
<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param> |
146 |
<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param> |
147 |
<param name="compressionSettings">Compression settings.</param> |
148 |
<param name="includeBaseDirectory">True to include the directory name from sourceDirectoryName at the root of the archive; false to include only the contents of the directory.</param> |
149 |
<param name="entryNameEncoding">The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names.</param> |
150 |
</member>
|
151 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.ExtractToDirectory(System.String,System.String)"> |
152 |
<summary>
|
153 |
Extracts all the files in the specified zip archive to a directory on the file system. |
154 |
</summary>
|
155 |
<param name="sourceArchiveFileName">The path to the archive that is to be extracted.</param> |
156 |
<param name="destinationDirectoryName">The path to the directory in which to place the extracted files, |
157 |
specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
158 |
</member>
|
159 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.ExtractToDirectory(System.String,System.String,System.Text.Encoding)"> |
160 |
<summary>
|
161 |
Extracts all the files in the specified zip archive to a directory on the file system and uses the specified character encoding for entry names. |
162 |
</summary>
|
163 |
<param name="sourceArchiveFileName">The path to the archive that is to be extracted.</param> |
164 |
<param name="destinationDirectoryName">The path to the directory in which to place the extracted files, |
165 |
specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
166 |
<param name="entryNameEncoding">The encoding to use when reading or writing entry names in this archive. |
167 |
Specify a value for this parameter only when an encoding is required for interoperability with zip archive |
168 |
tools and libraries that do not support UTF-8 encoding for entry names.</param>
|
169 |
</member>
|
170 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.ExtractToDirectory(Telerik.Windows.Zip.ZipArchive,System.String)"> |
171 |
<summary>
|
172 |
Extracts all the files in the zip archive to a directory on the file system. |
173 |
</summary>
|
174 |
<param name="source">The zip archive to extract files from.</param> |
175 |
<param name="destinationDirectoryName">The path to the directory to place the extracted files in. You can specify either a relative or an absolute path. A relative path is interpreted as relative to the current working directory.</param> |
176 |
</member>
|
177 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.ExtractToFile(Telerik.Windows.Zip.ZipArchiveEntry,System.String)"> |
178 |
<summary>
|
179 |
Extracts an entry in the zip archive to a file. |
180 |
</summary>
|
181 |
<param name="source">The zip archive entry to extract a file from.</param> |
182 |
<param name="destinationFileName">The path of the file to create from the contents |
183 |
of the entry. You can specify either a relative or an absolute path. A relative path |
184 |
is interpreted as relative to the current working directory.</param>
|
185 |
</member>
|
186 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.ExtractToFile(Telerik.Windows.Zip.ZipArchiveEntry,System.String,System.Boolean)"> |
187 |
<summary>
|
188 |
Extracts an entry in the zip archive to a file, and optionally overwrites an existing file that has the same name. |
189 |
</summary>
|
190 |
<param name="source">The zip archive entry to extract a file from.</param> |
191 |
<param name="destinationFileName">The path of the file to create from the contents |
192 |
of the entry. You can specify either a relative or an absolute path. A relative path |
193 |
is interpreted as relative to the current working directory.</param>
|
194 |
<param name="overwrite">True to overwrite an existing file that has the same name as the destination file; otherwise, false.</param> |
195 |
</member>
|
196 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.Open(System.String,Telerik.Windows.Zip.ZipArchiveMode)"> |
197 |
<summary>
|
198 |
Opens a zip archive at the specified path and in the specified mode. |
199 |
</summary>
|
200 |
<param name="archiveFileName">The path to the archive to open, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param> |
201 |
<param name="mode">One of the enumeration values that specifies the actions which are allowed on the entries in the opened archive.</param> |
202 |
<returns>The opened zip archive.</returns> |
203 |
</member>
|
204 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.Open(System.String,Telerik.Windows.Zip.ZipArchiveMode,System.Text.Encoding)"> |
205 |
<summary>
|
206 |
Opens a zip archive at the specified path and in the specified mode. |
207 |
</summary>
|
208 |
<param name="archiveFileName">The path to the archive to open, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param> |
209 |
<param name="mode">One of the enumeration values that specifies the actions which are allowed on the entries in the opened archive.</param> |
210 |
<param name="entryNameEncoding">The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names.</param> |
211 |
<returns>The opened zip archive.</returns> |
212 |
</member>
|
213 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.OpenRead(System.String)"> |
214 |
<summary>
|
215 |
Opens a zip archive for reading at the specified path. |
216 |
</summary>
|
217 |
<param name="archiveFileName">The path to the archive to open, specified as a relative or absolute path. |
218 |
A relative path is interpreted as relative to the current working directory.</param>
|
219 |
<returns>The opened zip archive.</returns> |
220 |
</member>
|
221 |
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.IsDirectoryEmpty(System.IO.DirectoryInfo)"> |
222 |
<summary>
|
223 |
Indicates whether specified directory is empty or not. |
224 |
</summary>
|
225 |
<param name="directoryInfo">Directory info.</param> |
226 |
<returns>True if directory is empty; otherwise - false.</returns> |
227 |
</member>
|
228 |
</members>
|
229 |
</doc>
|