TarredFolder Class

In This Topic

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

Syntax

Visual Basic
C#

'Declaration
 
Public Class TarredFolder 
   Inherits Xceed.FileSystem.AbstractFolder

'Usage
 
Dim instance As TarredFolder

public class TarredFolder : Xceed.FileSystem.AbstractFolder

Remarks

This implementation of Tar is fully read/write compatible with the USTAR format. It is read compatible with GNU Tar archives whose entries do not use the header extensions of this format.

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      Xceed.FileSystem.FileSystemItem
         Xceed.FileSystem.AbstractFolder
            Xceed.Tar.TarredFolder
               Xceed.Tar.TarArchive

Public Constructors

	Name	Description
	TarredFolder Constructor	Overloaded.

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)
	GroupID	Gets or sets the group ID.
	GroupName	Gets or sets the group name.
	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)
	HeaderType	Gets the type of header.
	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 TAR archive file containing this folder entry.
	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)
	Permissions	Gets or sets the permissions of the item.
	RootFolder	Gets a reference to the root folder of this item. (Inherited from Xceed.FileSystem.FileSystemItem)
	UserID	Gets or sets the user ID.
	UserName	Gets or sets the user name.

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 Xceed.FileSystem.FileSystemItem.DoAttributes.
	DoCreationDateTime	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoCreationDateTime.
	DoExists	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoExists.
	DoFullName	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoFullName.
	DoHasAttributes	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoHasAttributes.
	DoHasCreationDateTime	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoHasCreationDateTime.
	DoHasLastAccessDateTime	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoHasLastAccessDateTime.
	DoHasLastWriteDateTime	Gets a boolean value indicating if the item supports having a last write date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoIsRoot	Gets a boolean value indicating if the folder is a root folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	DoLastAccessDateTime	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoLastAccessDateTime.
	DoLastWriteDateTime	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoLastWriteDateTime.
	DoName	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.Name.
	DoParentFolder	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoParentFolder.
	DoRootFolder	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoRootFolder.
	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)
	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)
	DoCopyTo	Copies the folder to another folder. (Inherited from Xceed.FileSystem.AbstractFolder)
	DoCreate	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoCreate.
	DoDelete	Overridden. Actual implementation of Xceed.FileSystem.FileSystemItem.DoDelete.
	DoGetChildItems	Overridden. Actual implementation of Xceed.FileSystem.AbstractFolder.DoGetChildItems 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	Retrieves an array of Xceed.FileSystem.AbstractFolder objects. (Inherited from Xceed.FileSystem.AbstractFolder)
	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 Xceed.FileSystem.FileSystemItem.DoRefresh.
	DoSetMetadata	(Inherited from Xceed.FileSystem.FileSystemItem)
	EnsureDateIsValid	Ensures that the System.DateTime value is valid. (Inherited from Xceed.FileSystem.FileSystemItem)
	IsPublicException	(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

TarredFolder Members
Xceed.Tar Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference