Skip to content

Commit 0b5b8e6

Browse files
2 parents 78522e7 + 48e746b commit 0b5b8e6

File tree

1 file changed

+158
-1
lines changed

1 file changed

+158
-1
lines changed

README.md

Lines changed: 158 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,158 @@
1-
# Xceed-Zip-Samples
1+
![NuGet Downloads](https://img.shields.io/nuget/dt/Xceed.Products.Zip.Full) ![Static Badge](https://img.shields.io/badge/.Net_Framework-4.0%2B-blue) ![Static Badge](https://img.shields.io/badge/.Net-5.0%2B-blue) [![Learn More](https://img.shields.io/badge/Learn-More-blue?style=flat&labelColor=gray)](https://xceed.com/en/our-products/product/zip-for-net)
2+
3+
[![Xceed Zip for .NET](./Resources/zip_banner.png)](https://xceed.com/en/our-products/product/zip-for-net)
4+
5+
# Xceed Zip for .NET - Examples
6+
7+
Welcome to the Xceed Zip for .NET Samples repository. This repository provides a collection of sample applications and code snippets to help you get started with the Xceed Zip for .NET library. The examples are provided in both C# and Visual Basic .NET.
8+
9+
## About The Product
10+
11+
Xceed Zip for .NET is a powerful and versatile library that provides easy-to-use APIs for compressing and decompressing files, creating and extracting zip archives, and more. With its high performance and comprehensive feature set, it is the ideal choice for developers who need robust file compression capabilities. Key features include:
12+
13+
- **Comprehensive Compression**: Supports standard zip and zipx formats, and can create self-extracting zip files.
14+
- **Strong Encryption**: Includes AES encryption to secure your compressed files.
15+
- **Multi-threaded Compression**: Take advantage of multi-core processors to speed up the compression process.
16+
- **Stream Support**: Read and write zip files directly to/from streams.
17+
- **Flexible APIs**: Provides both low-level and high-level APIs for maximum flexibility.
18+
- **Compatibility**: Fully compatible with .NET Standard, .NET Core, and .NET Framework.
19+
20+
For more information, please visit the [official product page](https://xceed.com/en/our-products/product/zip-for-net).
21+
22+
### Why Choose Xceed Zip for .NET?
23+
24+
- The richest feature set with over 200 capabilities
25+
- Supports the latest zip file format standards
26+
- Used and trusted by Microsoft in their server products
27+
- Supports .NET 4.5, 5, 6 and 7 (including .NET core and .NET Standard)
28+
-
29+
## Getting Started with the Xceed Zip for .NET
30+
31+
To get started, clone this repository and explore the various sample projects provided. Each sample demonstrates different features and capabilities of Xceed Zip for .NET.
32+
33+
### Requirements
34+
- Visual Studio 2015 or later
35+
- .NET Framework 4.0 or later
36+
- .NET 5.0 or later
37+
38+
### 1. Installing the DataGrid from nuget
39+
To install the Xceed Zip for .NET from NuGet, follow these steps:
40+
41+
1. **Open your project in Visual Studio.**
42+
2. **Open the NuGet Package Manager Console** by navigating to `Tools > NuGet Package Manager > Package Manager Console`.
43+
3. **Run the following command:**
44+
```sh
45+
dotnet add package Xceed.Products.Zip.Full
46+
```
47+
48+
4. Alternatively, you can use the NuGet Package Manager GUI:
49+
50+
1. Right-click on your project in the Solution Explorer.
51+
2. Select Manage NuGet Packages.
52+
3. Search for Xceed.Products.Zip.Full and click Install.
53+
54+
![Nuget library](./Resources/nuget_sample.png)
55+
56+
### 2. Adding a DataGrid to the XAML
57+
58+
To add a DataGrid to your XAML, follow these steps:
59+
60+
1. **Open your XAML file (e.g., MainWindow.xaml).**
61+
2. **Add the following namespace at the top of your XAML file:**
62+
```xaml
63+
xmlns:xcdg="http://schemas.xceed.com/wpf/xaml/datagrid"
64+
```
65+
3. **Add the DataGrid control to your layout:**
66+
```xaml
67+
<xcdg:DataGridControl x:Name="myDataGrid"
68+
AutoCreateColumns="True"
69+
ItemsSource="{Binding YourDataSource}" />
70+
```
71+
4. Ensure your DataContext is set to an appropriate data source in your code-behind or ViewModel.
72+
73+
### 3. How to License the Product Using the LicenseKey Property
74+
To license the Xceed Zip for .NET using the LicenseKey property, follow these steps:
75+
76+
1. **Obtain your license key** from Xceed. (Download the product from xceed.com or send us a request at [email protected]
77+
2. **Set the LicenseKey property in your application startup code:**
78+
```csharp
79+
using System.Windows;
80+
81+
public partial class MainWindow : Window
82+
{
83+
public MainWindow()
84+
{
85+
InitializeComponent();
86+
Xceed.Wpf.DataGrid.Licenser.LicenseKey = "Your-Key-Here";
87+
}
88+
}
89+
```
90+
3. Ensure the license key is set before any DataGrid control is instantiated.
91+
92+
## Examples Overview
93+
94+
Below is a list of the examples available in this repository:
95+
96+
- **AsyncBinding**: Demonstrates how to bind the DataGrid asynchronously.
97+
- **BatchUpdating**: Shows how to perform batch updates in the DataGrid.
98+
- **CardView**: Provides an example of displaying data in a card view layout.
99+
- **ColumnChooser**: Demonstrates how to implement a column chooser for the DataGrid.
100+
- **ColumnManagerRow**: Shows how to use a column manager row.
101+
- **CustomFiltering**: Demonstrates custom filtering techniques.
102+
- **CustomViews**: Provides examples of custom views in the DataGrid.
103+
- **DataVirtualization**: Shows how to use data virtualization to enhance performance.
104+
- **EditModes**: Demonstrates various edit modes available in the DataGrid.
105+
- **Exporting**: Provides examples of exporting data to different formats.
106+
- **FlexibleBinding**: Shows how to bind data flexibly.
107+
- **FlexibleRowsColumn**: Demonstrates flexible row and column configurations.
108+
- **Formatting**: Provides examples of data formatting.
109+
- **Grouping**: Demonstrates grouping data in the DataGrid.
110+
- **IncludedEditors**: Shows how to use included editors.
111+
- **LargeDataSets**: Demonstrates handling large datasets.
112+
- **LiveUpdating**: Shows how to update data live.
113+
- **MasterDetail**: Demonstrates master-detail views.
114+
- **MergedHeaders**: Shows how to create merged headers.
115+
- **MultiView**: Demonstrates multiple view configurations.
116+
- **MVVM**: Provides examples of using MVVM pattern with the DataGrid.
117+
- **PersistSettings**: Shows how to persist settings.
118+
- **Printing**: Demonstrates printing capabilities.
119+
- **Selection**: Shows how to handle selection in the DataGrid.
120+
- **SpannedCells**: Demonstrates cell spanning techniques.
121+
- **SummariesAndTotals**: Shows how to implement summaries and totals.
122+
- **Tableflow**: Demonstrates table flow layout.
123+
- **TableView**: Shows how to use the table view.
124+
- **Theming**: Demonstrates theming capabilities.
125+
- **TreeGridflowView**: Shows how to implement a tree grid flow view.
126+
- **Validation**: Demonstrates data validation techniques.
127+
- **Views3D**: Provides examples of 3D views.
128+
129+
## Getting Started with the Samples
130+
131+
To get started with these examples, clone the repository and open the solution file in Visual Studio.
132+
133+
```bash
134+
git clone https://github.com/your-repo/xceed-datagrid-wpf-examples.git
135+
cd xceed-datagrid-wpf-examples
136+
```
137+
Open the solution file in Visual Studio and build the project to restore the necessary NuGet packages.
138+
139+
## Requirements
140+
- Visual Studio 2015 or later
141+
- .NET Framework 4.0 or later
142+
- .NET 5.0 or later
143+
144+
## Documentation
145+
146+
For more information on how to use the Xceed Zip for .NET, please refer to the [official documentation](https://doc.xceed.com/xceed-datagrid-for-wpf/webframe.html#rootWelcome.html).
147+
148+
## Licensing
149+
150+
To receive a license key, visit [xceed.com](https://xceed.com) and download the product, or contact us directly at [[email protected]](mailto:[email protected]) and we will provide you with a trial key.
151+
152+
## Contact
153+
154+
If you have any questions, feel free to open an issue or contact us at [[email protected]](mailto:[email protected]).
155+
156+
---
157+
158+
© 2024 Xceed Software Inc. All rights reserved.

0 commit comments

Comments
 (0)