eDosStation/lib/RCWPF/2026.2.701.462/Telerik.Windows.Zip.Extensions.xml

343 lines
27 KiB
XML
Raw Normal View History

2026-07-28 16:36:22 +02:00
<?xml version="1.0"?>
<doc>
<assembly>
<name>Telerik.Windows.Zip.Extensions</name>
</assembly>
<members>
<member name="T:Telerik.Windows.Zip.Extensions.DotNetPlatformManager">
<summary>
Platform manager which can be used with full version of the .NET Framework.
</summary>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.#ctor">
<summary>
Initializes a new instance of the DotNetPlatformManager class.
</summary>
</member>
<member name="P:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.AltDirectorySeparatorChar">
<summary>
Gets a platform-specific alternate character used to separate directory levels in a path string that reflects a hierarchical file system organization.
</summary>
</member>
<member name="P:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.DefaultEncoding">
<summary>
Gets default encoding for this platform.
</summary>
</member>
<member name="P:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.DirectorySeparatorChar">
<summary>
Gets a platform-specific character used to separate directory levels in a path string that reflects a hierarchical file system organization.
</summary>
</member>
<member name="P:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.TemporaryStreamType">
<summary>
Gets or sets type of the temporary stream. The default value is TemporaryStreamType.Memory.
</summary>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.CreateTemporaryStream">
<summary>
Creates temporary stream.
</summary>
<returns>Stream will be used for temporary operations.</returns>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.DeleteTemporaryStream(System.IO.Stream)">
<summary>
Deletes temporary stream.
</summary>
<param name="stream">Stream to delete.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.GetCryptoProvider(Telerik.Windows.Zip.EncryptionSettingsBase)">
<summary>
Gets crypto provider initialized using given encryption settings.
</summary>
<param name="settings">Encryption settings.</param>
<returns>Crypto provider.</returns>
<exception cref="T:System.NotSupportedException">Specified crypto algorithm is not supported.</exception>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.GetCryptoStream(Telerik.Windows.Zip.EncryptionSettingsBase,System.IO.Stream,Telerik.Windows.Zip.StreamOperationMode,Telerik.Windows.Zip.ICryptoProvider,Telerik.Windows.Zip.CompressionSettings)">
<summary>
Gets crypto stream initialized using given encryption settings.
</summary>
<param name="encryptionSettings">Encryption settings.</param>
<param name="baseStream">Stream.</param>
<param name="mode">Stream operation mode.</param>
<param name="cryptoProvider">Crypto provider.</param>
<param name="compressionSettings">Compression settings.</param>
<returns>Crypto stream.</returns>
<exception cref="T:System.NotSupportedException">Specified crypto algorithm is not supported.</exception>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.DotNetPlatformManager.IsEncodingSupported(System.Text.Encoding)">
<summary>
Indicates whether specified encoding is supported for this platform.
</summary>
<param name="encoding">Encoding.</param>
<returns>true if encoding is allowed in the ZIP file.</returns>
</member>
<member name="T:Telerik.Windows.Zip.Extensions.TemporaryStreamType">
<summary>
Type of the temporary stream.
</summary>
</member>
<member name="F:Telerik.Windows.Zip.Extensions.TemporaryStreamType.File">
<summary>
The temporary stream represents temporary file in the file system.
</summary>
<remarks>It allows manipulations with large archives and minimize memory consumption.</remarks>
</member>
<member name="F:Telerik.Windows.Zip.Extensions.TemporaryStreamType.Memory">
<summary>
The temporary stream represents data in the memory.
</summary>
<remarks>It is the fastest way of the data manipulation.</remarks>
</member>
<member name="T:Telerik.Windows.Zip.Extensions.ZipFile">
<summary>
Provides static methods for creating, extracting, and opening zip archives.
</summary>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateEntryFromFile(Telerik.Windows.Zip.ZipArchive,System.String,System.String,System.Nullable{System.TimeSpan})">
<summary>
Archives a file by compressing it and adding it to the zip archive.
</summary>
<param name="destination">The zip archive to add the file to.</param>
<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>
<param name="entryName">The name of the entry to create in the zip archive.</param>
<param name="timeout">The time period after which the operation will be cancelled.</param>
<returns>New entry in archive.</returns>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateEntryFromFile(Telerik.Windows.Zip.ZipArchive,System.String,System.String,Telerik.Windows.Zip.CompressionLevel,System.Nullable{System.TimeSpan})">
<summary>
Archives a file by compressing it using the specified compression level and adding it to the zip archive.
</summary>
<param name="destination">The zip archive to add the file to.</param>
<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>
<param name="entryName">The name of the entry to create in the zip archive.</param>
<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>
<param name="timeout">The time period after which the operation will be cancelled.</param>
<returns>New entry in archive.</returns>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateEntryFromFile(Telerik.Windows.Zip.ZipArchive,System.String,System.String,Telerik.Windows.Zip.CompressionSettings,System.Nullable{System.TimeSpan})">
<summary>
Archives a file by compressing it using the specified compression settings and adding it to the zip archive.
</summary>
<param name="destination">The zip archive to add the file to.</param>
<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>
<param name="entryName">The name of the entry to create in the zip archive.</param>
<param name="compressionSettings">Compression settings.</param>
<param name="timeout">The time period after which the operation will be cancelled.</param>
<returns>New entry in archive.</returns>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,System.Nullable{System.TimeSpan})">
<summary>
Creates a zip archive that contains the files and directories from the specified directory.
</summary>
<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>
<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>
<param name="timeout">The time period after which the operation will be cancelled.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Windows.Zip.CompressionLevel,System.Boolean,System.Nullable{System.TimeSpan})">
<summary>
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.
</summary>
<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>
<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>
<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>
<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>
<param name="timeout">The time period after which the operation will be cancelled.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Windows.Zip.CompressionLevel,System.Boolean,System.Text.Encoding,System.Nullable{System.TimeSpan})">
<summary>
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.
</summary>
<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>
<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>
<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>
<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>
<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>
<param name="timeout">The time period after which the operation will be cancelled.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Windows.Zip.CompressionSettings,System.Boolean,System.Text.Encoding,System.Nullable{System.TimeSpan})">
<summary>
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.
</summary>
<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>
<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>
<param name="compressionSettings">Compression settings.</param>
<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>
<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>
<param name="timeout">The time period after which the operation will be cancelled.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Windows.Zip.CompressionSettings,System.Boolean,System.Text.Encoding,System.Threading.CancellationToken)">
<summary>
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.
</summary>
<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>
<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>
<param name="compressionSettings">Compression settings.</param>
<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>
<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>
<param name="cancellationToken">The cancellation token used to cancel the operation.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.ExtractToDirectory(System.String,System.String,System.Nullable{System.TimeSpan})">
<summary>
Extracts all the files in the specified zip archive to a directory on the file system.
</summary>
<param name="sourceArchiveFileName">The path to the archive that is to be extracted.</param>
<param name="destinationDirectoryName">The path to the directory in which to place the extracted files,
specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
<param name="timeout">The time period after which the operation will be cancelled.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.ExtractToDirectory(System.String,System.String,System.Text.Encoding,System.Nullable{System.TimeSpan})">
<summary>
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.
</summary>
<param name="sourceArchiveFileName">The path to the archive that is to be extracted.</param>
<param name="destinationDirectoryName">The path to the directory in which to place the extracted files,
specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
<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>
<param name="timeout">The time period after which the operation will be cancelled.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.ExtractToDirectory(Telerik.Windows.Zip.ZipArchive,System.String,System.Nullable{System.TimeSpan})">
<summary>
Extracts all the files in the zip archive to a directory on the file system.
</summary>
<param name="source">The zip archive to extract files from.</param>
<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>
<param name="timeout">The time period after which the operation will be cancelled.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.ExtractToFile(Telerik.Windows.Zip.ZipArchiveEntry,System.String,System.Nullable{System.TimeSpan})">
<summary>
Extracts an entry in the zip archive to a file.
</summary>
<param name="source">The zip archive entry to extract a file from.</param>
<param name="destinationFileName">The path of the file to create from the contents
of the entry. You can specify either a relative or an absolute path. A relative path
is interpreted as relative to the current working directory.</param>
<param name="timeout">The time period after which the operation will be cancelled.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.ExtractToFile(Telerik.Windows.Zip.ZipArchiveEntry,System.String,System.Boolean,System.Nullable{System.TimeSpan})">
<summary>
Extracts an entry in the zip archive to a file, and optionally overwrites an existing file that has the same name.
</summary>
<param name="source">The zip archive entry to extract a file from.</param>
<param name="destinationFileName">The path of the file to create from the contents
of the entry. You can specify either a relative or an absolute path. A relative path
is interpreted as relative to the current working directory.</param>
<param name="overwrite">True to overwrite an existing file that has the same name as the destination file; otherwise, false.</param>
<param name="timeout">The time period after which the operation will be cancelled.</param>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.Open(System.String,Telerik.Windows.Zip.ZipArchiveMode)">
<summary>
Opens a zip archive at the specified path and in the specified mode.
</summary>
<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>
<param name="mode">One of the enumeration values that specifies the actions which are allowed on the entries in the opened archive.</param>
<returns>The opened zip archive.</returns>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.Open(System.String,Telerik.Windows.Zip.ZipArchiveMode,System.Text.Encoding)">
<summary>
Opens a zip archive at the specified path and in the specified mode.
</summary>
<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>
<param name="mode">One of the enumeration values that specifies the actions which are allowed on the entries in the opened archive.</param>
<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>
<returns>The opened zip archive.</returns>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.OpenRead(System.String)">
<summary>
Opens a zip archive for reading at the specified path.
</summary>
<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>
<returns>The opened zip archive.</returns>
</member>
<member name="M:Telerik.Windows.Zip.Extensions.ZipFile.IsDirectoryEmpty(System.IO.DirectoryInfo)">
<summary>
Indicates whether specified directory is empty or not.
</summary>
<param name="directoryInfo">Directory info.</param>
<returns>True if directory is empty; otherwise - false.</returns>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.ResolvePath(System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Resolves a path to a document applying extension, traversal and (Windows-only) UNC validations.
</summary>
<param name="basePath">Base directory (relative or absolute).</param>
<param name="documentPath">User-supplied path (relative, absolute, or UNC).</param>
<param name="allowedNetworkHosts">UNC host/share allow-list (Windows only). Null or empty denies all UNC paths.</param>
<returns>Full path if valid; otherwise null.</returns>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.ResolveCandidatePath(System.String,System.String,System.Boolean,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Returns the candidate resolved path (absolute or UNC) without performing an existence check.
Applies validation logic if enabled. Intended strictly for internal testing of resolution semantics.
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.ResolvePathNoValidation(System.String,System.String)">
<summary>
Lightweight resolution when document path validation is disabled.
Combines base + relative if needed and returns the candidate path (existence checked centrally in ResolvePath).
Skips UNC allow-list and traversal containment checks.
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.ResolvePathWithValidation(System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Performs secure resolution of a document path:
1) Determines effective absolute path (respecting UNC vs local semantics).
2) If UNC, verifies host/share is explicitly allowed before any filesystem call.
3) Normalizes paths and enforces containment within base (or allowed UNC root).
4) Returns path only if the target file exists.
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.BuildEffectivePath(System.String,System.String)">
<summary>
Produces an absolute candidate path unless already rooted. UNC paths are considered rooted.
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.IsNetworkPath(System.String)">
<summary>
Returns true for Windows UNC patterns (\\server, \\?\UNC\server). Non-Windows platforms return false.
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.NormalizeForComparison(System.String)">
<summary>
Normalizes path for comparison: trims; on Windows converts '/' to '\\' and collapses redundant leading backslashes.
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.IsAllowedNetworkPath(System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Assumes networkPath is already confirmed as a network/UNC path. Returns true if it begins with any canonical allow-list prefix.
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.CanonicalizeAllowedPrefix(System.String)">
<summary>
Converts an allow-list entry to canonical form: \\host\\share\\ (ensures leading/trailing backslashes).
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.GetAllowedNetworkRoot(System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Returns the longest canonical allow-list prefix that matches the UNC path; null if no match.
Assumes entries in allowedNetworkHosts are already canonical ("\\\\host\\share\\").
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.PrecomputeCanonicalAllowList(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Precomputes a distinct set of canonical UNC prefixes from a raw allow-list.
Returns an empty array if source is null or no valid entries.
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.IsWindows">
<summary>
Platform check for Windows.
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Utilities.PathValidationUtils.CollapseUncRelativeSegments(System.String,System.String)">
<summary>
Collapses '.' and '..' segments in a UNC path after the allowed root prefix.
</summary>
</member>
</members>
</doc>