PowerTCP Zip Compression for .NET
DefaultCompressionMethod Property
Example 




Gets or sets the default compression algorithm used for data compression.
Syntax
<CategoryAttribute("Archive")>
<DefaultValueAttribute()>
<DescriptionAttribute("Sets the default compression method for zipping, if not set on the ArchiveItem.")>
Public Property DefaultCompressionMethod As CompressionMethod
Dim instance As Archive
Dim value As CompressionMethod
 
instance.DefaultCompressionMethod = value
 
value = instance.DefaultCompressionMethod
[Category("Archive")]
[DefaultValue()]
[Description("Sets the default compression method for zipping, if not set on the ArchiveItem.")]
public CompressionMethod DefaultCompressionMethod {get; set;}
[Category("Archive")]
[DefaultValue()]
[Description("Sets the default compression method for zipping, if not set on the ArchiveItem.")]
public: __property CompressionMethod get_DefaultCompressionMethod();
public: __property void set_DefaultCompressionMethod( 
   CompressionMethod value
);
[Category("Archive")]
[DefaultValue()]
[Description("Sets the default compression method for zipping, if not set on the ArchiveItem.")]
public:
property CompressionMethod DefaultCompressionMethod {
   CompressionMethod get();
   void set (    CompressionMethod value);
}

Property Value

A CompressionMethod value specifying the method used for data compression. The default value is CompressionMethod.Deflate.
Remarks

During a collection level compression operation, if ArchiveItem.CompressionMethod is set, the value of DefaultCompressionMethod is ignored when compressing that item. If ArchiveItem.CompressionMethod is not set, the value of DefaultCompressionMethod is used during a compression operation.

Setting CompressionMethod.Store will archive the data to a zip file without performing any compression.

Example
The following example demonstrates using QuickZip and specifying specific options. Only QuickZip is required in this operation.
' Be sure to import the namespace by putting "Imports Dart.PowerTCP.Zip"
' at the top of your class.

' Preserve the path structure of the files
Archive1.PreservePath = True
	
' Include any subdirectories
Archive1.IncludeSubs = True
	
' Specify compression level
Archive1.CompressionLevel = CompressionLevel.Medium

' Use the Deflate compression method
Archive1.DefaultCompressionMethod = CompressionMethod.Deflate

' Exclude any text files
Archive1.ExcludePattern = "*.txt"

' Set to use encryption
Archive1.DefaultEncryption = Encryption.Standard

' Specify the password
Archive1.Password = "testme"

' Perform the compression operation - this is the only required method for the operation
Archive1.QuickZip("c:\\Test\\*.*", "c:\\test.zip")
// Be sure to import the namespace by putting "using Dart.PowerTCP.Zip;"
// at the top of your class.

// Preserve the path structure of the files
archive1.PreservePath = true;

// Include any subdirectories
archive1.IncludeSubs = true;
			
// Specify compression level
archive1.CompressionLevel = CompressionLevel.Medium;
			
// Use the Deflate compression method
archive1.DefaultCompressionMethod = CompressionMethod.Deflate;
			
// Exclude any text files
archive1.ExcludePattern = "*.txt";
			
// Set to use encryption
archive1.DefaultEncryption = Encryption.Standard;

// Specify the password
archive1.Password = "testme";
			
// Perform the compression operation - this is the only required method for the operation
archive1.QuickZip("c:\\Test\\*.*", "c:\\test.zip");
See Also

Reference

Archive Class
Archive Members


PowerTCP Zip for .NET Documentation Version 2.1.1
© 2018 Dart Communications. All Rights Reserved.
Send comments on this topic