PowerTCP Zip Compression for .NET
IncludeSubs Property
Example 




Gets or sets whether subdirectories are included when using wildcards.
Syntax
<DefaultValueAttribute()>
<CategoryAttribute("Archive")>
<DescriptionAttribute("Specifies whether sub-directories should be searched when wild-cards are used to specify the files to zip, add, or insert.")>
Public Property IncludeSubs As Boolean
Dim instance As Archive
Dim value As Boolean
 
instance.IncludeSubs = value
 
value = instance.IncludeSubs
[DefaultValue()]
[Category("Archive")]
[Description("Specifies whether sub-directories should be searched when wild-cards are used to specify the files to zip, add, or insert.")]
public bool IncludeSubs {get; set;}
[DefaultValue()]
[Category("Archive")]
[Description("Specifies whether sub-directories should be searched when wild-cards are used to specify the files to zip, add, or insert.")]
public: __property bool get_IncludeSubs();
public: __property void set_IncludeSubs( 
   bool value
);
[DefaultValue()]
[Category("Archive")]
[Description("Specifies whether sub-directories should be searched when wild-cards are used to specify the files to zip, add, or insert.")]
public:
property bool IncludeSubs {
   bool get();
   void set (    bool value);
}

Property Value

A boolean value indicating whether to include subdirectories when using wildcards. Defaults to false.
Remarks

If you wish to include subdirectories when using the Archive.QuickZip method set this property to true.

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