SAPTeam.EasySign.UnifiedPath.Folder Class Reference

Represents a folder in the file system and provides methods to interact with it. More...

Inheritance diagram for SAPTeam.EasySign.UnifiedPath.Folder:

Public Member Functions
	Folder (OSPath fullPath)
	Initializes a new instance of the Folder class with the specified full path.
	Folder (OSPath fullPath, OSPath root)
	Initializes a new instance of the Folder class with the specified full path and root path.
Folder	AsRoot ()
	Returns a new Folder instance with the current folder as the root.
Folder	Up ()
	Returns a new Folder instance representing the parent directory.
Folder	Down (string folder)
	Returns a new Folder instance representing a subdirectory.
void	Create ()
	Creates the folder if it does not already exist.
FolderFile	File (OSPath path)
	Returns a FolderFile instance representing a file in the folder.
IEnumerable< Folder >	Folders ()
	Enumerates the subdirectories of the folder.
IEnumerable< FolderFile >	Files ()
	Enumerates the files in the folder.

Properties
bool	Exists [get]
	Gets a value indicating whether the folder exists.
Properties inherited from SAPTeam.EasySign.UnifiedPath.FolderEntry
OSPath	FullPath [get]
	Gets the full path of the folder entry.
OSPath	Path [get]
	Gets the relative path of the folder entry from the root.
OSPath	Root [get]
	Gets the root path of the folder entry.

Additional Inherited Members
Protected Member Functions inherited from SAPTeam.EasySign.UnifiedPath.FolderEntry
	FolderEntry (OSPath fullPath, OSPath root)
	Initializes a new instance of the FolderEntry class.

Detailed Description

Represents a folder in the file system and provides methods to interact with it.

Definition at line 6 of file Folder.cs.

Constructor & Destructor Documentation

Folder() [1/2]

SAPTeam.EasySign.UnifiedPath.Folder.Folder

(

OSPath

fullPath

)

Initializes a new instance of the Folder class with the specified full path.

Parameters

fullPath

The full path of the folder.

Definition at line 12 of file Folder.cs.

Folder() [2/2]

SAPTeam.EasySign.UnifiedPath.Folder.Folder	(	OSPath	fullPath,
		OSPath	root )

Initializes a new instance of the Folder class with the specified full path and root path.

Parameters

fullPath	The full path of the folder.
root	The root path of the folder.

Definition at line 22 of file Folder.cs.

Member Function Documentation

AsRoot()

Folder SAPTeam.EasySign.UnifiedPath.Folder.AsRoot

(

)

Returns a new Folder instance with the current folder as the root.

Returns

A new Folder instance.

Create()

void SAPTeam.EasySign.UnifiedPath.Folder.Create

(

)

Creates the folder if it does not already exist.

Down()

Folder SAPTeam.EasySign.UnifiedPath.Folder.Down

(

string

folder

)

Returns a new Folder instance representing a subdirectory.

Parameters

folder

The name of the subdirectory.

Returns

A new Folder instance.

File()

FolderFile SAPTeam.EasySign.UnifiedPath.Folder.File

(

OSPath

path

)

Returns a FolderFile instance representing a file in the folder.

Parameters

path	The relative path of the file.

Returns

A FolderFile instance.

Files()

IEnumerable< FolderFile > SAPTeam.EasySign.UnifiedPath.Folder.Files

(

)

Enumerates the files in the folder.

Returns

An enumerable collection of FolderFile instances representing the files.

Folders()

IEnumerable< Folder > SAPTeam.EasySign.UnifiedPath.Folder.Folders

(

)

Enumerates the subdirectories of the folder.

Returns

An enumerable collection of Folder instances representing the subdirectories.

Up()

Folder SAPTeam.EasySign.UnifiedPath.Folder.Up

(

)

Returns a new Folder instance representing the parent directory.

Returns

A new Folder instance.

Property Documentation

Exists

bool SAPTeam.EasySign.UnifiedPath.Folder.Exists

get

Gets a value indicating whether the folder exists.

Definition at line 51 of file Folder.cs.

---

The documentation for this class was generated from the following file:

• Folder.cs