Export (0) Print
Expand All

VirtualDirectory Class

Represents a directory object in a virtual file or resource space.

Namespace:  System.Web.Hosting
Assembly:  System.Web (in System.Web.dll)

[<AbstractClass>]
type VirtualDirectory =  
    class 
        inherit VirtualFileBase 
    end

The VirtualDirectory type exposes the following members.

  NameDescription
Protected methodVirtualDirectoryInitializes a new instance of the VirtualDirectory class.
Top

  NameDescription
Public propertyChildrenGets a list of the files and subdirectories contained in this virtual directory.
Public propertyDirectoriesGets a list of all the subdirectories contained in this directory.
Public propertyFilesGets a list of all files contained in this directory.
Public propertyIsDirectoryGets a value that indicates that this is a virtual resource that should be treated as a directory. (Overrides VirtualFileBase.IsDirectory.)
Public propertyNameGets the display name of the virtual resource. (Inherited from VirtualFileBase.)
Public propertyVirtualPathGets the virtual file path. (Inherited from VirtualFileBase.)
Top

  NameDescription
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceGives a VirtualFileBase instance an infinite lifetime by preventing a lease from being created. (Inherited from VirtualFileBase.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The VirtualDirectory class is the base class for objects that represent directories in a virtual file system. Typically, you would implement a descendent of the VirtualDirectory class for each VirtualPathProvider class descendent in your Web application.

Notes to Inheritors

When you inherit from the VirtualDirectory class, you must override the Children, Directories, and Files properties to return an object implementing the IEnumerable interface.

If your virtual-directory structure contains moderate to large numbers of virtual resources, you should take care to minimize the system resources consumed when enumerating the virtual directory by calling the Children, Directories, or Files properties.

The following code example is a VirtualDirectory class implementation that returns virtual directory information stored in a DataSet object. This code works with the code examples for the VirtualPathProvider and VirtualFile classes to provide virtual resources from a data store that is loaded into a DataSet object. For the complete instructions for compiling and running the example, see the Example section of the VirtualPathProvider class overview.

This example has two parts, the VirtualDirectory class implementation and the XML data file used to populate the DataSet object.

The first code example is an implementation of the VirtualDirectory class. In the constructor it uses a method on a custom VirtualPathProvider object to return a DataSet object. It then searches the DataSet object to retrieve the directory information associated with the virtual path provided.

No code example is currently available or this language may not be supported.

The second example is the XML data file used to populate the DataSet object returned by the custom VirtualPathProvider object. This XML data is used to demonstrate using the VirtualPathProvider, VirtualFile, and VirtualDirectory classes to retrieve data from external data, and is not intended to represent a production-quality data store.

<?xml version="1.0" encoding="utf-8" ?>
  <resource type="dir" 
    path="/vrDir" 
    parentPath="" 
    content="">
    <resource type="file" 
      path="/vrDir/Level1FileA.vrf"
      parentPath="/vrDir" 
      content="This is the content of file Level1FileA." >
    </resource>
    <resource type="file" 
      path="/vrDir/Level1FileB.vrf"
      parentPath="/vrDir" 
      content="This is the content of file Level1FileB.">
    </resource>
    <resource type="dir" 
      path="/vrDir/Level2DirA" 
      parentPath="/vrDir" 
      content="">
        <resource type="file" 
          path="/vrDir/Level2DirA/Level2FileA.vrf" 
          parentPath="/vrDir/Level2DirA" 
          content="This is the content of file Level2FileA." >
        </resource>
        <resource type="file" 
          path="/vrDir/Level2DirA/Level2FileB.vrf"
          parentPath="/vrDir/Level2DirA" 
          content="This is the content of file Level2FileB.">
        </resource>
    </resource>
    <resource type="dir" 
      path="/vrDir/Level2DirB" 
      parentPath="/vrDir" 
      content="">
      <resource type="file" 
        path="/vrDir/Level2DirB/Level2FileA.vrf" 
        parentPath="/vrDir/Level2DirB" 
        content="This is the content of file Level2FileA." >
      </resource>
      <resource type="file" 
        path="/vrDir/Level2DirB/Level2FileB.vrf"
        parentPath="/vrDir/Level2DirB" 
        content="This is the content of file Level2FileB.">
       </resource>
    </resource>
  </resource>

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft