Xceed .NET Libraries Documentation
Xceed.Zip Assembly / Xceed.Zip Namespace / ZippedFile Class / DoRootFolder Property


In This Topic
    DoRootFolder Property (ZippedFile)
    In This Topic
    Gets a reference to the root folder of this item.
    Syntax
    'Declaration
     
    Protected Overrides ReadOnly Property DoRootFolder As AbstractFolder
    'Usage
     
    Dim instance As ZippedFile
    Dim value As AbstractFolder
     
    value = instance.DoRootFolder
    protected override AbstractFolder DoRootFolder {get;}

    Property Value

    An Xceed.FileSystem.AbstractFolder object that represents the folder at the root of the path of this item. If the item is the root folder itself, a ZipArchive object will be returned.
    Remarks

    A root folder represents the starting point of a folder hierarchy. On a physical disk, it is usually represented by a drive letter ("C:\") or UNC root ("\\server\share\").

    Some specializations of the Xceed.FileSystem.AbstractFolder class may define a specialized class that represents a root folder, exposing properties and methods that apply only to a root.

    Therefore, the RootFolder property may return an Xceed.FileSystem.AbstractFolder instance that is in fact a specialized class representing the root.

    If the current item is the root of a folder hierarchy, the RootFolder property returns a reference to itself, or a reference to a specialized object that represents the root folder with more details.

    A ZippedFile will normally have at least root as its parent. If no parent is found, and exception will be thrown.

    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

    See Also