<?xml version="1.0"?>
<doc>
<assembly>
<name>
JF.Tools.Compression
</name>
</assembly>
<members>
<member name="T:JF.Tools.Compression.My.Resources.Resources">
<summary>
  Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
</summary>
</member>
<member name="P:JF.Tools.Compression.My.Resources.Resources.ResourceManager">
<summary>
  Gibt die zwischengespeicherte ResourceManager-Instanz zurück, die von dieser Klasse verwendet wird.
</summary>
</member>
<member name="P:JF.Tools.Compression.My.Resources.Resources.Culture">
<summary>
  Überschreibt die CurrentUICulture-Eigenschaft des aktuellen Threads für alle
  Ressourcenzuordnungen, die diese stark typisierte Ressourcenklasse verwenden.
</summary>
</member>
<member name="T:JF.Tools.Compression.CompressionException">
 <summary>
 Custom Exception base implementation for JF.Tools.Compression
 </summary>
 <remarks>#New: 3.2000;07.11.2025;A.Becker</remarks>
</member>
<member name="T:JF.Tools.Compression.CompressionSourceException">
 <summary>
 Exception base implementation which will be thrown from <see cref="T:JF.Tools.Compression.SevenZipCompressionSource"/>.
 </summary>
 <remarks>#New: 3.2000;07.11.2025;A.Becker</remarks>
</member>
<member name="T:JF.Tools.Compression.CompressionSourceDuplicatePathException">
 <summary>
 Exception implementation which will be thrown from <see cref="T:JF.Tools.Compression.SevenZipCompressionSource"/> on archive paths collisions.
 </summary>
 <remarks>#New: 3.2000;07.11.2025;A.Becker</remarks>
</member>
<member name="P:JF.Tools.Compression.CompressionSourceDuplicatePathException.CollectedFilesToCompress">
 <summary>
 Provides access to archive file paths of already collected files to compress
 </summary>
</member>
<member name="P:JF.Tools.Compression.CompressionSourceDuplicatePathException.CollectedTextContentFilesToCompress">
 <summary>
 Provides access to archive file paths of already collected text streams to compress
 </summary>
</member>
<member name="T:JF.Tools.Compression.CompressionProvider">
 <summary>
 Abstrahiert verschiedene Kompressionsmethoden und -bibliotheken über eine gemeinsame Schnittstelle.<br />
 Bietet Factory-Methoden zur Instanzierung einer geeigneten Implementation nach Archivtyp oder Archiv-Dateiname.
 </summary>
 <remarks>
 New: 2.1219;05.11.2015;A.Becker
 LUp: 3.1601;02.02.2022;A.Becker (DefaultTextContentFileEncoding)
 </remarks>
</member>
<member name="P:JF.Tools.Compression.CompressionProvider.DefaultTextContentFileEncoding">
 <summary>
 Defines the default encoding for TextContentFiles.
 <para/>#Doc: The preset default encoding is !--  Text.Encoding.GetEncoding(1252) --! 
 <para/>#Doc: need to be cahnged to System.Text.Encoding.UTF8
 </summary>
 <remarks> 
 #LUp: 3.1601;02.02.2022;A.Becker + J.Fes
 </remarks>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.CompressFolder(System.String,System.String,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{JF.Tools.Compression.TextContentFile},System.Nullable{JF.Tools.Compression.CompressionLevel})">
 <summary>
 Creates a new archive from a disk folder and optional additional text content files.
 The <paramref name="textContentFiles" /> will be encoded using the <see cref="P:JF.Tools.Compression.CompressionProvider.DefaultTextContentFileEncoding" /> which is preset to UTF-8.
 </summary>
 <param name="archiveFilePath">The file path of the archive to be created.</param>
 <param name="sourceFolderPath">The folder with files to be added to the archive</param>
 <param name="includeSubdirectories">Add all subdirectories of the source folder too. Default=TRUE.</param>
 <param name="includeFilemasks">Collection of LIKE-Syntax filters for filenames to include. Default=[All]</param>
 <param name="excludeFilemasks">Collection of LIKE-Syntax filters for filenames to exclude. Default=[None]</param>
 <param name="textContentFiles">Collection of virtual files containing text only to be added to the archive.</param>
 <param name="compressionLevel">Strength of compression</param>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.CompressFolder(System.String,System.String,System.Text.Encoding,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{JF.Tools.Compression.TextContentFile},System.Nullable{JF.Tools.Compression.CompressionLevel})">
 <summary>
 Creates a new archive from a disk folder and optional additional text content files.
 </summary>
 <param name="archiveFilePath">The file path of the archive to be created.</param>
 <param name="sourceFolderPath">The folder with files to be added to the archive</param>
 <param name="textContentFileDefaultEncoding">The default encoding to be used to store the <paramref name="textContentFiles"/> when no specific encoding is defined for the file.</param>
 <param name="includeSubdirectories">Add all subdirectories of the source folder too. Default=TRUE.</param>
 <param name="includeFilemasks">Collection of LIKE-Syntax filters for filenames to include. Default=[All]</param>
 <param name="excludeFilemasks">Collection of LIKE-Syntax filters for filenames to exclude. Default=[None]</param>
 <param name="textContentFiles">Collection of virtual files containing text only to be added to the archive.</param>
 <param name="compressionLevel">Strength of compression</param>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.Decompress(System.String,System.String,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String)">
 <summary>
 Extracts an archive to a specified disk folder.<br />
 The destination folder will be created if it does not exist.
 </summary>
 <param name="archiveFilePath">The archive to extract.</param>
 <param name="destinationFolderPath">The destination folder, will be created if missing.</param>
 <param name="replaceExistingFiles">If true existing destination files will be overwritten. Default=TRUE.</param>
 <param name="includeFilemasks">Collection of LIKE-Syntax filters for filenames to include. Default=[All]</param>
 <param name="excludeFilemasks">Collection of LIKE-Syntax filters for filenames to exclude. Default=[None]</param>
 <remarks> 
 #LUp: 3.1800;30.03.2023;S.Gueth added password_p parameter
 </remarks>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.DecompressAsync(System.String,System.String,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String)">
 <summary>
 Extracts an archive to a specified disk folder. asynchron<br />
 The destination folder will be created if it does not exist.
 </summary>
 <param name="archiveFilePath">The archive to extract.</param>
 <param name="destinationFolderPath">The destination folder, will be created if missing.</param>
 <param name="replaceExistingFiles">If true existing destination files will be overwritten. Default=TRUE.</param>
 <param name="includeFilemasks">Collection of LIKE-Syntax filters for filenames to include. Default=[All]</param>
 <param name="excludeFilemasks">Collection of LIKE-Syntax filters for filenames to exclude. Default=[None]</param>
 <remarks> 
 #New: 3.2000;07.01.2025;S.Gueth
 </remarks>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.ExtractFile(System.String,System.String,System.String,System.String,System.Nullable{System.Boolean})">
 <summary>
 Extracts a single file from an archive and returns the full path of the extracted file.<br />
 The destination folder will be created if it does not exist.
 </summary>
 <param name="archiveFilePath">The archive to extract from.</param>
 <param name="filePathInArchive">The path and name of the file wihin the archive to extract.</param>
 <param name="destinationFolderPath">The destination folder, will be created if missing.</param>
 <param name="destinationFileName">Alternative destination file name, default = the name of the file from the archive.</param>
 <param name="replaceExistingFile">If true existing destination files will be overwritten. Default=TRUE.</param>
 <returns>Returns the full path of the extracted file.</returns>
 <remarks>New: 2.1220;19.11.2015;A.Becker</remarks>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.OnDecompressProgressChanged(System.Int32)">
 <summary>
 function to raise the event DecompressProgressChanged
 </summary>
 <remarks> 
 #New: 3.2000;07.01.2025;S.Gueth
 </remarks>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.CreateFor(System.String)">
 <summary>
 Erzeugt eine für das angegebene Archiv passende CompressionProvider Instanz.
 </summary>
 <exception cref="T:System.Exception">Eine Exception wird ausgelöst falls keine passende Implementation eines CompressionProviders zur Verfügung steht.</exception>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.CreateFor(JF.Tools.Compression.CompressionProviderImplementation)">
 <summary>
 Erzeugt eine Instanz des angegebene CompressionProviders.
 </summary>
 <exception cref="T:System.Exception">Eine Exception wird ausgelöst falls keine passende Implementation eines CompressionProviders zur Verfügung steht.</exception>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.GetDesiredArchiveExtensionFor(JF.Tools.Compression.CompressionProviderImplementation)">
 <summary>
 Gibt die vorgesehene Archiv-Extension für eine bestimmte Implementation zurück.
 </summary>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.GetCompressionProviderImplementationValue(System.String,System.Nullable{JF.Tools.Compression.CompressionProviderImplementation})">
 <summary>
 Gibt den passenden Wert der <see cref="T:JF.Tools.Compression.CompressionProviderImplementation" /> Enumeration anhand eines Wertenamens zurück.
 </summary>
 <param name="providerImplementationName"></param>
 <param name="defaultProviderImplementation">Standardwert, falls keine passende Implementation gefunden wurde. Default: <see cref="F:JF.Tools.Compression.CompressionProviderImplementation.SevenZipPPMd"/>.</param>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.GetCompressionLevelValue(System.String,System.Nullable{JF.Tools.Compression.CompressionLevel})">
 <summary>
 Gibt den passenden Wert der <see cref="T:JF.Tools.Compression.CompressionLevel" /> Enumeration anhand eines Wertenamens zurück.
 </summary>
 <param name="compressionLevelName"></param>
 <param name="defaultCompressionLevel">Standardwert, falls keine passende Implementation gefunden wurde. Default: <see cref="F:JF.Tools.Compression.CompressionLevel.Highest"/>.</param>
</member>
<member name="E:JF.Tools.Compression.CompressionProvider.ItemException">
 <summary>
 Wird bei Ausnahmen für einzelne Dateien ausgelöst.<br />
 Ermöglicht das Protokollieren und Ignorieren oder Abbrechen des Vorganges.
 </summary>
</member>
<member name="M:JF.Tools.Compression.CompressionProvider.BuildFilemaskRegex(System.String)">
 <summary>
 Creates a regular expression to check for filename wildcards
 e.g. *.pdf => ^.*\.pdf$
 </summary>
 <param name="filemask"></param>
 <returns></returns>
</member>
<member name="T:JF.Tools.Compression.SevenZipCompressionProviderConfig">
 <summary>
 Defines configuration of SevenZipCompressionProvider
 </summary>
 <remarks> 
 #New: 3.1297;06.02.2017;A.Becker
 LUp: 3.1601;02.02.2022;A.Becker (default Encoding)
 </remarks>
</member>
<member name="T:JF.Tools.Compression.SevenZipCompressionProvider">
 <summary>
 Implementation eines CompressionProviders für 7z-Archive unter Verwendung der SevenZipSharp Bibliothek
 </summary>
 <remarks>New: 2.1219;05.11.2015;A.Becker</remarks>
</member>
<member name="M:JF.Tools.Compression.SevenZipCompressionProvider.DecompressImpl(System.String,System.String,System.Boolean,System.String[],System.String[])">
 <summary>
 decompress without password
 </summary>
</member>
<member name="M:JF.Tools.Compression.SevenZipCompressionProvider.DecompressImpl(System.String,System.String,System.Boolean,System.String[],System.String[],System.String)">
 <summary>
 decompress with password
 </summary>
 <remarks> 
 #New: 3.1800;30.03.2023;S.Gueth
 </remarks>
</member>
<member name="M:JF.Tools.Compression.SevenZipCompressionProvider.DecompressImplAsync(System.String,System.String,System.Boolean,System.String[],System.String[])">
 <summary>
 decompress without password async
 </summary>
 <remarks> 
 #New: 3.2000;07.01.2025;S.Gueth
 </remarks>
</member>
<member name="M:JF.Tools.Compression.SevenZipCompressionProvider.DecompressImplAsync(System.String,System.String,System.Boolean,System.String[],System.String[],System.String)">
 <summary>
 decompress with password async
 </summary>
 <remarks> 
 #New: 3.2000;07.01.2025;S.Gueth
 </remarks>
</member>
<member name="T:JF.Tools.Compression.SevenZipCompressionSource">
 <summary>
 Stellt alle zu komprimierenden Dateien und TextContents für die Komprimierung durch SevenZipPPMd als Streams zur Verfügung
 </summary>
 <remarks>
 LUp: 3.1601;02.02.2022;A.Becker (text file Encoding)
 </remarks>
</member>
<member name="T:JF.Tools.Compression.TextContentFile">
 <summary>
 Stores a string with a filename and an optional encoding request.
 </summary>
 <remarks>
 #LUp: 3.1601;02.02.2022;A.Becker (Encoding)
 #LUp: 3.2000;16.01.2024;J.Fes add Public Property FilePathSource_DPNE As String
 </remarks>
</member>
<member name="P:JF.Tools.Compression.TextContentFile.Archiv_PPNE">
 <summary>
 relative path Archiv file 
 <para/>#Doc: renamed from FilePathWithinArchive to ArchivFile_PPNE
 <para/>#Exa: SubDirL1XX\FileXX.txt 
 <para/>#Exa: SubDirL1yy\SubDirL2zz\FileXX.txt 
 </summary>
</member>
<member name="P:JF.Tools.Compression.TextContentFile.Source_DPNE">
 <summary>
 full path to origin file 
 <para/>#Exa: C:\MyData\SubDir1\FileXX.txt
 </summary>
 <remarks> 
 #New: 3.2000;16.01.2024;J.Fes
 </remarks>
</member>
<member name="P:JF.Tools.Compression.TextContentFile.TextContent">
 <summary>
 Contains the Textcontent of file
 </summary>
</member>
<member name="P:JF.Tools.Compression.TextContentFile.Encoding">
 <summary>
 Defines Text encoding 
 </summary>
</member>
<member name="P:JF.Tools.Compression.TextContentFile.TextContentProcess">
 <summary>
 Defines a process key for programming <see cref="T:JF.Tools.Compression.TextContentFile.TextContentProcess_enum"/>
 </summary>
 <returns></returns>
</member>
<member name="T:JF.Tools.Compression.TextContentFile.TextContentProcess_enum">
 <summary>
 Defines Process TextContentDoProcess enumeration
 </summary>
 <remarks> 
 #New: 3.2000;16.01.2024;J.Fes
 </remarks>
</member>
<member name="M:JF.Tools.Compression.TextContentFile.#ctor(System.String,System.String,System.Text.Encoding)">
 <summary>
 Creates a text content file with a given encoding.
 </summary>
 <param name="Archiv_PPNE_p">The name of the file in Archiv</param>
 <param name="TextContent_p">The Archiv file content</param>
 <param name="Encoding_p">The encoding to be used.</param>
</member>
<member name="M:JF.Tools.Compression.TextContentFile.New1(System.String,System.String)">
 <summary>
 Creates a text content file without specifying the encoding.
 While compressing the encoding specified on the <see cref="T:JF.Tools.Compression.CompressionProvider"/> is used instead.
 <para/>#Doc: Batch-Files (.cmd and .bat) are encoded using OEM(1252) charset.
 </summary>
 <param name="Archiv_PPNE_p">The name of the file.</param>
 <param name="TextContent_P">The string to be encoded into the file.</param>
</member>
</members>
</doc>
