ArchiveWriter Component

Properties   Methods   Events   Config Settings   Errors  

The ArchiveWriter component allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.

Syntax

nsoftware.SecureBlackbox.ArchiveWriter

Remarks

Use ArchiveWriter to compress, update, and modify files in archives. ArchiveWriter archiveWriter = new ArchiveWriter(); archiveWriter.setEncryptionType(ArchiveWriter.aetGeneric); // the type of encryption to apply to the archive archiveWriter.setEncryptionPassword("MyPassword"); // specifies the archive encryption password // creates a new archive with the desired archive type as a parameter archiveWriter.createNew(ArchiveWriter.aftZip); // add a file to the archive, the first parameter specifies the path where the file will be saved within the // archive, the second parameter the file that you want to add to the archive archiveWriter.addFile("","C:\\Photos\\MyPhoto.jpeg"); // add a collection of files to the archive, first param specifies the desired mount point for the files within the archive, // second param is the path to the files on the local system, and the last one indicates whether you want to process the // subdirectories recursively archiveWriter.addFiles("","C:\\Photos",true); archiveWriter.save("C:\\MyArchives");

The following common archive formats are supported:

• ZIP (.zip)
• GZip (.gz)
• BZip2 (.bz2)
• Tar+GZip (.tar.gz)
• Tar+Bzip2 (.tar.bz2)

Working with ArchiveWriter

Creating or opening the archive.

Use CreateNew to create a new archive, or one of the Open* methods (such as Open or OpenBytes) to open an existing compressed file.

Inspecting the archive contents

Use the Files collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' ACTION> and DATASOURCE> properties to configure bespoke processing for specific files.

Adding files to the archive

ArchiveWriter offers the following methods that you can use to add elements to the archive:

• AddFile - adds an entry with the contents of a local file.
• AddFiles - adds a set of files from a local directory.
• AddVirtual - allocates an entry in the archive. The actual data can be provided later using PrepareFile and BeforeCompressFile events.

Updating files in the archive

You can update files already present in the archive (e.g. with newer copies) using UpdateFile and UpdateFiles methods. The Remove method lets you delete individual files from the archive.

Use DecryptionPassword property to specify a decryption password for an archive and/or a specific entry within it. If the password is required but wasn't set, or if the provided password is wrong, the component will fire the DecryptionPasswordNeeded event. This event is fired repeatedly until the correct password is provided or its Cancel parameter is returned as true.

Saving and closing the archive

Once you are finished with composing/editing the archive, call the component's Save (or SaveBytes) method to save the updated archive, and then Close to close the archive file and release the associated memory.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

ArchiveType Property (ArchiveWriter Component)

The type of the archive.

Syntax

• C#
• VB.NET

public ArchiveWriterArchiveTypes ArchiveType { get; }

enum ArchiveWriterArchiveTypes {
  aftUnknown,
  aftZip,
  aftGzip,
  aftBzip2,
  aftTar,
  aftTarGzip,
  aftTarBzip2,
  aftSFX
}

Public ReadOnly Property ArchiveType As ArchivewriterArchiveTypes

Enum ArchiveWriterArchiveTypes
  aftUnknown
  aftZip
  aftGzip
  aftBzip2
  aftTar
  aftTarGzip
  aftTarBzip2
  aftSFX
End Enum

Default Value

0

Remarks

This property indicates the type of the opened archive.

This property is read-only.

CompressionAlgorithm Property (ArchiveWriter Component)

Specifies the compression algorithm to use when forming the ZIP archive.

Syntax

• C#
• VB.NET

public int CompressionAlgorithm { get; set; }

Public Property CompressionAlgorithm As Integer

Default Value

8

Remarks

Use this property to select the compression algorithm to be used when creating a ZIP archive.

A typical choice is DEFLATE, which is the default setting. Some implementations also use STORED as an alternative where no compression is required (so the resulting archive is effectively an uncompressed directory of files).

CompressionLevel Property (ArchiveWriter Component)

The compression level to apply to the archived data.

Syntax

• C#
• VB.NET

public int CompressionLevel { get; set; }

Public Property CompressionLevel As Integer

Default Value

6

Remarks

Use this property to specify the compression level (1 to 9) to apply to the archived data.

DecryptionCertificates Property (ArchiveWriter Component)

A collection of decryption certificates.

Syntax

• C#
• VB.NET

public CertificateList DecryptionCertificates { get; }

Public Property DecryptionCertificates As CertificateList

Remarks

Use this property to provide a collection of decryption certificates. All certificates should contain their respective private keys.

When processing an encrypted document, the component will walk through the certificate list to locate the matching decryption certificate. If no such certificate is found, it will fire RecipientFound event to request it.

This property is not available at design time.

DecryptionPassword Property (ArchiveWriter Component)

The decryption password.

Syntax

• C#
• VB.NET

public string DecryptionPassword { get; set; }

Public Property DecryptionPassword As String

Default Value

""

Remarks

Use this property to provide the decryption password. You can assign it explicitly before commencing file extraction, or provide it on the fly from DecryptionPasswordNeeded event handler.

EncryptionAlgorithm Property (ArchiveWriter Component)

Specifies the encryption algorithm to apply to the archive.

Syntax

• C#
• VB.NET

public string EncryptionAlgorithm { get; set; }

Public Property EncryptionAlgorithm As String

Default Value

""

Remarks

Use this property to specify the encryption algorithm to apply to the archive.

Component supports the following algorithms: AES128, AES192, AES256, BLOWFISH, TWOFISH, 3DES, 3DES112, DES, RC2, RC4. Note that not all of them may be supported by the processing software.

EncryptionCertificate Property (ArchiveWriter Component)

The encryption certificate.

Syntax

• C#
• VB.NET

public Certificate EncryptionCertificate { get; set; }

Public Property EncryptionCertificate As Certificate

Remarks

Use this property to provide the encryption certificate.

This property is not available at design time.

EncryptionKeyLength Property (ArchiveWriter Component)

The length of the encryption key.

Syntax

• C#
• VB.NET

public int EncryptionKeyLength { get; set; }

Public Property EncryptionKeyLength As Integer

Default Value

0

Remarks

Use this setting to specify the length of the encryption key in bits. Keep the key length at zero to let the component use the default value assumed by the encryption algorithm.

EncryptionPassword Property (ArchiveWriter Component)

Specifies the archive encryption password.

Syntax

• C#
• VB.NET

public string EncryptionPassword { get; set; }

Public Property EncryptionPassword As String

Default Value

""

Remarks

Use this property to provide the password to encrypt the archive with. Use it alongside EncryptionType and EncryptionAlgorithm properties to set up the whole set of protection settings for the archive.

EncryptionType Property (ArchiveWriter Component)

The type of encryption to apply to the archive.

Syntax

• C#
• VB.NET

public ArchiveWriterEncryptionTypes EncryptionType { get; set; }

enum ArchiveWriterEncryptionTypes {
  aetDefault,
  aetNoEncryption,
  aetGeneric,
  aetWinZip,
  aetStrong
}

Public Property EncryptionType As ArchivewriterEncryptionTypes

Enum ArchiveWriterEncryptionTypes
  aetDefault
  aetNoEncryption
  aetGeneric
  aetWinZip
  aetStrong
End Enum

Default Value

0

Remarks

Specifies the encryption type for the archive.

FileData Property (ArchiveWriter Component)

The contents of the file being added to the archive.

Syntax

• C#
• VB.NET

public byte[] FileData { get; set; }

Public Property FileData As Byte()

Remarks

Assign this property with a byte array containing the contents of the file being added, if you set the corresponding entry's DataSource to fdsBuffer.

Use FileStream property, with DataSource set to fdsStream, to provide the data in a stream instead. Alternatively, use fdsFile data source to supply the file data in a disk file.

This property is not available at design time.

Files Property (ArchiveWriter Component)

Lists the contents of the archive.

Syntax

• C#
• VB.NET

public ArchivedFileList Files { get; }

Public ReadOnly Property Files As ArchivedFileList

Remarks

This colletction property provides access to all files contained in the archive, both existing and newly added.

Use it to view or adjust properties of specific files, alter their data sources, and tune up actions to be performed on them.

This property is read-only and not available at design time.

FileStream Property (ArchiveWriter Component)

The contents of the file being added to the archive, in a stream.

Syntax

• C#
• VB.NET

public System.IO.Stream FileStream { get; set; }

Public Property FileStream As System.IO.Stream

Default Value

null

Remarks

Assign a stream containing the contents of the file being added to the archive to this property. Remember to assign the entry's DataSource field to fdsStream.

This property is not available at design time.

FIPSMode Property (ArchiveWriter Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

HashAlgorithm Property (ArchiveWriter Component)

Specifies the hash algorithm to be used to generate the signature.

Syntax

• C#
• VB.NET

public string HashAlgorithm { get; set; }

Public Property HashAlgorithm As String

Default Value

""

Remarks

Set this property before signing the archive to specify the hash algorithm to be used to calculate the signature.

This property is not available at design time.

NewArchive Property (ArchiveWriter Component)

Indicates whether the archive object represents a new (rather than opened) archive.

Syntax

• C#
• VB.NET

public bool NewArchive { get; }

Public ReadOnly Property NewArchive As Boolean

Default Value

False

Remarks

This property is set to true if the archive is new, or to false if the component control is editing an existing archive.

NewArchive would typically be set to true after a CreateNew call, and to false after an Open call.

This property is read-only.

Opened Property (ArchiveWriter Component)

Indicates whether component is currently in edit mode.

Syntax

• C#
• VB.NET

public bool Opened { get; }

Public ReadOnly Property Opened As Boolean

Default Value

False

Remarks

This property is set to true if the archive control is in edit mode, meaning it was opened with Open or created with CreateNew call.

When an archive is opened, you can add new files to it, remove existing files, or modify encryption attributes.

This property is read-only.

Overwrite Property (ArchiveWriter Component)

Whether the component should overwrite existing files.

Syntax

• C#
• VB.NET

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

Default Value

False

Remarks

Enable this property to force overwriting of existing files.

SigningCertificate Property (ArchiveWriter Component)

The certificate to be used for signing.

Syntax

• C#
• VB.NET

public Certificate SigningCertificate { get; set; }

Public Property SigningCertificate As Certificate

Remarks

Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

SigningChain Property (ArchiveWriter Component)

The signing certificate chain.

Syntax

• C#
• VB.NET

public CertificateList SigningChain { get; }

Public Property SigningChain As CertificateList

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

AddEmptyDir Method (ArchiveWriter Component)

Adds an empty folder to the archive.

Syntax

• C#
• VB.NET

public int AddEmptyDir(string path);

Public Function AddEmptyDir(ByVal Path As String) As Integer

Remarks

Use this method to added an empty folder to the archive with an internal path of Path.

The method returns the index of the new folder entry in the Files collection.

AddFile Method (ArchiveWriter Component)

Adds a file to the archive.

Syntax

• C#
• VB.NET

public int AddFile(string path, string localPath);

Public Function AddFile(ByVal Path As String, ByVal LocalPath As String) As Integer

Remarks

Use this method to add a disk file to the archive. Provide the local path to the file (e.g. C:\Photos\photo.jpg) via the LocalPath parameter, and the desired path within the archive (e.g. PhotosBackup2020/photo.jpg) via the Path parameter.

AddFiles Method (ArchiveWriter Component)

Adds a group of files to the archive.

Syntax

• C#
• VB.NET

public void AddFiles(string folder, string localPath, bool recursive);

Public Sub AddFiles(ByVal Folder As String, ByVal LocalPath As String, ByVal Recursive As Boolean)

Remarks

Use this method to add a collection of files to the archive.

Provide the path to the files on a local system (e.g. C:\photos) via the LocalPath parameter, and set Recursive to indicate whether you want to process the subdirectories recursively. Pass the desired mount point for the files within the archive (e.g. Backup2020/photos) via the Folder parameter.

You can use file mask wildcards in LocalPath to only select the files that match the mask.

AddVirtual Method (ArchiveWriter Component)

Adds a file placeholder to the archive.

Syntax

• C#
• VB.NET

public int AddVirtual(string path);

Public Function AddVirtual(ByVal Path As String) As Integer

Remarks

Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.

Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use PrepareFile event or Files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the BeforeCompressFile event handler.

This method returns the index of the new entry in the Files collection.

Close Method (ArchiveWriter Component)

Closes the archive.

Syntax

• C#
• VB.NET

public void Close();

Public Sub Close()

Remarks

Use this method to close the current archive and dispose of all the allocated resources.

Call this method when you are done with the archive.

Config Method (ArchiveWriter Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateNew Method (ArchiveWriter Component)

Creates a new archive.

Syntax

• C#
• VB.NET

public void CreateNew(int archiveType);

Public Sub CreateNew(ByVal ArchiveType As Integer)

Remarks

Use this method to create a new archive file. Provide the desired archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

DoAction Method (ArchiveWriter Component)

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

Open Method (ArchiveWriter Component)

Opens an archive file.

Syntax

• C#
• VB.NET

public void Open(int archiveType, string archiveName);

Public Sub Open(ByVal ArchiveType As Integer, ByVal ArchiveName As String)

Remarks

Use this method to open an existing archive file for modification.

Provide the path to the archive file via the ArchiveName parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

OpenBytes Method (ArchiveWriter Component)

Loads an archive file from a byte array.

Syntax

• C#
• VB.NET

public void OpenBytes(int archiveType, byte[] archiveBytes);

Public Sub OpenBytes(ByVal ArchiveType As Integer, ByVal ArchiveBytes As Byte())

Remarks

Use this method to load an existing archive file from a byte array.

Provide the archive stream via the ArchiveBytes parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save, SaveStream, or SaveBytes method.

OpenStream Method (ArchiveWriter Component)

Loads an archive file from a stream.

Syntax

• C#
• VB.NET

public void OpenStream(int archiveType, System.IO.Stream archiveStream);

Public Sub OpenStream(ByVal ArchiveType As Integer, ByVal ArchiveStream As System.IO.Stream)

Remarks

Use this method to load an existing archive file from a stream.

Provide the archive stream via the ArchiveStream parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

Remove Method (ArchiveWriter Component)

Removes file(s) and/or folder(s) from the archive.

Syntax

• C#
• VB.NET

public void Remove(string path);

Public Sub Remove(ByVal Path As String)

Remarks

Use this method to remove entries from the archive. Provide an archive-local path via the Path parameter.

Path supports file masks, which makes this method quite powerful (and potentially dangerous).

Reset Method (ArchiveWriter Component)

Resets the component settings.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

Reset is a generic method available in every component.

Save Method (ArchiveWriter Component)

Compresses the archive and saves it to a file.

Syntax

• C#
• VB.NET

public void Save(string archiveName);

Public Sub Save(ByVal ArchiveName As String)

Remarks

Use this method to finalize all preparations, compress all the entries set up in Files collection, and write the created archive to ArchiveName file.

This method carries out a lot of work and fires a number of events during its execution. Before the compression process starts, PrepareFile event fires repeatedly to provide the summary of what is being included into the archive. A handler of that event is a good place to make last-minute modifications to the data sources, file names, and actions to take upon the files.

Compression of each entry is surrounded with BeforeCompressFile and AfterCompressFile "brackets". Subscribe to BeforeCompressFile to supply the file contents for entries with Buffer and Stream data sources. AfterCompressFile is a good place to release the content stream alloated in the BeforeCompressFile event handler.

Progress event fires repeatedly to report the progress of the current and whole operations. It also provides an opportunity to abort the compression process.

SaveBytes Method (ArchiveWriter Component)

Compresses the archive and saves it to a byte array.

Syntax

• C#
• VB.NET

public byte[] SaveBytes();

Public Function SaveBytes() As Byte()

Remarks

Use this method to finalize all preparations and compress all entries contained in the Files collection. The method returns the byte array containing the serialized archive.

You can fine-tune the compression process by providing compression details on the fly via the events component fires. See the description of the Save method for the details.

SaveStream Method (ArchiveWriter Component)

Compresses the archive and saves it to a stream.

Syntax

• C#
• VB.NET

public void SaveStream(System.IO.Stream archiveStream);

Public Sub SaveStream(ByVal ArchiveStream As System.IO.Stream)

Remarks

Use this method to finalize all preparations and compress all entries contained in the Files collection to ArchiveStream.

You can fine-tune the compression process by providing compression details on the fly via the events component fires. See the description of the Save method for the details.

UpdateFile Method (ArchiveWriter Component)

Updates an existing compressed entry with a fresher local version.

Syntax

• C#
• VB.NET

public void UpdateFile(string path, string localPath);

Public Sub UpdateFile(ByVal Path As String, ByVal LocalPath As String)

Remarks

Call this method to update the Path entry in the archive with a fresher entry at LocalPath.

UpdateFiles Method (ArchiveWriter Component)

Updates a selection of files in the archive.

Syntax

• C#
• VB.NET

public void UpdateFiles(string folder, string localPath, bool addMissingFiles, bool removeMissingFiles, bool recursive);

Public Sub UpdateFiles(ByVal Folder As String, ByVal LocalPath As String, ByVal AddMissingFiles As Boolean, ByVal RemoveMissingFiles As Boolean, ByVal Recursive As Boolean)

Remarks

This method is a powerful way to update a subset of files in the archive in accordance with a specified criteria.

Pass an archive-local name of the folder to update via the Folder parameter, and the system-local version of the same folder via the LocalPath parameter. Set AddMissingFiles and RemoveMissingFiles as needed to force inclusion of files missing from the archive, or removal of files missing locally, accordingly.

The Recursive parameter specifies whether the directory should be browsed recursively.

UpdateVirtual Method (ArchiveWriter Component)

Updates an entry in the archive with on-the-fly content.

Syntax

• C#
• VB.NET

public void UpdateVirtual(string path);

Public Sub UpdateVirtual(ByVal Path As String)

Remarks

Use this method to update content of an existing archive entry. Pass the archive-local entry path via the Path parameter. After updating the entry, tune up its DataSource property in accordance with the desired content origin. Subscribe to BeforeCompressFile to supply the actual data via FileData or FileStream properties.

ActionNeeded Event (ArchiveWriter Component)

Requests a decision from the application in case of a conflict.

Syntax

• C#
• VB.NET

public event OnActionNeededHandler OnActionNeeded;

public delegate void OnActionNeededHandler(object sender, ArchiveWriterActionNeededEventArgs e);

public class ArchiveWriterActionNeededEventArgs : EventArgs {
  public int WhatFor { get; }
  public string EntryPath { get; }
  public string DestPath { get; }
  public string Description { get; }
  public int Action { get; set; }
}

Public Event OnActionNeeded As OnActionNeededHandler

Public Delegate Sub OnActionNeededHandler(sender As Object, e As ArchiveWriterActionNeededEventArgs)

Public Class ArchiveWriterActionNeededEventArgs Inherits EventArgs
  Public ReadOnly Property WhatFor As Integer
  Public ReadOnly Property EntryPath As String
  Public ReadOnly Property DestPath As String
  Public ReadOnly Property Description As String
  Public Property Action As Integer
End Class

Remarks

The component fires this event to request a decision from the application when it encounters a conflict.

The WhatFor parameter can take one of the following values:

You can control the further flow from the event handler by setting the Action parameter to one of the following values:

AfterCompressFile Event (ArchiveWriter Component)

Marks the completion of compression of a file.

Syntax

• C#
• VB.NET

public event OnAfterCompressFileHandler OnAfterCompressFile;

public delegate void OnAfterCompressFileHandler(object sender, ArchiveWriterAfterCompressFileEventArgs e);

public class ArchiveWriterAfterCompressFileEventArgs : EventArgs {
  public string Path { get; }
  public long FileSize { get; }
  public int DataSource { get; }
}

Public Event OnAfterCompressFile As OnAfterCompressFileHandler

Public Delegate Sub OnAfterCompressFileHandler(sender As Object, e As ArchiveWriterAfterCompressFileEventArgs)

Public Class ArchiveWriterAfterCompressFileEventArgs Inherits EventArgs
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileSize As Long
  Public ReadOnly Property DataSource As Integer
End Class

Remarks

Subscribe to this event to get notified about the completion of compression of a file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the file before compression, and the DataSource specifies the type of the source media.

BeforeCompressFile Event (ArchiveWriter Component)

Marks the start of compression of a file.

Syntax

• C#
• VB.NET

public event OnBeforeCompressFileHandler OnBeforeCompressFile;

public delegate void OnBeforeCompressFileHandler(object sender, ArchiveWriterBeforeCompressFileEventArgs e);

public class ArchiveWriterBeforeCompressFileEventArgs : EventArgs {
  public string Path { get; }
  public long FileSize { get; }
  public int DataSource { get; }
}

Public Event OnBeforeCompressFile As OnBeforeCompressFileHandler

Public Delegate Sub OnBeforeCompressFileHandler(sender As Object, e As ArchiveWriterBeforeCompressFileEventArgs)

Public Class ArchiveWriterBeforeCompressFileEventArgs Inherits EventArgs
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileSize As Long
  Public ReadOnly Property DataSource As Integer
End Class

Remarks

Subscribe to this event to be notified about the start of compression of an archive entry. The handler of this event is a good place to prepare the desired data source.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the size of the file before compression. Use this event handler to adjust the data source if the file is to be loaded from a stream or buffer. The DataSource parameter indicates the type of the data media:

Use PrepareFile event to adjust the file data source on the fly.

DecryptionPasswordNeeded Event (ArchiveWriter Component)

Fires when the component needs a password to decrypt the archive.

Syntax

• C#
• VB.NET

public event OnDecryptionPasswordNeededHandler OnDecryptionPasswordNeeded;

public delegate void OnDecryptionPasswordNeededHandler(object sender, ArchiveWriterDecryptionPasswordNeededEventArgs e);

public class ArchiveWriterDecryptionPasswordNeededEventArgs : EventArgs {
  public string PasswordTarget { get; }
  public bool Cancel { get; set; }
}

Public Event OnDecryptionPasswordNeeded As OnDecryptionPasswordNeededHandler

Public Delegate Sub OnDecryptionPasswordNeededHandler(sender As Object, e As ArchiveWriterDecryptionPasswordNeededEventArgs)

Public Class ArchiveWriterDecryptionPasswordNeededEventArgs Inherits EventArgs
  Public ReadOnly Property PasswordTarget As String
  Public Property Cancel As Boolean
End Class

Remarks

Component fires this event to request a decryption password from the application when it comes across an encrypted archive or entry.

Please assign the password to DecryptionPassword property inside the event handler, or set Cancel to true to cancel the operation. The PasswordTarget parameter references the object that is protected with the requested password.

Error Event (ArchiveWriter Component)

Reports information about errors during archive assembling.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, ArchiveWriterErrorEventArgs e);

public class ArchiveWriterErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As ArchiveWriterErrorEventArgs)

Public Class ArchiveWriterErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The event is fired in case of exceptional conditions during archive formation.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (ArchiveWriter Component)

This event notifies the application about an underlying control flow event.

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, ArchiveWriterNotificationEventArgs e);

public class ArchiveWriterNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As ArchiveWriterNotificationEventArgs)

Public Class ArchiveWriterNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

PrepareFile Event (ArchiveWriter Component)

Fires for every file to be compressed before the compression starts.

Syntax

• C#
• VB.NET

public event OnPrepareFileHandler OnPrepareFile;

public delegate void OnPrepareFileHandler(object sender, ArchiveWriterPrepareFileEventArgs e);

public class ArchiveWriterPrepareFileEventArgs : EventArgs {
  public string Path { get; }
  public long FileSize { get; }
  public int DataSource { get; set; }
  public string LocalPath { get; set; }
  public int Action { get; set; }
}

Public Event OnPrepareFile As OnPrepareFileHandler

Public Delegate Sub OnPrepareFileHandler(sender As Object, e As ArchiveWriterPrepareFileEventArgs)

Public Class ArchiveWriterPrepareFileEventArgs Inherits EventArgs
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileSize As Long
  Public Property DataSource As Integer
  Public Property LocalPath As String
  Public Property Action As Integer
End Class

Remarks

Component fires this event for every file included in the Files collection before commencing the compression. This is the last opportunity for your code to adjust the action to be taken for each file and tune up the data sources appropriately.

The Path parameter contains the path to the file within the archive (such as Photos/myphoto.jpg), and the FileSize contains the size of that file before compression.

The DataSource parameter indicates the media from which the file contents is to be taken. A typical default value if fdsFile, but you can adjust the value of that parameter if you need to use an alternative source. The following options are available:

The Action parameter, which is also tuneable, indicates the action for component to take on the file:

Progress Event (ArchiveWriter Component)

Reports the progress of data compression.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, ArchiveWriterProgressEventArgs e);

public class ArchiveWriterProgressEventArgs : EventArgs {
  public long Processed { get; }
  public long Total { get; }
  public long OverallProcessed { get; }
  public long OverallTotal { get; }
  public bool Cancel { get; set; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As ArchiveWriterProgressEventArgs)

Public Class ArchiveWriterProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Processed As Long
  Public ReadOnly Property Total As Long
  Public ReadOnly Property OverallProcessed As Long
  Public ReadOnly Property OverallTotal As Long
  Public Property Cancel As Boolean
End Class

Remarks

Subscribe to this event to be notified about compression progress.

Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

RecipientFound Event (ArchiveWriter Component)

Signifies that the archive was found to be encrypted with a digital certificate.

Syntax

• C#
• VB.NET

public event OnRecipientFoundHandler OnRecipientFound;

public delegate void OnRecipientFoundHandler(object sender, ArchiveWriterRecipientFoundEventArgs e);

public class ArchiveWriterRecipientFoundEventArgs : EventArgs {
  public string PublicKeyHash { get; }
  public bool CertFound { get; }
}

Public Event OnRecipientFound As OnRecipientFoundHandler

Public Delegate Sub OnRecipientFoundHandler(sender As Object, e As ArchiveWriterRecipientFoundEventArgs)

Public Class ArchiveWriterRecipientFoundEventArgs Inherits EventArgs
  Public ReadOnly Property PublicKeyHash As String
  Public ReadOnly Property CertFound As Boolean
End Class

Remarks

The component fires this event to notify the application that the archive was found to be encrypted with a digital certificate. The hash of the certificate's public key is provided in the PublicKeyHash parameter.

CertFound indicates whether a certificate with a matching public key hash was found in the DecryptionCertificates list. If it wasn't, you need to locate it on the system and add it to that list: component won't be able to decrypt the archive otherwise.

Please note that the certificate must have an associated private key to be capable of decryption.

ArchivedFile Type

Provides information about the compressed file.

Remarks

Use this type to access compressed file details.

Fields

Constructors

• C#
• VB.NET

public ArchivedFile();

Public ArchivedFile()

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

• C#
• VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

• C#
• VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

• C#
• VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

• C#
• VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

• C#
• VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

• C#
• VB.NET

public Certificate();

Public Certificate()

Config Settings (ArchiveWriter Component)

ArchiveWriter Config Settings

Base Config Settings

Trappable Errors (ArchiveWriter Component)