DiskFile Class

In This Topic

Specialization of the AbstractFile class that implements access to a disk file.

Syntax

Visual Basic
C#

'Declaration
 
Public Class DiskFile 
   Inherits AbstractFile

'Usage
 
Dim instance As DiskFile

public class DiskFile : AbstractFile

Remarks

The class is bound by the limitations of the .NET framework on the length of filenames, folder names and paths. These limits can be bypassed by enabling the class to call Windows directly to access the disk.

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      Xceed.FileSystem.FileSystemItem
         Xceed.FileSystem.AbstractFile
            Xceed.FileSystem.DiskFile
               Xceed.FileSystem.Windows.WindowsDiskFile

Public Constructors

	Name	Description
	DiskFile Constructor	Overloaded. Initializes a new instance of the DiskFile class.

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)
	CreationDateTimeUtc
	DefaultAutomaticReadDiskFileShare	Gets or sets a value indicating the default FileShare value to be used when opening read streams for copy/move operations.
	DefaultAutomaticWriteDiskFileShare	Gets or sets a value indicating the default FileShare value to be used when opening write streams for copy/move operations.
	DefaultIOHandler
	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)
	HasCreationDateTimeUtc
	HasLastAccessDateTime	Gets a boolean value indicating if the item supports having a last access date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	HasLastAccessDateTimeUtc
	HasLastWriteDateTime	Gets a boolean value indicating if the item supports having a last write date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	HasLastWriteDateTimeUtc
	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)
	LastAccessDateTime	Gets or sets the last access date and time of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	LastAccessDateTimeUtc
	LastWriteDateTime	Gets or sets the modification date and time of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	LastWriteDateTimeUtc
	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)
	ReparsePointTags
	RootFolder	Gets a reference to the root folder of this item. (Inherited from Xceed.FileSystem.FileSystemItem)
	Size	Gets the size of the file in bytes. (Inherited from Xceed.FileSystem.AbstractFile)

Top

Protected Properties

	Name	Description
	BatchUpdateable	Overridden. Returns null (Nothing in Visual Basic) since a DiskFile or a DiskFolder does not support the IBatchUpdateable interface.
	DoAttributes	Overridden. Gets or sets the attributes of the item.
	DoCreationDateTime	Overridden. Gets or sets the creation date and time of the item.
	DoCreationDateTimeUtc
	DoExists	Overridden. Gets a boolean value indicating if the item physically exists.
	DoFullName	Overridden. Gets the full name of the item.
	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)
	DoHasCreationDateTimeUtc
	DoHasLastAccessDateTime	Gets a boolean value indicating if the item supports having a last access date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoHasLastAccessDateTimeUtc
	DoHasLastWriteDateTime	Gets a boolean value indicating if the item supports having a last write date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoHasLastWriteDateTimeUtc
	DoLastAccessDateTime	Overridden. Gets or sets the last access date and time of the item.
	DoLastAccessDateTimeUtc
	DoLastWriteDateTime	Overridden. Gets or sets the modification date and time of the item.
	DoLastWriteDateTimeUtc
	DoName	Overridden. Gets or sets the filename, without path, of the item.
	DoParentFolder	Overridden. Gets a reference to the parent folder of this item.
	DoRootFolder	Overridden. Gets a reference to the root folder of this item.
	DoSize	Overridden. Gets the size of the file in bytes.
	InvalidChars	Gets the characters that are invalid in file and folder names. (Inherited from Xceed.FileSystem.FileSystemItem)
	IOHandler

Top

Public Methods

	Name	Description
	ApplyPropertiesTo	Overloaded. Copies the item's properties to another item. (Inherited from Xceed.FileSystem.FileSystemItem)
	CopyTo	Overloaded. Copies the file's data to another file. (Inherited from Xceed.FileSystem.AbstractFile)
	Create	Overloaded. Creates the physical item represented by this FileSystemItem object. (Inherited from Xceed.FileSystem.FileSystemItem)
	CreateObjRef	(Inherited from System.MarshalByRefObject)
	CreateWrite	Overloaded. Creates a file and opens it for writing. (Inherited from Xceed.FileSystem.AbstractFile)
	DefaultDiskItemPathExceptionHandler	Represents the method that will handle the disk item's PathException event.
	Delete	Overloaded. Permanently deletes the physical item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoCopyToComplete	(Inherited from Xceed.FileSystem.AbstractFile)
	DoCopyToLoop	(Inherited from Xceed.FileSystem.AbstractFile)
	DoCopyToSetup	(Inherited from Xceed.FileSystem.AbstractFile)
	GetLifetimeService	(Inherited from System.MarshalByRefObject)
	GetMetadata	(Inherited from Xceed.FileSystem.FileSystemItem)
	InitializeLifetimeService	(Inherited from System.MarshalByRefObject)
	IsReparseTagNameSurrogate
	IsSameAs	Overridden. Gets a boolean value indicating if the source and target items represent the same physical entity.
	MoveTo	Overloaded. Moves the contents of the AbstractFile object to the target AbstractFile object. (Inherited from Xceed.FileSystem.AbstractFile)
	OpenRead	Overloaded. Opens the file for reading. (Inherited from Xceed.FileSystem.AbstractFile)
	OpenWrite	Overloaded. Opens the file for writing. (Inherited from Xceed.FileSystem.AbstractFile)
	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 FileSystemItem objects to process. (Inherited from Xceed.FileSystem.AbstractFile)
	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)
	CreateFolderInstance	Overloaded.
	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	Copies the file into the destination. (Inherited from Xceed.FileSystem.AbstractFile)
	DoCreate	Overridden. Creates the physical file.
	DoCreateWrite	Overridden.
	DoDelete	Overridden. Permanently deletes the physical item.
	DoGetMetadata	Overridden.
	DoMoveTo	Overridden.
	DoOpenRead	Overridden. Opens the file for reading.
	DoOpenWrite	Overridden. Opens the file for writing.
	DoRefresh	Overridden. Re-reads the information from the physical item.
	DoSetMetadata	Overridden.
	EnsureDateIsValid	Ensures that the System.DateTime value is valid. (Inherited from Xceed.FileSystem.FileSystemItem)
	GetAutomaticReadFileShare	Overridden. Gets a value indicating the FileShare value to be used when opening read streams for copy/move operations.
	GetAutomaticWriteFileShare	Overridden. Gets a value indicating the FileShare value to be used when opening write streams for copy/move operations.
	GetStreamBufferSize	Returns the recommended buffer size for a stream copy operation. (Inherited from Xceed.FileSystem.AbstractFile)
	IsPathRooted	Overridden. Returns a boolean value indicating if the path passed is rooted.
	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)
	ValidateDoCopyToContext	(Inherited from Xceed.FileSystem.AbstractFile)
	ValidateDoCopyToContextAsDestination	(Inherited from Xceed.FileSystem.AbstractFile)

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

DiskFile Members
Xceed.FileSystem Namespace

FileSystem

Accessing files with long names and/or paths on Windows

Send Feedback

Business Suite

Ultimate Suite

Reference

FileSystem