GZipArchive Class

In This Topic

Specialization of the GZippedFolder class that represents the root folder in a gzip file, i.e., the gzip file itself. Since a gzip file cannot contain subfolders, this is the only type of folder you can get out of a gzip archive.

Syntax

Visual Basic
C#

'Declaration
 
Public Class GZipArchive 
   Inherits GZippedFolder

'Usage
 
Dim instance As GZipArchive

public class GZipArchive : GZippedFolder

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      Xceed.FileSystem.FileSystemItem
         Xceed.FileSystem.AbstractFolder
            Xceed.GZip.GZippedFolder
               Xceed.GZip.GZipArchive

Public Constructors

	Name	Description
	GZipArchive Constructor	Overloaded.

Top

Public Properties

	Name	Description
	AllowMultipleFiles	Gets or sets a boolean value indicating whether multiple files are allowed in GZip archives.
	Attributes	Gets or sets the attributes of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	CreationDateTime	Gets or sets the creation date and time of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DefaultTempFolder	Gets or sets the folder that will be used, by default, as the temporary folder.
	Exists	Gets a boolean value indicating if the item physically exists. (Inherited from Xceed.FileSystem.FileSystemItem)
	FullName	Gets the full name of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	HasAttributes	Gets a boolean value indicating if the item supports attributes. (Inherited from Xceed.FileSystem.FileSystemItem)
	HasCreationDateTime	Gets a boolean value indicating if the item supports having a creation date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	HasLastAccessDateTime	Gets a boolean value indicating if the item supports having a last access date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	HasLastWriteDateTime	Gets a boolean value indicating if the item supports having a last write date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	HostedFullName	Gets a human-readable full pathname representing the fully qualified path of all host files containing the item and the path of the item itself. (Inherited from Xceed.FileSystem.FileSystemItem)
	HostFile	Gets the actual GZip archive file this GZippedFolder exposes files from. (Inherited from Xceed.GZip.GZippedFolder)
	IsRoot	Gets a value indicating if the folder is a root folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	LastAccessDateTime	Gets or sets the last access date and time of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	LastWriteDateTime	Gets or sets the modification date and time of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	Name	Gets or sets the filename, without path, of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	ParentFolder	Gets a reference to the parent folder of this item. (Inherited from Xceed.FileSystem.FileSystemItem)
	PendingActionCount	Gets a value indicating the number of pending actions on the archive.
	RootFolder	Gets a reference to the root folder of this item. (Inherited from Xceed.FileSystem.FileSystemItem)
	TempFolder	Gets or sets the folder where the temporary gzip file will be created.

Top

Protected Properties

	Name	Description
	BatchUpdateable	Overridden. Gets an implementation of Xceed.FileSystem.IBatchUpdateable. Overrides FileSystemItem.BatchUpdateable.
	DoAttributes	Actual implementation of Attributes. (Inherited from Xceed.GZip.GZippedFolder)
	DoCreationDateTime	Actual implementation of CreationDateTime. (Inherited from Xceed.GZip.GZippedFolder)
	DoExists	Actual implementation of Xceed.FileSystem.FileSystemItem.Exists. (Inherited from Xceed.GZip.GZippedFolder)
	DoFullName	Actual implementation of Xceed.FileSystem.FileSystemItem.FullName. (Inherited from Xceed.GZip.GZippedFolder)
	DoHasAttributes	Actual implementation of HasAttributes. (Inherited from Xceed.GZip.GZippedFolder)
	DoHasCreationDateTime	Actual implementation of HasCreationDateTime. (Inherited from Xceed.GZip.GZippedFolder)
	DoHasLastAccessDateTime	Actual implementation of HasLastAccessDateTime. (Inherited from Xceed.GZip.GZippedFolder)
	DoHasLastWriteDateTime	Actual implementation of HasLastWriteDateTime. (Inherited from Xceed.GZip.GZippedFolder)
	DoIsRoot	Actual implementation of Xceed.FileSystem.AbstractFolder.IsRoot. (Inherited from Xceed.GZip.GZippedFolder)
	DoLastAccessDateTime	Actual implementation of LastAccessDateTime. (Inherited from Xceed.GZip.GZippedFolder)
	DoLastWriteDateTime	Actual implementation of LastWriteDateTime. (Inherited from Xceed.GZip.GZippedFolder)
	DoName	Actual implementation of Xceed.FileSystem.FileSystemItem.Name. (Inherited from Xceed.GZip.GZippedFolder)
	DoParentFolder	Actual implementation of Xceed.FileSystem.FileSystemItem.ParentFolder. (Inherited from Xceed.GZip.GZippedFolder)
	DoRootFolder	Actual implementation of RootFolder. (Inherited from Xceed.GZip.GZippedFolder)
	InvalidChars	Gets the characters that are invalid in file and folder names. (Inherited from Xceed.FileSystem.FileSystemItem)

Top

Public Methods

	Name	Description
	ApplyPropertiesTo	Overloaded. Copies the item's properties to another item. (Inherited from Xceed.FileSystem.FileSystemItem)
	BeginUpdate	Overloaded. Prevents a GZipArchive object from modifying its underlying physical store until the EndUpdate method is called.
	CopyFilesTo	Overloaded. Extracts all the archive's files to a destination file.
	CopyItemsTo	Overloaded. Copies the folder's items (files and empty folders) to another folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	CopyTo	Overloaded. Copies the item to another folder. (Inherited from Xceed.FileSystem.FileSystemItem)
	Create	Overloaded. Creates the physical item represented by this Xceed.FileSystem.FileSystemItem object. (Inherited from Xceed.FileSystem.FileSystemItem)
	CreateFile	Overloaded. Creates a new file in the folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	CreateFolder	Overloaded. Creates a new folder in the folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	CreateObjRef	(Inherited from System.MarshalByRefObject)
	CreateTempFile	Creates the temporary file. (Inherited from Xceed.FileSystem.AbstractFolder)
	Delete	Overloaded. Permanently deletes the physical item. (Inherited from Xceed.FileSystem.FileSystemItem)
	EndUpdate	Overloaded. Informs a GZipArchive object to apply to its underlying physical store all the modifications that have been made since the call to BeginUpdate
	GetFile	Overloaded. Returns an Xceed.FileSystem.AbstractFile object that represents a file contained in the folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	GetFiles	Overloaded. Returns a filtered list of files contained in the folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	GetFolder	Overloaded. Returns an Xceed.FileSystem.AbstractFolder object that represents a folder contained in the folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	GetFolders	Overloaded. Returns a filtered list of folders contained in the folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	GetItems	Overloaded. Returns a list of items contained in the folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	GetLifetimeService	(Inherited from System.MarshalByRefObject)
	GetMetadata	(Inherited from Xceed.FileSystem.FileSystemItem)
	InitializeLifetimeService	(Inherited from System.MarshalByRefObject)
	IsSameAs	Gets a boolean value indicating if the source and target items represent the same physical entity. (Inherited from Xceed.GZip.GZippedFolder)
	MarkForCancellation
	MoveFilesTo	Overloaded. Moves the folder's content to another folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	MoveItemsTo	Overloaded. Moves the folder's items (files and empty folders) to another folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	MoveTo	Overloaded. Moves the item to another folder. (Inherited from Xceed.FileSystem.FileSystemItem)
	Refresh	Overloaded. Re-reads the information from the physical item. (Inherited from Xceed.FileSystem.FileSystemItem)
	SetName	(Inherited from Xceed.FileSystem.FileSystemItem)
	ToString	Returns the full name of the item. (Inherited from Xceed.FileSystem.FileSystemItem)

Top

Protected Methods

	Name	Description
	ApplyPropertiesToCore	(Inherited from Xceed.FileSystem.FileSystemItem)
	BuildList	Builds a list of Xceed.FileSystem.FileSystemItem objects to process. (Inherited from Xceed.FileSystem.AbstractFolder)
	BuildListForCreate	Handles the special cases in regards to building the list of items to process when creating a Xceed.FileSystem.FileSystemItem object. (Inherited from Xceed.FileSystem.FileSystemItem)
	CreateFileMultiThreadItem	(Inherited from Xceed.FileSystem.FileSystemItem)
	CreateFolderMultiThreadItem	(Inherited from Xceed.FileSystem.FileSystemItem)
	CreateSession	Overloaded. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoApplyPropertiesFrom	This method is reserved for internal use and is not intended to be used directly from your code. (Inherited from Xceed.GZip.GZippedFolder)
	DoApplyPropertiesTo	This method is reserved for internal use and is not intended to be used directly from your code. (Inherited from Xceed.GZip.GZippedFolder)
	DoCopyTo	Copies the folder to another folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	DoCreate	Actual implementation of Xceed.FileSystem.FileSystemItem.Create. (Inherited from Xceed.GZip.GZippedFolder)
	DoDelete	Actual implementation of Xceed.FileSystem.FileSystemItem.Delete. (Inherited from Xceed.GZip.GZippedFolder)
	DoGetChildItems	Actual implementation of Xceed.FileSystem.AbstractFolder.GetItems for immediate children only. (Inherited from Xceed.GZip.GZippedFolder)
	DoGetFile	Actual implementation of Xceed.FileSystem.AbstractFolder.GetFile for a file without any path. (Inherited from Xceed.GZip.GZippedFolder)
	DoGetFiles	Retrieves an array of Xceed.FileSystem.AbstractFile objects. (Inherited from Xceed.FileSystem.AbstractFolder)
	DoGetFolder	Actual implementation of Xceed.FileSystem.AbstractFolder.GetFolder. (Inherited from Xceed.GZip.GZippedFolder)
	DoGetFolders	Actual implementation of Xceed.FileSystem.AbstractFolder.GetFolders. (Inherited from Xceed.GZip.GZippedFolder)
	DoGetItems	Retrieves an array of Xceed.FileSystem.FileSystemItem objects. (Inherited from Xceed.FileSystem.AbstractFolder)
	DoGetMetadata	(Inherited from Xceed.FileSystem.FileSystemItem)
	DoMoveTo	(Inherited from Xceed.FileSystem.FileSystemItem)
	DoRefresh	Actual implementation of Refresh. (Inherited from Xceed.GZip.GZippedFolder)
	DoSetMetadata	(Inherited from Xceed.FileSystem.FileSystemItem)
	EnsureDateIsValid	Ensures that the System.DateTime value is valid. (Inherited from Xceed.FileSystem.FileSystemItem)
	IsPathRooted	This method is reserved for internal use and is not intended to be used directly from your code. (Inherited from Xceed.GZip.GZippedFolder)
	IsPublicException	(Inherited from Xceed.FileSystem.FileSystemItem)
	ListCopyTo	Copies each item in the Xceed.FileSystem.FileSystemEventsSession object's list to each item's destination. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListCopyToCore	Copies the item pair's current Xceed.FileSystem.FileSystemItem to its target Xceed.FileSystem.FileSystemItem. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListCreate	Creates each item in the Xceed.FileSystem.FileSystemEventsSession object's list. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListCreateCore	Creates the item pair's current Xceed.FileSystem.FileSystemItem. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListDelete	Deletes each item in the Xceed.FileSystem.FileSystemEventsSession object's list. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListDeleteCore	Deletes the item pair's current Xceed.FileSystem.FileSystemItem. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListMoveTo	Moves each item in the Xceed.FileSystem.FileSystemEventsSession object's list to each item's destination. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListMoveToCore	Moves the item pair's current Xceed.FileSystem.FileSystemItem to its target Xceed.FileSystem.FileSystemItem. (Inherited from Xceed.FileSystem.FileSystemItem)
	MemberwiseClone	Overloaded. (Inherited from System.MarshalByRefObject)
	NeedsApplyPropertiesTo	(Inherited from Xceed.FileSystem.FileSystemItem)
	OnCreated	Called when a client explicitly calls Create. (Inherited from Xceed.FileSystem.FileSystemItem)
	OnSessionCreated	(Inherited from Xceed.FileSystem.FileSystemItem)
	OnSessionCreatedDestination	(Inherited from Xceed.FileSystem.FileSystemItem)

Top

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

GZipArchive Members
Xceed.GZip Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference