Class ZipFile

Inheritance
System.Object
ZipFile
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: ArtOfTest.WebAii.Zip.Zip
Assembly: ArtOfTest.WebAii.dll

Syntax

[Guid("ebc25cf6-9120-4283-b972-0e5520d00005")]
[ComVisible(true)]
[ClassInterface(ClassInterfaceType.AutoDispatch)]
public class ZipFile : IEnumerable<ZipEntry>, IEnumerable, IDisposable

Constructors

ZipFile()

Declaration
public ZipFile()

ZipFile(String)

Declaration
public ZipFile(string fileName)
Parameters
System.String fileName

ZipFile(String, TextWriter)

Declaration
public ZipFile(string fileName, TextWriter statusMessageWriter)
Parameters
System.String fileName

System.IO.TextWriter statusMessageWriter

ZipFile(String, TextWriter, Encoding)

Declaration
public ZipFile(string fileName, TextWriter statusMessageWriter, Encoding encoding)
Parameters
System.String fileName

System.IO.TextWriter statusMessageWriter

System.Text.Encoding encoding

ZipFile(String, Encoding)

Declaration
public ZipFile(string fileName, Encoding encoding)
Parameters
System.String fileName

System.Text.Encoding encoding

ZipFile(Encoding)

Declaration
public ZipFile(Encoding encoding)
Parameters
System.Text.Encoding encoding

Fields

DefaultEncoding

Declaration
public static readonly Encoding DefaultEncoding
Field Value
System.Text.Encoding

Properties

BufferSize

Declaration
public int BufferSize { get; set; }
Property Value
System.Int32

CaseSensitiveRetrieval

Declaration
public bool CaseSensitiveRetrieval { get; set; }
Property Value
System.Boolean

CodecBufferSize

Declaration
public int CodecBufferSize { get; set; }
Property Value
System.Int32

Comment

Declaration
public string Comment { get; set; }
Property Value
System.String

CompressionLevel

Declaration
public CompressionLevel CompressionLevel { get; set; }
Property Value
CompressionLevel

Count

Declaration
public int Count { get; }
Property Value
System.Int32

EmitTimesInUnixFormatWhenSaving

Declaration
public bool EmitTimesInUnixFormatWhenSaving { get; set; }
Property Value
System.Boolean

EmitTimesInWindowsFormatWhenSaving

Declaration
public bool EmitTimesInWindowsFormatWhenSaving { get; set; }
Property Value
System.Boolean

Encryption

Declaration
public EncryptionAlgorithm Encryption { get; set; }
Property Value
EncryptionAlgorithm

Entries

Declaration
public ReadOnlyCollection<ZipEntry> Entries { get; }
Property Value
System.Collections.ObjectModel.ReadOnlyCollection<ZipEntry>

EntryFileNames

Declaration
public ReadOnlyCollection<string> EntryFileNames { get; }
Property Value
System.Collections.ObjectModel.ReadOnlyCollection<System.String>

ExtractExistingFile

Declaration
public ExtractExistingFileAction ExtractExistingFile { get; set; }
Property Value
ExtractExistingFileAction

FlattenFoldersOnExtract

Declaration
public bool FlattenFoldersOnExtract { get; set; }
Property Value
System.Boolean

ForceNoCompression

Declaration
public bool ForceNoCompression { get; set; }
Property Value
System.Boolean

FullScan

Declaration
public bool FullScan { get; set; }
Property Value
System.Boolean

Item[Int32]

Declaration
public ZipEntry this[int ix] { get; set; }
Parameters
System.Int32 ix

Property Value
ZipEntry

Item[String]

Declaration
public ZipEntry this[string fileName] { get; set; }
Parameters
System.String fileName

Property Value
ZipEntry

LibraryVersion

Declaration
public static Version LibraryVersion { get; }
Property Value
System.Version

Name

Declaration
public string Name { get; set; }
Property Value
System.String

OutputUsedZip64

Declaration
public bool? OutputUsedZip64 { get; }
Property Value
System.Nullable<System.Boolean>

Password

Declaration
public string Password { set; }
Property Value
System.String

ProvisionalAlternateEncoding

Declaration
public Encoding ProvisionalAlternateEncoding { get; set; }
Property Value
System.Text.Encoding

RequiresZip64

Declaration
public bool? RequiresZip64 { get; }
Property Value
System.Nullable<System.Boolean>

StatusMessageTextWriter

Declaration
public TextWriter StatusMessageTextWriter { get; set; }
Property Value
System.IO.TextWriter

Strategy

Declaration
public CompressionStrategy Strategy { get; set; }
Property Value
CompressionStrategy

TempFileFolder

Declaration
public string TempFileFolder { get; set; }
Property Value
System.String

UseUnicodeAsNecessary

Declaration
public bool UseUnicodeAsNecessary { get; set; }
Property Value
System.Boolean

UseZip64WhenSaving

Declaration
public Zip64Option UseZip64WhenSaving { get; set; }
Property Value
Zip64Option

WantCompression

Declaration
public WantCompressionCallback WantCompression { get; set; }
Property Value
WantCompressionCallback

WillReadTwiceOnInflation

Declaration
public ReReadApprovalCallback WillReadTwiceOnInflation { get; set; }
Property Value
ReReadApprovalCallback

ZipErrorAction

Declaration
public ZipErrorAction ZipErrorAction { get; set; }
Property Value
ZipErrorAction

Methods

AddDirectory(String)

Declaration
public ZipEntry AddDirectory(string directoryName)
Parameters
System.String directoryName

Returns
ZipEntry

AddDirectory(String, String)

Declaration
public ZipEntry AddDirectory(string directoryName, string directoryPathInArchive)
Parameters
System.String directoryName

System.String directoryPathInArchive

Returns
ZipEntry

AddDirectoryByName(String)

Declaration
public ZipEntry AddDirectoryByName(string directoryNameInArchive)
Parameters
System.String directoryNameInArchive

Returns
ZipEntry

AddEntry(String, String, Byte[])

Declaration
public ZipEntry AddEntry(string fileName, string directoryPathInArchive, byte[] byteContent)
Parameters
System.String fileName

System.String directoryPathInArchive

System.Byte[] byteContent

Returns
ZipEntry

AddEntry(String, String, Stream)

Declaration
public ZipEntry AddEntry(string fileName, string directoryPathInArchive, Stream stream)
Parameters
System.String fileName

System.String directoryPathInArchive

System.IO.Stream stream

Returns
ZipEntry

AddEntry(String, String, String)

Declaration
public ZipEntry AddEntry(string fileName, string directoryPathInArchive, string content)
Parameters
System.String fileName

System.String directoryPathInArchive

System.String content

Returns
ZipEntry

AddEntry(String, String, String, Encoding)

Declaration
public ZipEntry AddEntry(string fileName, string directoryPathInArchive, string content, Encoding encoding)
Parameters
System.String fileName

System.String directoryPathInArchive

System.String content

System.Text.Encoding encoding

Returns
ZipEntry

AddFile(String)

Declaration
public ZipEntry AddFile(string fileName)
Parameters
System.String fileName

Returns
ZipEntry

AddFile(String, String)

Declaration
public ZipEntry AddFile(string fileName, string directoryPathInArchive)
Parameters
System.String fileName

System.String directoryPathInArchive

Returns
ZipEntry

AddFiles(IEnumerable<String>)

Declaration
public void AddFiles(IEnumerable<string> fileNames)
Parameters
System.Collections.Generic.IEnumerable<System.String> fileNames

AddFiles(IEnumerable<String>, Boolean, String)

Declaration
public void AddFiles(IEnumerable<string> fileNames, bool preserveDirHierarchy, string directoryPathInArchive)
Parameters
System.Collections.Generic.IEnumerable<System.String> fileNames

System.Boolean preserveDirHierarchy

System.String directoryPathInArchive

AddFiles(IEnumerable<String>, String)

Declaration
public void AddFiles(IEnumerable<string> fileNames, string directoryPathInArchive)
Parameters
System.Collections.Generic.IEnumerable<System.String> fileNames

System.String directoryPathInArchive

AddItem(String)

Declaration
public ZipEntry AddItem(string fileOrDirectoryName)
Parameters
System.String fileOrDirectoryName

Returns
ZipEntry

AddItem(String, String)

Declaration
public ZipEntry AddItem(string fileOrDirectoryName, string directoryPathInArchive)
Parameters
System.String fileOrDirectoryName

System.String directoryPathInArchive

Returns
ZipEntry

AddSelectedFiles(String)

Declaration
public void AddSelectedFiles(string selectionCriteria)
Parameters
System.String selectionCriteria

AddSelectedFiles(String, Boolean)

Declaration
public void AddSelectedFiles(string selectionCriteria, bool recurseDirectories)
Parameters
System.String selectionCriteria

System.Boolean recurseDirectories

AddSelectedFiles(String, String)

Declaration
public void AddSelectedFiles(string selectionCriteria, string directoryOnDisk)
Parameters
System.String selectionCriteria

System.String directoryOnDisk

AddSelectedFiles(String, String, Boolean)

Declaration
public void AddSelectedFiles(string selectionCriteria, string directoryOnDisk, bool recurseDirectories)
Parameters
System.String selectionCriteria

System.String directoryOnDisk

System.Boolean recurseDirectories

AddSelectedFiles(String, String, String)

Declaration
public void AddSelectedFiles(string selectionCriteria, string directoryOnDisk, string directoryPathInArchive)
Parameters
System.String selectionCriteria

System.String directoryOnDisk

System.String directoryPathInArchive

AddSelectedFiles(String, String, String, Boolean)

Declaration
public void AddSelectedFiles(string selectionCriteria, string directoryOnDisk, string directoryPathInArchive, bool recurseDirectories)
Parameters
System.String selectionCriteria

System.String directoryOnDisk

System.String directoryPathInArchive

System.Boolean recurseDirectories

Contains(String)

Declaration
public bool Contains(string entry)
Parameters
System.String entry

Returns
System.Boolean

Dispose()

Declaration
public void Dispose()
Implements
System.IDisposable.Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposeManagedResources)
Parameters
System.Boolean disposeManagedResources

ExtractAll(String)

Declaration
public void ExtractAll(string path)
Parameters
System.String path

ExtractAll(String, ExtractExistingFileAction)

Declaration
public void ExtractAll(string path, ExtractExistingFileAction extractExistingFile)
Parameters
System.String path

ExtractExistingFileAction extractExistingFile

ExtractSelectedEntries(String)

Declaration
public void ExtractSelectedEntries(string selectionCriteria)
Parameters
System.String selectionCriteria

ExtractSelectedEntries(String, ExtractExistingFileAction)

Declaration
public void ExtractSelectedEntries(string selectionCriteria, ExtractExistingFileAction extractExistingFile)
Parameters
System.String selectionCriteria

ExtractExistingFileAction extractExistingFile

ExtractSelectedEntries(String, String)

Declaration
public void ExtractSelectedEntries(string selectionCriteria, string directoryPathInArchive)
Parameters
System.String selectionCriteria

System.String directoryPathInArchive

ExtractSelectedEntries(String, String, String)

Declaration
public void ExtractSelectedEntries(string selectionCriteria, string directoryInArchive, string extractDirectory)
Parameters
System.String selectionCriteria

System.String directoryInArchive

System.String extractDirectory

ExtractSelectedEntries(String, String, String, ExtractExistingFileAction)

Declaration
public void ExtractSelectedEntries(string selectionCriteria, string directoryPathInArchive, string extractDirectory, ExtractExistingFileAction extractExistingFile)
Parameters
System.String selectionCriteria

System.String directoryPathInArchive

System.String extractDirectory

ExtractExistingFileAction extractExistingFile

Finalize()

Declaration
protected void Finalize()

GetEnumerator()

Declaration
public IEnumerator<ZipEntry> GetEnumerator()
Returns
System.Collections.Generic.IEnumerator<ZipEntry>

Implements
System.Collections.Generic.IEnumerable<T>.GetEnumerator()

GetNewEnum()

Declaration
public IEnumerator GetNewEnum()
Returns
System.Collections.IEnumerator

Initialize(String)

Declaration
public void Initialize(string fileName)
Parameters
System.String fileName

IsZipFile(Stream, Boolean)

Declaration
public static bool IsZipFile(Stream stream, bool testExtract)
Parameters
System.IO.Stream stream

System.Boolean testExtract

Returns
System.Boolean

IsZipFile(String)

Declaration
public static bool IsZipFile(string fileName)
Parameters
System.String fileName

Returns
System.Boolean

IsZipFile(String, Boolean)

Declaration
public static bool IsZipFile(string fileName, bool testExtract)
Parameters
System.String fileName

System.Boolean testExtract

Returns
System.Boolean

Read(Byte[])

Declaration
public static ZipFile Read(byte[] buffer)
Parameters
System.Byte[] buffer

Returns
ZipFile

Read(Byte[], TextWriter)

Declaration
public static ZipFile Read(byte[] buffer, TextWriter statusMessageWriter)
Parameters
System.Byte[] buffer

System.IO.TextWriter statusMessageWriter

Returns
ZipFile

Read(Byte[], TextWriter, Encoding)

Declaration
public static ZipFile Read(byte[] buffer, TextWriter statusMessageWriter, Encoding encoding)
Parameters
System.Byte[] buffer

System.IO.TextWriter statusMessageWriter

System.Text.Encoding encoding

Returns
ZipFile

Read(Stream)

Declaration
public static ZipFile Read(Stream zipStream)
Parameters
System.IO.Stream zipStream

Returns
ZipFile

Read(Stream, EventHandler<ReadProgressEventArgs>)

Declaration
public static ZipFile Read(Stream zipStream, EventHandler<ReadProgressEventArgs> readProgress)
Parameters
System.IO.Stream zipStream

System.EventHandler<ReadProgressEventArgs> readProgress

Returns
ZipFile

Read(Stream, TextWriter)

Declaration
public static ZipFile Read(Stream zipStream, TextWriter statusMessageWriter)
Parameters
System.IO.Stream zipStream

System.IO.TextWriter statusMessageWriter

Returns
ZipFile

Read(Stream, TextWriter, EventHandler<ReadProgressEventArgs>)

Declaration
public static ZipFile Read(Stream zipStream, TextWriter statusMessageWriter, EventHandler<ReadProgressEventArgs> readProgress)
Parameters
System.IO.Stream zipStream

System.IO.TextWriter statusMessageWriter

System.EventHandler<ReadProgressEventArgs> readProgress

Returns
ZipFile

Read(Stream, TextWriter, Encoding)

Declaration
public static ZipFile Read(Stream zipStream, TextWriter statusMessageWriter, Encoding encoding)
Parameters
System.IO.Stream zipStream

System.IO.TextWriter statusMessageWriter

System.Text.Encoding encoding

Returns
ZipFile

Read(Stream, TextWriter, Encoding, EventHandler<ReadProgressEventArgs>)

Declaration
public static ZipFile Read(Stream zipStream, TextWriter statusMessageWriter, Encoding encoding, EventHandler<ReadProgressEventArgs> readProgress)
Parameters
System.IO.Stream zipStream

System.IO.TextWriter statusMessageWriter

System.Text.Encoding encoding

System.EventHandler<ReadProgressEventArgs> readProgress

Returns
ZipFile

Read(Stream, Encoding)

Declaration
public static ZipFile Read(Stream zipStream, Encoding encoding)
Parameters
System.IO.Stream zipStream

System.Text.Encoding encoding

Returns
ZipFile

Read(Stream, Encoding, EventHandler<ReadProgressEventArgs>)

Declaration
public static ZipFile Read(Stream zipStream, Encoding encoding, EventHandler<ReadProgressEventArgs> readProgress)
Parameters
System.IO.Stream zipStream

System.Text.Encoding encoding

System.EventHandler<ReadProgressEventArgs> readProgress

Returns
ZipFile

Read(String)

Declaration
public static ZipFile Read(string fileName)
Parameters
System.String fileName

Returns
ZipFile

Read(String, EventHandler<ReadProgressEventArgs>)

Declaration
public static ZipFile Read(string fileName, EventHandler<ReadProgressEventArgs> readProgress)
Parameters
System.String fileName

System.EventHandler<ReadProgressEventArgs> readProgress

Returns
ZipFile

Read(String, TextWriter)

Declaration
public static ZipFile Read(string fileName, TextWriter statusMessageWriter)
Parameters
System.String fileName

System.IO.TextWriter statusMessageWriter

Returns
ZipFile

Read(String, TextWriter, EventHandler<ReadProgressEventArgs>)

Declaration
public static ZipFile Read(string fileName, TextWriter statusMessageWriter, EventHandler<ReadProgressEventArgs> readProgress)
Parameters
System.String fileName

System.IO.TextWriter statusMessageWriter

System.EventHandler<ReadProgressEventArgs> readProgress

Returns
ZipFile

Read(String, TextWriter, Encoding)

Declaration
public static ZipFile Read(string fileName, TextWriter statusMessageWriter, Encoding encoding)
Parameters
System.String fileName

System.IO.TextWriter statusMessageWriter

System.Text.Encoding encoding

Returns
ZipFile

Read(String, TextWriter, Encoding, EventHandler<ReadProgressEventArgs>)

Declaration
public static ZipFile Read(string fileName, TextWriter statusMessageWriter, Encoding encoding, EventHandler<ReadProgressEventArgs> readProgress)
Parameters
System.String fileName

System.IO.TextWriter statusMessageWriter

System.Text.Encoding encoding

System.EventHandler<ReadProgressEventArgs> readProgress

Returns
ZipFile

Read(String, Encoding)

Declaration
public static ZipFile Read(string fileName, Encoding encoding)
Parameters
System.String fileName

System.Text.Encoding encoding

Returns
ZipFile

Read(String, Encoding, EventHandler<ReadProgressEventArgs>)

Declaration
public static ZipFile Read(string fileName, Encoding encoding, EventHandler<ReadProgressEventArgs> readProgress)
Parameters
System.String fileName

System.Text.Encoding encoding

System.EventHandler<ReadProgressEventArgs> readProgress

Returns
ZipFile

RemoveEntries(ICollection<ZipEntry>)

Declaration
public void RemoveEntries(ICollection<ZipEntry> entriesToRemove)
Parameters
System.Collections.Generic.ICollection<ZipEntry> entriesToRemove

RemoveEntries(ICollection<String>)

Declaration
public void RemoveEntries(ICollection<string> entriesToRemove)
Parameters
System.Collections.Generic.ICollection<System.String> entriesToRemove

RemoveEntry(ZipEntry)

Declaration
public void RemoveEntry(ZipEntry entry)
Parameters
ZipEntry entry

RemoveEntry(String)

Declaration
public void RemoveEntry(string fileName)
Parameters
System.String fileName

RemoveSelectedEntries(String)

Declaration
public int RemoveSelectedEntries(string selectionCriteria)
Parameters
System.String selectionCriteria

Returns
System.Int32

RemoveSelectedEntries(String, String)

Declaration
public int RemoveSelectedEntries(string selectionCriteria, string directoryPathInArchive)
Parameters
System.String selectionCriteria

System.String directoryPathInArchive

Returns
System.Int32

Save()

Declaration
public void Save()

Save(Stream)

Declaration
public void Save(Stream outputStream)
Parameters
System.IO.Stream outputStream

Save(String)

Declaration
public void Save(string fileName)
Parameters
System.String fileName

SelectEntries(String)

Declaration
public ICollection<ZipEntry> SelectEntries(string selectionCriteria)
Parameters
System.String selectionCriteria

Returns
System.Collections.Generic.ICollection<ZipEntry>

SelectEntries(String, String)

Declaration
public ICollection<ZipEntry> SelectEntries(string selectionCriteria, string directoryPathInArchive)
Parameters
System.String selectionCriteria

System.String directoryPathInArchive

Returns
System.Collections.Generic.ICollection<ZipEntry>

ToString()

Declaration
public override string ToString()
Returns
System.String

Overrides
System.Object.ToString()

UpdateDirectory(String)

Declaration
public ZipEntry UpdateDirectory(string directoryName)
Parameters
System.String directoryName

Returns
ZipEntry

UpdateDirectory(String, String)

Declaration
public ZipEntry UpdateDirectory(string directoryName, string directoryPathInArchive)
Parameters
System.String directoryName

System.String directoryPathInArchive

Returns
ZipEntry

UpdateEntry(String, String, Byte[])

Declaration
public ZipEntry UpdateEntry(string fileName, string directoryPathInArchive, byte[] byteContent)
Parameters
System.String fileName

System.String directoryPathInArchive

System.Byte[] byteContent

Returns
ZipEntry

UpdateEntry(String, String, Stream)

Declaration
public ZipEntry UpdateEntry(string fileName, string directoryPathInArchive, Stream stream)
Parameters
System.String fileName

System.String directoryPathInArchive

System.IO.Stream stream

Returns
ZipEntry

UpdateEntry(String, String, String)

Declaration
public ZipEntry UpdateEntry(string fileName, string directoryPathInArchive, string content)
Parameters
System.String fileName

System.String directoryPathInArchive

System.String content

Returns
ZipEntry

UpdateEntry(String, String, String, Encoding)

Declaration
public ZipEntry UpdateEntry(string fileName, string directoryPathInArchive, string content, Encoding encoding)
Parameters
System.String fileName

System.String directoryPathInArchive

System.String content

System.Text.Encoding encoding

Returns
ZipEntry

UpdateFile(String)

Declaration
public ZipEntry UpdateFile(string fileName)
Parameters
System.String fileName

Returns
ZipEntry

UpdateFile(String, String)

Declaration
public ZipEntry UpdateFile(string fileName, string directoryPathInArchive)
Parameters
System.String fileName

System.String directoryPathInArchive

Returns
ZipEntry

UpdateFiles(IEnumerable<String>)

Declaration
public void UpdateFiles(IEnumerable<string> fileNames)
Parameters
System.Collections.Generic.IEnumerable<System.String> fileNames

UpdateFiles(IEnumerable<String>, String)

Declaration
public void UpdateFiles(IEnumerable<string> fileNames, string directoryPathInArchive)
Parameters
System.Collections.Generic.IEnumerable<System.String> fileNames

System.String directoryPathInArchive

UpdateItem(String)

Declaration
public void UpdateItem(string itemName)
Parameters
System.String itemName

UpdateItem(String, String)

Declaration
public void UpdateItem(string itemName, string directoryPathInArchive)
Parameters
System.String itemName

System.String directoryPathInArchive

UpdateSelectedFiles(String, String, String, Boolean)

Declaration
public void UpdateSelectedFiles(string selectionCriteria, string directoryOnDisk, string directoryPathInArchive, bool recurseDirectories)
Parameters
System.String selectionCriteria

System.String directoryOnDisk

System.String directoryPathInArchive

System.Boolean recurseDirectories

Events

AddProgress

Declaration
public event EventHandler<AddProgressEventArgs> AddProgress
Event Type
System.EventHandler<AddProgressEventArgs>

ExtractProgress

Declaration
public event EventHandler<ExtractProgressEventArgs> ExtractProgress
Event Type
System.EventHandler<ExtractProgressEventArgs>

ReadProgress

Declaration
public event EventHandler<ReadProgressEventArgs> ReadProgress
Event Type
System.EventHandler<ReadProgressEventArgs>

SaveProgress

Declaration
public event EventHandler<SaveProgressEventArgs> SaveProgress
Event Type
System.EventHandler<SaveProgressEventArgs>

ZipError

Declaration
public event EventHandler<ZipErrorEventArgs> ZipError
Event Type
System.EventHandler<ZipErrorEventArgs>

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
System.Collections.IEnumerator

Implements
System.Collections.IEnumerable.GetEnumerator()