AbstractFolder Class

In This Topic

Represents a generic folder, and exposes properties and methods that allow folder-oriented operations to be performed.

Syntax

Visual Basic
C#

'Declaration
 
Public MustInherit Class AbstractFolder 
   Inherits FileSystemItem

'Usage
 
Dim instance As AbstractFolder

public abstract class AbstractFolder : FileSystemItem

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      Xceed.FileSystem.FileSystemItem
         Xceed.FileSystem.AbstractFolder
            Xceed.FileSystem.DiskFolder
            Xceed.FileSystem.IsolatedFolder
            Xceed.FileSystem.MemoryFolder
            Xceed.Ftp.FtpFolder
            Xceed.GZip.GZippedFolder
            Xceed.SSH.Client.SFtpFolder
            Xceed.Tar.TarredFolder
            Xceed.Zip.ZippedFolder

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	Gets an AbstractFile containing an archived version of this FileSystemItem. (Inherited from Xceed.FileSystem.FileSystemItem)
	IsRoot	Gets a value indicating if the folder is a root folder.
	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 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	Gets or sets the attributes of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoCreationDateTime	Gets or sets the creation date and time of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoExists	Gets a boolean value indicating if the item physically exists. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoFullName	Gets the full name of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoHasAttributes	Gets a boolean value indicating if the item supports attributes. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoHasCreationDateTime	Gets a boolean value indicating if the item supports having a creation date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoHasLastAccessDateTime	Gets a boolean value indicating if the item supports having a last access date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	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.
	DoLastAccessDateTime	Gets or sets the last access date and time of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoLastWriteDateTime	Gets or sets the modification date and time of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoName	Gets or sets the filename, without path, of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoParentFolder	Gets a reference to the parent folder of this item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoRootFolder	Gets a reference to the root folder of this item. (Inherited from Xceed.FileSystem.FileSystemItem)
	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.
	CopyItemsTo	Overloaded. Copies the folder's items (files and empty folders) to another folder.
	CopyTo	Overloaded. Copies the item to another folder. (Inherited from Xceed.FileSystem.FileSystemItem)
	Create	Overloaded. Creates the physical item represented by this FileSystemItem object. (Inherited from Xceed.FileSystem.FileSystemItem)
	CreateFile	Overloaded. Creates a new file in the folder.
	CreateFolder	Overloaded. Creates a new folder in the folder.
	CreateObjRef	(Inherited from System.MarshalByRefObject)
	CreateTempFile	Creates the temporary file.
	Delete	Overloaded. Permanently deletes the physical item. (Inherited from Xceed.FileSystem.FileSystemItem)
	GetFile	Overloaded. Returns an AbstractFile object that represents a file contained in the folder.
	GetFiles	Overloaded. Returns a filtered list of files contained in the folder.
	GetFolder	Overloaded. Returns an AbstractFolder object that represents a folder contained in the folder.
	GetFolders	Overloaded. Returns a filtered list of folders contained in the folder.
	GetItems	Overloaded. Returns a list of items contained in the folder.
	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.FileSystem.FileSystemItem)
	MoveFilesTo	Overloaded. Moves the folder's content to another folder.
	MoveItemsTo	Overloaded. Moves the folder's items (files and empty folders) to another folder.
	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	Overridden. Builds a list of FileSystemItem objects to process.
	BuildListForCreate	Handles the special cases in regards to building the list of items to process when creating a 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.FileSystem.FileSystemItem)
	DoApplyPropertiesTo	Copies the item's properties to another item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoCopyTo	Overridden. Copies the folder to another folder.
	DoCreate	Creates the physical item represented by the FileSystemItem object. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoDelete	Permanently deletes the physical item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoGetChildItems	Retrieves an array of FileSystemItem objects.
	DoGetFile	Retrieves a reference to an AbstractFile object.
	DoGetFiles	Retrieves an array of AbstractFile objects.
	DoGetFolder	Retrieves a reference to an AbstractFolder object.
	DoGetFolders	Retrieves an array of AbstractFolder objects.
	DoGetItems	Retrieves an array of FileSystemItem objects.
	DoGetMetadata	(Inherited from Xceed.FileSystem.FileSystemItem)
	DoMoveTo	(Inherited from Xceed.FileSystem.FileSystemItem)
	DoRefresh	Re-reads the information from the physical item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoSetMetadata	(Inherited from Xceed.FileSystem.FileSystemItem)
	EnsureDateIsValid	Ensures that the System.DateTime value is valid. (Inherited from Xceed.FileSystem.FileSystemItem)
	IsPathRooted	Returns a boolean value indicating if the path passed is rooted in the environment of the FileSystemItem object we are dealing with. (Inherited from Xceed.FileSystem.FileSystemItem)
	IsPublicException	(Inherited from Xceed.FileSystem.FileSystemItem)
	ListCopyTo	Copies each item in the FileSystemEventsSession object's list to each item's destination. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListCopyToCore	Copies the item pair's current FileSystemItem to its target FileSystemItem. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListCreate	Creates each item in the FileSystemEventsSession object's list. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListCreateCore	Creates the item pair's current FileSystemItem. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListDelete	Deletes each item in the FileSystemEventsSession object's list. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListDeleteCore	Deletes the item pair's current FileSystemItem. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListMoveTo	Moves each item in the FileSystemEventsSession object's list to each item's destination. (Inherited from Xceed.FileSystem.FileSystemItem)
	ListMoveToCore	Moves the item pair's current FileSystemItem to its target 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

AbstractFolder Members
Xceed.FileSystem Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference