Comment Property (ArchiveItem)

Visual Basic (Declaration)
Visual Basic (Usage)
C#
Managed Extensions for C++
C++/CLI

<DefaultValueAttribute()>
<CategoryAttribute("ArchiveItem")>
<DescriptionAttribute("The comment of the item. Note the difference from Archive.Comment")>
Public Property Comment As String

Dim instance As ArchiveItem
Dim value As String
 
instance.Comment = value
 
value = instance.Comment

[DefaultValue()]
[Category("ArchiveItem")]
[Description("The comment of the item. Note the difference from Archive.Comment")]
public string Comment {get; set;}

[DefaultValue()]
[Category("ArchiveItem")]
[Description("The comment of the item. Note the difference from Archive.Comment")]
public: __property string* get_Comment();
public: __property void set_Comment( 
   string* value
);

[DefaultValue()]
[Category("ArchiveItem")]
[Description("The comment of the item. Note the difference from Archive.Comment")]
public:
property String^ Comment {
   String^ get();
   void set (    String^ value);
}

Property Value

A string representing the comment for the ArchiveItem object.

The following example demonstrates several Add techniques and a zip operation.

Visual Basic

' Be sure to import the namespace by putting "Imports Dart.PowerTCP.Zip"
' at the top of your class.

' Add a file using the ArchiveItem constructor
Dim item = New ArchiveItem("c:\Test\\file1.txt")

' Add a comment to this item
item.Comment = "This is file1.txt"

' Use encryption for just this item
item.Encryption = Encryption.Standard
item.Password = "testme"

Archive1.Add(item)

' Add a file using the filename.  This could also be used for adding wildcard collections
Archive1.Add("c:\Test\file2.log")

' Add a wildcard collection of files
' In this case, all "txt" files in the directory "c:\Test" are added, except "file1.txt"
' Subfolders are not included, but the paths are preserved.
Archive1.IncludeSubs = True
Archive1.ExcludePattern = "file1.txt"
Archive1.PreservePath = True
Archive1.Add("c:\Test\*.txt")

' zip the data
Archive1.Zip("c:\test.zip")

C#

// Be sure to import the namespace by putting "using Dart.PowerTCP.Zip;"
// at the top of your class.

// Add a file using the ArchiveItem constructor
ArchiveItem item = new ArchiveItem("c:\\Test\\file1.txt");

// Add a comment to this item
item.Comment = "This is file1.txt";

// Use encryption for just this item
item.Encryption = Encryption.Standard;
item.Password = "testme";

archive1.Add(item);

// Add a file using the filename.  This could also be used for adding wildcard collections
archive1.Add("c:\\Test\\file2.log");

// Add a wildcard collection of files
// In this case, all "txt" files in the directory "c:\Test" are added, except "file1.txt"
// Subfolders are not included, but the paths are preserved.
archive1.IncludeSubs = true;
archive1.ExcludePattern= "file1.txt";
archive1.PreservePath = true;
archive1.Add("c:\\Test\\*.txt");

// Zip the data
archive1.Zip("c:\\test.zip");

Reference

ArchiveItem Class
ArchiveItem Members