FtpFile Class

In This Topic

Specialization of the Xceed.FileSystem.AbstractFile class that implements access to a file located on an FTP server.

Syntax

Visual Basic
C#

'Declaration
 
Public Class FtpFile 
   Inherits Xceed.FileSystem.AbstractFile

'Usage
 
Dim instance As FtpFile

public class FtpFile : Xceed.FileSystem.AbstractFile

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      Xceed.FileSystem.FileSystemItem
         Xceed.FileSystem.AbstractFile
            Xceed.Ftp.FtpFile

Public Constructors

	Name	Description
	FtpFile Constructor	Initializes a new instance of the FtpFile class specifying the FtpConnection object that represents the connection with an FTP server as well as the fully qualified name of an underlying physical file.

Top

Public Properties

	Name	Description
	Attributes	Gets or sets the attributes of the item. (Inherited from Xceed.FileSystem.FileSystemItem)
	Connection	Gets the FtpConnection object that represents the connection with an FTP server
	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	Overridden. Gets a human-readable full pathname starting with "ftp://hostname" representing the fully qualified path of all host files containing the item and the path of the item itself.
	HostFile	Gets an Xceed.FileSystem.AbstractFile containing an archived version of this Xceed.FileSystem.FileSystemItem. (Inherited from Xceed.FileSystem.FileSystemItem)
	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)
	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 an FtpFile or an FtpFolder does not support the Xceed.FileSystem.IBatchUpdateable interface.
	DoAttributes	Overridden. Gets or sets the attributes of the item.
	DoCreationDateTime	Overridden. Gets or sets the creation date and time of the file.
	DoExists	Overridden. Gets a boolean value indicating if the file physically exists.
	DoFullName	Overridden. Gets the full name of the file.
	DoHasAttributes	Overridden. Gets a boolean value indicating if the file supports attributes.
	DoHasCreationDateTime	Overridden. Gets a boolean value indicating if the file supports having a creation date and time.
	DoHasLastAccessDateTime	Overridden. Gets a boolean value indicating if the file supports having a last access date and time.
	DoHasLastWriteDateTime	Gets a boolean value indicating if the item supports having a last write date and time. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoLastAccessDateTime	Overridden. Gets or sets the last access date and time of the file.
	DoLastWriteDateTime	Overridden. Gets or sets the modification date and time of the file.
	DoName	Overridden. Gets or sets the short name of the file.
	DoParentFolder	Overridden. Gets a reference to the parent folder of this file.
	DoRootFolder	Overridden. Gets a reference to the root folder of this file.
	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)

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 Xceed.FileSystem.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)
	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)
	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 Xceed.FileSystem.AbstractFile object to the target Xceed.FileSystem.AbstractFile object. (Inherited from Xceed.FileSystem.AbstractFile)
	OpenRead	Overloaded. Opens the file for reading using the specified RepresentationType.
	OpenWrite	Overloaded. Opens the file for writing using the specified RepresentationType and indicating if existing data should be replaced.
	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.AbstractFile)
	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.FileSystem.FileSystemItem)
	DoApplyPropertiesTo	Copies the item's properties to another item. (Inherited from Xceed.FileSystem.FileSystemItem)
	DoCopyTo	Overridden.
	DoCreate	Overridden. Creates the physical file.
	DoCreateWrite	Overridden. Creates the file and opens it for writing.
	DoDelete	Overridden. Permanently deletes the physical item.
	DoGetMetadata	(Inherited from Xceed.FileSystem.FileSystemItem)
	DoMoveTo	(Inherited from Xceed.FileSystem.FileSystemItem)
	DoOpenRead	Overridden. Opens the file for reading.
	DoOpenWrite	Overridden. Opens the file for writing.
	DoRefresh	Overridden. Re-reads the information from the physical file.
	DoSetMetadata	(Inherited from Xceed.FileSystem.FileSystemItem)
	EnsureDateIsValid	Ensures that the System.DateTime value is valid. (Inherited from Xceed.FileSystem.FileSystemItem)
	GetAutomaticReadFileShare	Retrieves a value indicating the default FileShare value to be used when opening read streams for copy/move operations. (Inherited from Xceed.FileSystem.AbstractFile)
	GetAutomaticWriteFileShare	Retrieves a value indicating the default FileShare value to be used when opening write streams for copy/move operations. (Inherited from Xceed.FileSystem.AbstractFile)
	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 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)
	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

FtpFile Members
Xceed.Ftp Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference