ErrorEventArgs.ItemName Property

Obtains the zip item name for which the error occurs.

Namespace: DevExpress.Compression

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public string ItemName { get; }

VB.NET

Public ReadOnly Property ItemName As String

Property Value

Type	Description
String	A string that is the zip item name.

Remarks

The zip item name is the ZipItem.Name value. The ItemName allows you to identify the problematic zip item and decide whether it can be safely skipped.

If the ZipArchive object cannot process a directory containing files or it is unable to save the resulting archive, the ItemName property value is empty. In this situation, you should analyze the exception that triggered an error by calling the ErrorEventArgs.GetException method.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ItemName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

zip-compression-and-archive-api-examples/CS/CompressionLibraryExamples/ZipExamples.cs#L57

Exception e = args.GetException();
if (String.IsNullOrEmpty(args.ItemName)) {
    errorMessage = e.Message;

VB.NET

zip-compression-and-archive-api-examples/VB/CompressionLibraryExamples/ZipExamples.vb#L57

Dim e As Exception = args.GetException()
If String.IsNullOrEmpty(args.ItemName) Then
    errorMessage = e.Message