GZippedFolder Class

In This Topic

Specialization of the Xceed.FileSystem.AbstractFolder class that implements access to a folder stored in a GZip file.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
Public Class GZippedFolder 
   Inherits Xceed.FileSystem.AbstractFolder

'Usage
 
Dim instance As GZippedFolder

public class GZippedFolder : Xceed.FileSystem.AbstractFolder

Remarks

Because a GZip archive cannot contain subfolders, you cannot create a direct instance of a GZippedFolder. Instead, create a new GZipArchive, which derives from GZippedFolder and represents the root folder.

Inheritance Hierarchy

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

Protected Constructors

	Name	Description
	GZippedFolder Constructor	Overloaded. Specialization of the Xceed.FileSystem.AbstractFolder class that implements access to a folder stored in a GZip file.

Top

Public Properties

	Name	Description
	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)
	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	Overridden. Gets the actual GZip archive file this GZippedFolder exposes files from.
	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)
	RootFolder	Gets a reference to the root folder of this item. (Inherited from Xceed.FileSystem.FileSystemItem)

Top

Protected Properties

	Name	Description
	BatchUpdateable	Gets the Xceed.FileSystem.IBatchUpdateable implementation for this item, or null (Nothing in Visual Basic) if this item does not support this interface. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoAttributes	Overridden. Actual implementation of Attributes.
	DoCreationDateTime	Overridden. Actual implementation of CreationDateTime.
	DoExists	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.Exists.
	DoFullName	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.FullName.
	DoHasAttributes	Overridden. Actual implementation of HasAttributes.
	DoHasCreationDateTime	Overridden. Actual implementation of HasCreationDateTime.
	DoHasLastAccessDateTime	Overridden. Actual implementation of HasLastAccessDateTime.
	DoHasLastWriteDateTime	Overridden. Actual implementation of HasLastWriteDateTime.
	DoIsRoot	Overridden. Actual implementation of Xceed.FileSystem.AbstractFolder.IsRoot.
	DoLastAccessDateTime	Overridden. Actual implementation of LastAccessDateTime.
	DoLastWriteDateTime	Overridden. Actual implementation of LastWriteDateTime.
	DoName	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.Name.
	DoParentFolder	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.ParentFolder.
	DoRootFolder	Overridden. Actual implementation of RootFolder.
	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)
	CopyFilesTo	Overloaded. Copies the folder's content to another folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	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)
	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	Overridden. Gets a boolean value indicating if the source and target items represent the same physical entity.
	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	Overridden. This method is reserved for internal use and is not intended to be used directly from your code.
	DoApplyPropertiesTo	Overridden. This method is reserved for internal use and is not intended to be used directly from your code.
	DoCopyTo	Copies the folder to another folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	DoCreate	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.Create.
	DoDelete	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.Delete.
	DoGetChildItems	Overridden. Actual implementation of Xceed.FileSystem.AbstractFolder.GetItems for immediate children only.
	DoGetFile	Overridden. Actual implementation of Xceed.FileSystem.AbstractFolder.GetFile for a file without any path.
	DoGetFiles	Retrieves an array of Xceed.FileSystem.AbstractFile objects. (Inherited from Xceed.FileSystem.AbstractFolder)
	DoGetFolder	Overridden. Actual implementation of Xceed.FileSystem.AbstractFolder.GetFolder.
	DoGetFolders	Overridden. Actual implementation of Xceed.FileSystem.AbstractFolder.GetFolders.
	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	Overridden. Actual implementation of Refresh.
	DoSetMetadata	(Inherited from Xceed.FileSystem.FileSystemItem)
	EnsureDateIsValid	Ensures that the System.DateTime value is valid. (Inherited from Xceed.FileSystem.FileSystemItem)
	IsPathRooted	Overridden. This method is reserved for internal use and is not intended to be used directly from your code.
	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

Extension Methods

	Name	Description
	Should	Overloaded. A FileSystemItem extension method that implements the FluentAssertions Should() concept for the given instance.

Top

Supported Frameworks

.NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

.NET Standard: netstandard2.0, netstandard2.1

.NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

Reference

GZippedFolder Members
Xceed.GZip Namespace
AbstractFolder Class

Send Feedback

Business Suite

Ultimate Suite

Reference