1. IronZIP
2. Get Started

Getting Started with IronZIP

IronZIP: Your All-in-One Archive Library for .NET

IronZIP is an archive compression and decompression library developed by Iron Software. In addition to the widely used ZIP format, it can also handle TAR, GZIP, and BZIP2.

Compatibility

IronZIP has cross-platform support compatibility with:

.NET Version Support:

• C#, VB.NET, F#
• .NET 7, 6, 5, and Core 3.1+
• .NET Standard (2.0+)
• .NET Framework (4.6.2+)

Operating Systems and Environments Support:

• Windows (10+, Server 2016+)
• Linux (Ubuntu, Debian, CentOS, etc.)
• macOS (10+)
• iOS (12+)
• Android API 21+ (v5 “Lollipop”)
• Docker (Windows, Linux, Azure)
• Azure (VPS, WebApp, Function)
• AWS (EC2, Lambda)

.NET Project Types Support:

• Web (Blazor & WebForms)
• Mobile (Xamarin & MAUI)
• Desktop (WPF & MAUI)
• Console (App & Library)

Installation

IronZIP Library

Installing the IronZIP is quick and easy, please install the package like this:

Install-Package IronZip

Alternatively, download directly from the official IronZIP NuGet website.

Once installed, you can get started by adding using IronZip; to the top of your C# code.

Applying License Key

Next, apply a valid license or trial key to IronZIP by assigning the license key to the LicenseKey property of License class. Include the following code right after the import statement, before using any IronZIP methods:

:path=/static-assets/zip/content-code-examples/get-started/get-started-license.cs

IronZip.License.LicenseKey = "IRONZIP.MYLICENSE.KEY.1EF01";

IronZip.License.LicenseKey = "IRONZIP.MYLICENSE.KEY.1EF01"

Code Examples

Create an Archive Example

Create a ZIP file using the 'using' statement. Inside the using block, use the AddArchiveEntry method to import files into the ZIP file. Finally, export the ZIP file with the SaveAs method.

:path=/static-assets/zip/content-code-examples/get-started/get-started-1.cs

using IronZip;

// Create an empty ZIP
using (var archive = new IronZipArchive())
{
    // Add files to the ZIP
    archive.Add("./assets/image1.png");
    archive.Add("./assets/image2.png");

    // Export the ZIP file
    archive.SaveAs("output.zip");
}

Imports IronZip

' Create an empty ZIP
Using archive = New IronZipArchive()
	' Add files to the ZIP
	archive.Add("./assets/image1.png")
	archive.Add("./assets/image2.png")

	' Export the ZIP file
	archive.SaveAs("output.zip")
End Using

Unarchive an Archive to Folder

Extract the content from the ZIP file using the ExtractArchiveToDirectory method. Specify the path of the target ZIP file and the extraction directory.

:path=/static-assets/zip/content-code-examples/get-started/get-started-2.cs

using IronZip;

// Extract ZIP
IronZipArchive.ExtractArchiveToDirectory("output.zip", "extracted");

Imports IronZip

' Extract ZIP
IronZipArchive.ExtractArchiveToDirectory("output.zip", "extracted")

Add Files to An Existing Archive

Passing the ZIP file path to the constructor will open the ZIP file. Utilize the same AddArchiveEntry method to add files to the opened ZIP and export it with the SaveAs method.

:path=/static-assets/zip/content-code-examples/get-started/get-started-3.cs

using IronZip;

// Open existing ZIP
using (var archive = new IronZipArchive("existing.zip"))
{
    // Add files
    archive.Add("./assets/image3.png");
    archive.Add("./assets/image4.png");

    // Export the ZIP file
    archive.SaveAs("result.zip");
}

Imports IronZip

' Open existing ZIP
Using archive = New IronZipArchive("existing.zip")
	' Add files
	archive.Add("./assets/image3.png")
	archive.Add("./assets/image4.png")

	' Export the ZIP file
	archive.SaveAs("result.zip")
End Using

Licensing & Support Available

IronZIP is a paid library, however free trial licenses are also available here.

For more information about Iron Software please visit our website: https://ironsoftware.com/ For more support and inquiries, please ask our team.

Support from Iron Software

For general support and technical inquiries, please email us at: support@ironsoftware.com