https://github.com/iron-software/ironzip.examples
Documentation and code examples for IronZIP (ironsoftware.com/csharp/zip)
https://github.com/iron-software/ironzip.examples
Last synced: about 2 months ago
JSON representation
Documentation and code examples for IronZIP (ironsoftware.com/csharp/zip)
- Host: GitHub
- URL: https://github.com/iron-software/ironzip.examples
- Owner: iron-software
- Created: 2024-12-04T06:37:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-20T21:42:41.000Z (8 months ago)
- Last Synced: 2026-05-20T07:59:32.038Z (2 months ago)
- Language: C#
- Size: 58.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
  %20-107C10?logo=visualstudio) [](https://ironsoftware.com/csharp/zip/docs/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=topshield)   ](https://ironsoftware.com/csharp/zip/docs/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=topshield) [(IronSoftware Customer Support)](https://ironsoftware.com/csharp/zip/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs#helpscout-support)
## Introducing IronZIP - Your C# Solution for ZIP Archive Management
### IronZIP: A Powerful C# Toolkit for File Archiving
[](https://ironsoftware.com/csharp/zip/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=topbanner#trial-license)
##### IronZIP offers a robust C# library tailored for developers looking to integrate seamless file compression into their .NET applications. The library is designed to make it straightforward to generate, extract, and manage ZIP files and incorporates AES encryption for security and comprehensive file handling right within the application.
### **[Begin Your Journey](https://ironsoftware.com/csharp/zip/docs/) with Three Simple Steps**
#### 1. Installation via NuGet
PM> Install-Package IronZIP
#### 2. Basic Archiving Operations
using IronZip;
string filePath = "./archive.zip";
IronZipArchive.ExtractArchiveToDirectory(filePath, "unarchived"); // Extracting ZIP contents to folder 'unarchived'
// Initiating a new ZIP archive
using (var archive = new IronZipArchive())
{
// Adding files
archive.Add("./assets/doc.pdf");
archive.Add("./assets/img.png");
// Writing ZIP to disk
archive.SaveAs("./output/archive.zip");
}
#### 3. Extend Your Knowledge
Delve into our in-depth resources for detailed information and hands-on examples:
* **[Tutorials](https://ironsoftware.com/csharp/zip/tutorials/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Comprehensive guides to get you started on building your first ZIP-managing application.
* **[Code Examples](https://ironsoftware.com/csharp/zip/examples/create-zip/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Direct, usable code samples for frequent tasks.
* **[How-To Guides](https://ironsoftware.com/csharp/zip/how-to/license-keys/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Targeted instructions tailored to help you tackle specific challenges.
* **[Demonstrations](https://ironsoftware.com/csharp/zip/docs/#booking-demo)**: Demonstrations that highlight IronZIP’s capabilities and performance.
* **[API Details](https://ironsoftware.com/csharp/ocr/object-reference/api/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Exhaustive technical breakdowns of the API and its components.
### **Key Features**
* **Archive Creation**: Dynamically build ZIP archives from various file types, with options for compression settings.
* **Archive Security**: Apply AES encryption to safeguard your ZIP files thoroughly.
* **Archive Extraction**: Easily uncompress files from a ZIP archive onto your local disk or into your server.
### **Compatibility**
#### Built for Contemporary .NET Environments, IronZIP Supports a Broad Range of Systems and Platforms.
* **Supported Platforms**: **.NET 10**, .NET 9, .NET 8..., down to .NET Framework 4.6.2
* **Application Models**: Suitable for Desktop, Web, and Console applications.
* **Operating Environments**: Compatible with Windows, macOS, and Linux distributions like Debian, CentOS, and Ubuntu.
* **Cloud Services and Containers**: Fully functional on Azure, AWS, and Docker.
* **Development Environments**: Optimal for use with Microsoft Visual Studio, JetBrains ReSharper, and Rider.
[](https://ironsoftware.com/csharp/zip/docs/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=crossplatformbanner)
### **License Information**
IronZIP is available under a commercial license.
* **Trial Period**: Start with a free developer key to fully explore the capabilities without any commitments. Perfect for testing and development phases. Initiate your trial [HERE](https://ironsoftware.com/csharp/zip/licensing/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs#trial-license).
* **Full License**: Secure a license for commercial use and gain access to comprehensive support services. Procure your license [HERE](https://ironsoftware.com/csharp/zip/licensing/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs).
### **Assistance and Community Engagement**
Facing issues or have queries?
* **Direct Email Assistance**: Contact us at support@ironsoftware.com.
* **Real-Time Chat Support**: [https://ironsoftware.com/csharp/zip/#helpscout-support](https://ironsoftware.com/csharp/zip/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs#helpscout-support)
* **Issue Reporting**:
* **Join Our Community**:
### IronZip: A Versatile C# Library for Archiving Various File Types
IronZip is your go-to library in C# for archiving numerous kinds of files, such as PDFs, images, and text documents.
[](https://ironsoftware.com/csharp/zip/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=topbanner#trial-license)
##### IronZIP provides a robust and comprehensive C# library designed to facilitate quick and dependable file compression within .NET applications. Its user-friendly API allows developers to effortlessly create, extract, and adjust archives, implement AES encryption, and incorporate powerful file management features into their software.
### **[Begin Your Journey](https://ironsoftware.com/csharp/zip/docs/) with Three Simple Steps**
#### 1. Install the NuGet Package
```shell
PM> Install-Package IronZIP
```
#### 2. Basic Archiving Example
```csharp
using IronZip;
string filePath = "./archive.zip";
IronZipArchive.ExtractArchiveToDirectory(filePath, "unarchived"); // This decompresses files into the 'unarchived' folder
// Creating a new ZIP archive
using (var archive = new IronZipArchive())
{
// Adding files to the archive
archive.Add("./assets/doc.pdf");
archive.Add("./assets/img.png");
// Finalizing and saving the ZIP file
archive.SaveAs("./output/archive.zip");
}
```
#### 3. Dive Deeper
Enhance your skills and knowledge with our detailed resources:
* **[Step-by-Step Tutorials](https://ironsoftware.com/csharp/zip/tutorials/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Guided tutorials to kickstart your first ZIP application.
* **[Code Samples](https://ironsoftware.com/csharp/zip/examples/create-zip/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Ready-to-use code snippets for frequently needed functions.
* **[How-To Instructions](https://ironsoftware.com/csharp/zip/how-to/license-keys/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Step-by-step guides to address specific programming challenges.
* **[Live Demos](https://ironsoftware.com/csharp/zip/docs/#booking-demo)**: Interactive demonstrations that explain the functionalities of IronZIP.
* **[API Specifications](https://ironsoftware.com/csharp/ocr/object-reference/api/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Exhaustive documentation of the API's methods and properties.
Here's the paraphrased section you requested:
#### 1. Adding the NuGet Package to Your Project
```plaintext
PM> Install-Package IronZIP
```
#### 2. Execute Basic Archiving Operations
```csharp
using IronZip;
string zipPath = "./archive.zip";
IronZipArchive.ExtractArchiveToDirectory(zipPath, "unarchived"); // Extracts files into the 'unarchived' directory
// Initiating a new ZIP archive
using (var archive = new IronZipArchive())
{
// Insert files into the archive
archive.Add("./assets/doc.pdf"); // Adding a PDF document
archive.Add("./assets/img.png"); // Adding an image file
// Save the constructed ZIP archive
archive.SaveAs("./output/archive.zip"); // The archive is stored at specified path
}
```
#### **3. Delve Further**
Enhance your expertise with our detailed documentation and varied examples:
* **[Tutorials](https://ironsoftware.com/csharp/zip/tutorials/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Comprehensive walkthroughs that guide you through creating your initial ZIP application.
* **[Code Examples](https://ironsoftware.com/csharp/zip/examples/create-zip/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Useful code samples tailored for common functionalities.
* **[How-To Guides](https://ironsoftware.com/csharp/zip/how-to/license-keys/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: Targeted, practical instructions focused on addressing distinct challenges.
* **[Demo](https://ironsoftware.com/csharp/zip/docs/#booking-demo)**: Illustrative guides that reveal the inner workings and capabilities of IronZIP.
* **[API Reference](https://ironsoftware.com/csharp/ocr/object-reference/api/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs)**: In-depth documentation detailing the components and functionalities of the API.
### **Core Capabilities**
* **Archive Creation**: Dynamically generate ZIP archives using files, offering precise control over compression settings.
* **Archive Security**: Enhance archive security by implementing strong AES encryption, safeguarding data integrity and confidentiality.
* **Archive Extraction**: Efficiently unpack entire archives into a specified directory on your local machine or server.
### **Supported Environments and Systems**
#### IronZIP is meticulously engineered to operate across a broad spectrum of .NET environments and is compatible with multiple project types and operating systems.
* **Frameworks and Versions**: Fully supports **.NET 10**, along with .NET 9, .NET 8, .NET 7, .NET 6, .NET 5, as well as .NET Core 2.x and 3.x, and .NET Standard 2.
* **Frameworks Supported**: .NET Framework starting from 4.6.2 and higher.
* **Application Models**: Suitable for various application models including Console Applications, Web Applications, and Desktop Applications.
* **Operating Systems**: Designed to run on diverse operating systems such as Windows, macOS, and Linux flavors including Debian, CentOS, and Ubuntu.
* **Cloud and Container Support**: Optimized for cloud services like Azure, Amazon Web Services, and containerization with Docker.
* **Development Environments**: Compatible with popular integrated development environments (IDEs) such as Microsoft Visual Studio, as well as Jetbrains ReSharper and Rider.
[](https://ironsoftware.com/csharp/zip/docs/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=crossplatformbanner)
#### IronZIP Compatibility Details
IronZIP is fully compatible with contemporary .NET environments and supports an array of project types across multiple operating systems.
* **Platforms Supported**: IronZIP works with **.NET 10**, .NET 9, .NET 8, .NET 7, .NET 6, .NET 5, as well as .NET Core versions 2x & 3x, and .NET Standard 2.
* **Framework Compatibility**: It is compatible with the .NET Framework version 4.6.2 and later versions.
* **Application Models**: IronZIP can be integrated into various application models including Console, Web, and Desktop applications.
* **Supported Operating Systems**: It is versatile across operating systems such as Windows, macOS, and Linux distributions including Debian, CentOS, and Ubuntu.
* **Cloud and Containerization Support**: IronZIP supports major cloud services and containerization platforms, including Azure, AWS, and Docker.
* **Development Environments**: It is designed to be used with leading Integrated Development Environments (IDEs) such as Microsoft Visual Studio and JetBrains ReSharper & Rider.
[](https://ironsoftware.com/csharp/zip/docs/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=crossplatformbanner)
### **Licensing Information**
IronZIP is available under a commercial license.
- **Free Trial License**: Obtain a complimentary developer key to fully test the capabilities of the library without any obligations, perfect for development and testing scenarios. Begin your trial [HERE](https://ironsoftware.com/csharp/zip/licensing/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs#trial-license).
- **Purchase a Full License**: Activate the library for professional use and gain access to comprehensive technical support. Secure your license [HERE](https://ironsoftware.com/csharp/zip/licensing/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs).
### **Assistance and Support**
Encountering difficulties or need guidance?
* **Email Assistance**: Contact our expert team at support@ironsoftware.com for direct help.
* **Live Support Chat**: Visit our [support page](https://ironsoftware.com/csharp/zip/?utm_source=nuget&utm_medium=organic&utm_campaign=readme&utm_content=supportanddocs#helpscout-support) for real-time assistance.
* **Bug Reporting**: Submit any software bugs you encounter [here](https://ironsoftware.com/ticket-submission/).
* **Join Our Community**: Engage with other developers and our team by joining our [Slack community](https://ironsoftware.com/company/iron-slack-community/).