Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / FileSystemItem Class


In This Topic
    FileSystemItem Class
    In This Topic
    Root class for all types of items that can exist in a generic (abstract) folder. For example, a file and a folder.
    Object Model
    FileSystemItem ClassIBatchUpdateable InterfaceFileSystemItem ClassFileSystemEventsSession ClassAbstractFolder ClassAbstractFolder ClassAbstractFile ClassFileSystemItem ClassFileSystemItem ClassFileSystemItem ClassAbstractFolder ClassAbstractFolder Class
    Syntax
    'Declaration
 

    Public MustInherit Class FileSystemItem 
   Inherits System.MarshalByRefObject
    'Usage
 

    Dim instance As FileSystemItem
    public abstract class FileSystemItem : System.MarshalByRefObject
    Inheritance Hierarchy

    System.Object
       System.MarshalByRefObject
          Xceed.FileSystem.FileSystemItem
             Xceed.FileSystem.AbstractFile
             Xceed.FileSystem.AbstractFolder

    Public Fields
     NameDescription
    Public Fieldstatic (Shared in Visual Basic)AltFolderSeparatorString equivalent of System.IO.Path.AltDirectorySeparatorChar.  
    Public Fieldstatic (Shared in Visual Basic)FolderSeparatorString equivalent of System.IO.Path.DirectorySeparatorChar.  
    Top
    Public Properties
     NameDescription
    Public PropertyAttributesGets or sets the attributes of the item.  
    Public PropertyCreationDateTimeGets or sets the creation date and time of the item.  
    Public PropertyExistsGets a boolean value indicating if the item physically exists.  
    Public PropertyFullNameGets the full name of the item.  
    Public PropertyHasAttributesGets a boolean value indicating if the item supports attributes.  
    Public PropertyHasCreationDateTimeGets a boolean value indicating if the item supports having a creation date and time.  
    Public PropertyHasLastAccessDateTimeGets a boolean value indicating if the item supports having a last access date and time.  
    Public PropertyHasLastWriteDateTimeGets a boolean value indicating if the item supports having a last write date and time.  
    Public PropertyHostedFullNameGets a human-readable full pathname representing the fully qualified path of all host files containing the item and the path of the item itself.  
    Public PropertyHostFileGets an AbstractFile containing an archived version of this FileSystemItem.  
    Public PropertyLastAccessDateTimeGets or sets the last access date and time of the item.  
    Public PropertyLastWriteDateTimeGets or sets the modification date and time of the item.  
    Public PropertyNameGets or sets the filename, without path, of the item.  
    Public PropertyParentFolderGets a reference to the parent folder of this item.  
    Public PropertyRootFolderGets a reference to the root folder of this item.  
    Top
    Protected Properties
     NameDescription
    Protected PropertyBatchUpdateableGets the IBatchUpdateable implementation for this item, or null (Nothing in Visual Basic) if this item does not support this interface.  
    Protected PropertyDoAttributesGets or sets the attributes of the item.  
    Protected PropertyDoCreationDateTimeGets or sets the creation date and time of the item.  
    Protected PropertyDoExistsGets a boolean value indicating if the item physically exists.  
    Protected PropertyDoFullNameGets the full name of the item.  
    Protected PropertyDoHasAttributesGets a boolean value indicating if the item supports attributes.  
    Protected PropertyDoHasCreationDateTimeGets a boolean value indicating if the item supports having a creation date and time.  
    Protected PropertyDoHasLastAccessDateTimeGets a boolean value indicating if the item supports having a last access date and time.  
    Protected PropertyDoHasLastWriteDateTimeGets a boolean value indicating if the item supports having a last write date and time.  
    Protected PropertyDoLastAccessDateTimeGets or sets the last access date and time of the item.  
    Protected PropertyDoLastWriteDateTimeGets or sets the modification date and time of the item.  
    Protected PropertyDoNameGets or sets the filename, without path, of the item.  
    Protected PropertyDoParentFolderGets a reference to the parent folder of this item.  
    Protected PropertyDoRootFolderGets a reference to the root folder of this item.  
    Protected PropertyInvalidCharsGets the characters that are invalid in file and folder names.  
    Top
    Public Methods
     NameDescription
    Public MethodApplyPropertiesToOverloaded. Copies the item's properties to another item.  
    Public MethodCopyToOverloaded. Copies the item to another folder.  
    Public MethodCreateOverloaded. Creates the physical item represented by this FileSystemItem object.  
    Public MethodCreateObjRef (Inherited from System.MarshalByRefObject)
    Public MethodDeleteOverloaded. Permanently deletes the physical item.  
    Public MethodGetLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodGetMetadata  
    Public MethodInitializeLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodIsSameAsGets a boolean value indicating if the source and target items represent the same physical entity.  
    Public MethodMoveToOverloaded. Moves the item to another folder.  
    Public MethodRefreshOverloaded. Re-reads the information from the physical item.  
    Public MethodSetName  
    Public MethodToStringReturns the full name of the item.  
    Top
    Protected Methods
     NameDescription
    Protected MethodApplyPropertiesToCore  
    Protected Internal MethodBuildListBuilds a list of FileSystemItem objects to process.  
    Protected MethodBuildListForCreateHandles the special cases in regards to building the list of items to process when creating a FileSystemItem object.  
    Protected MethodCreateFileMultiThreadItem  
    Protected MethodCreateFolderMultiThreadItem  
    Protected MethodCreateSessionOverloaded.   
    Protected MethodDoApplyPropertiesFromThis method is reserved for internal use and is not intended to be used directly from your code.  
    Protected MethodDoApplyPropertiesToCopies the item's properties to another item.  
    Protected MethodDoCopyToCopies the item to another folder.  
    Protected Internal MethodDoCreateCreates the physical item represented by the FileSystemItem object.  
    Protected Internal MethodDoDeletePermanently deletes the physical item.  
    Protected MethodDoGetMetadata  
    Protected MethodDoMoveTo  
    Protected MethodDoRefreshRe-reads the information from the physical item.  
    Protected MethodDoSetMetadata  
    Protected MethodEnsureDateIsValidEnsures that the System.DateTime value is valid.  
    Protected MethodIsPathRootedReturns a boolean value indicating if the path passed is rooted in the environment of the FileSystemItem object we are dealing with.  
    Protected MethodIsPublicException  
    Protected MethodListCopyToCopies each item in the FileSystemEventsSession object's list to each item's destination.  
    Protected MethodListCopyToCoreCopies the item pair's current FileSystemItem to its target FileSystemItem.  
    Protected MethodListCreateCreates each item in the FileSystemEventsSession object's list.  
    Protected MethodListCreateCoreCreates the item pair's current FileSystemItem.  
    Protected MethodListDeleteDeletes each item in the FileSystemEventsSession object's list.  
    Protected MethodListDeleteCoreDeletes the item pair's current FileSystemItem.  
    Protected MethodListMoveToMoves each item in the FileSystemEventsSession object's list to each item's destination.  
    Protected MethodListMoveToCoreMoves the item pair's current FileSystemItem to its target FileSystemItem.  
    Protected MethodMemberwiseCloneOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected MethodNeedsApplyPropertiesTo  
    Protected MethodOnCreatedCalled when a client explicitly calls Create.  
    Protected MethodOnSessionCreated  
    Protected MethodOnSessionCreatedDestination  
    Protected Methodstatic (Shared in Visual Basic)PrepareException  
    Top
    Extension Methods
     NameDescription
    Public Extension MethodShouldOverloaded.  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.

    See Also

    Reference

    FileSystemItem Members
    Xceed.FileSystem Namespace

    Send Feedback