Craig's Utility Library  4.0 Beta
Utilities.IO.DirectoryInfo Class Reference

Directory info class More...

Inheritance diagram for Utilities.IO.DirectoryInfo:
Utilities.IO.FileSystem.Interfaces.IDirectory

Public Member Functions

 DirectoryInfo (string Path, string UserName="", string Password="", string Domain="")
 Constructor More...
 
 DirectoryInfo (IDirectory Directory)
 Constructor More...
 
object Clone ()
 Clones the directory object More...
 
int CompareTo (IDirectory other)
 Compares this to another directory More...
 
int CompareTo (object obj)
 Compares this object to another object More...
 
IDirectory CopyTo (IDirectory Directory, Enums.CopyOptions Options=CopyOptions.CopyAlways)
 Copies the directory to the specified parent directory More...
 
void Create ()
 Creates the directory if it does not currently exist More...
 
void Delete ()
 Deletes the directory More...
 
IEnumerable< IDirectoryEnumerateDirectories (string SearchPattern="*", SearchOption Options=SearchOption.TopDirectoryOnly)
 Enumerates sub directories (defaults to top level sub directories) More...
 
IEnumerable< IDirectoryEnumerateDirectories (Predicate< IDirectory > Predicate, SearchOption Options=SearchOption.TopDirectoryOnly)
 Enumerates sub directories (defaults to top level sub directories) More...
 
IEnumerable< IFileEnumerateFiles (string SearchPattern="*", SearchOption Options=SearchOption.TopDirectoryOnly)
 Enumerates files within the directory (defaults to top level directory and not the sub directories) More...
 
IEnumerable< IFileEnumerateFiles (Predicate< IFile > Predicate, SearchOption Options=SearchOption.TopDirectoryOnly)
 Enumerates files within the directory (defaults to top level directory and not the sub directories) More...
 
override bool Equals (object obj)
 Determines if the two directories are the same More...
 
bool Equals (IDirectory other)
 Determines if the directories are equal More...
 
IEnumerator< IFileGetEnumerator ()
 Enumerates the files in the directory More...
 
override int GetHashCode ()
 Returns the hash code for the directory More...
 
IDirectory MoveTo (IDirectory Directory)
 Moves the directory to the specified parent directory More...
 
void Rename (string Name)
 Renames the directory More...
 
override string ToString ()
 Gets info for the directory More...
 
- Public Member Functions inherited from Utilities.IO.FileSystem.Interfaces.IDirectory
IDirectory CopyTo (IDirectory Directory, CopyOptions Options=CopyOptions.CopyAlways)
 Copies the directory to the specified parent directory More...
 

Static Public Member Functions

static bool operator!= (DirectoryInfo Directory1, DirectoryInfo Directory2)
 Determines if two directories are not equal More...
 
static bool operator< (DirectoryInfo Directory1, DirectoryInfo Directory2)
 Less than More...
 
static bool operator<= (DirectoryInfo Directory1, DirectoryInfo Directory2)
 Less than or equal More...
 
static bool operator== (DirectoryInfo Directory1, DirectoryInfo Directory2)
 Determines if two directories are equal More...
 
static bool operator> (DirectoryInfo Directory1, DirectoryInfo Directory2)
 Greater than More...
 
static bool operator>= (DirectoryInfo Directory1, DirectoryInfo Directory2)
 Greater than or equal More...
 

Properties

DateTime Accessed [get]
 Last time it was accessed More...
 
DateTime Created [get]
 When it was created More...
 
bool Exists [get]
 Does the directory exist More...
 
string FullName [get]
 Full path to the directory More...
 
DateTime Modified [get]
 When it was last modified More...
 
string Name [get]
 Name of the directory More...
 
IDirectory Parent [get]
 Parent directory More...
 
IDirectory Root [get]
 Root directory More...
 
long Size [get]
 Size of the contents of the directory in bytes More...
 
IDirectory InternalDirectory [get]
 Internal directory object More...
 
- Properties inherited from Utilities.IO.FileSystem.Interfaces.IDirectory
DateTime Accessed [get]
 Last time it was accessed More...
 
DateTime Created [get]
 When it was created More...
 
bool Exists [get]
 Does the directory exist More...
 
string FullName [get]
 Full path to the directory More...
 
DateTime Modified [get]
 When it was last modified More...
 
string Name [get]
 Name of the directory More...
 
IDirectory Parent [get]
 Parent directory More...
 
IDirectory Root [get]
 Root directory More...
 
long Size [get]
 Size of the contents of the directory in bytes More...
 

Detailed Description

Directory info class

Definition at line 35 of file DirectoryInfo.cs.

Constructor & Destructor Documentation

Utilities.IO.DirectoryInfo.DirectoryInfo ( string  Path,
string  UserName = "",
string  Password = "",
string  Domain = "" 
)

Constructor

Parameters
PathPath to the directory
DomainDomain of the user (optional)
PasswordPassword to be used to access the directory (optional)
UserNameUser name to be used to access the directory (optional)

Definition at line 44 of file DirectoryInfo.cs.

Utilities.IO.DirectoryInfo.DirectoryInfo ( IDirectory  Directory)

Constructor

Parameters
DirectoryDirectory object

Definition at line 53 of file DirectoryInfo.cs.

Member Function Documentation

object Utilities.IO.DirectoryInfo.Clone ( )

Clones the directory object

Returns
The cloned object

Definition at line 190 of file DirectoryInfo.cs.

int Utilities.IO.DirectoryInfo.CompareTo ( IDirectory  other)

Compares this to another directory

Parameters
otherDirectory to compare to
Returns

Definition at line 201 of file DirectoryInfo.cs.

int Utilities.IO.DirectoryInfo.CompareTo ( object  obj)

Compares this object to another object

Parameters
objObject to compare it to
Returns

Definition at line 215 of file DirectoryInfo.cs.

IDirectory Utilities.IO.DirectoryInfo.CopyTo ( IDirectory  Directory,
Enums.CopyOptions  Options = CopyOptions.CopyAlways 
)

Copies the directory to the specified parent directory

Parameters
DirectoryDirectory to copy to
OptionsCopy options
Returns
Returns the new directory

Definition at line 229 of file DirectoryInfo.cs.

void Utilities.IO.DirectoryInfo.Create ( )

Creates the directory if it does not currently exist

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 239 of file DirectoryInfo.cs.

void Utilities.IO.DirectoryInfo.Delete ( )

Deletes the directory

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 249 of file DirectoryInfo.cs.

IEnumerable<IDirectory> Utilities.IO.DirectoryInfo.EnumerateDirectories ( string  SearchPattern = "*",
SearchOption  Options = SearchOption.TopDirectoryOnly 
)

Enumerates sub directories (defaults to top level sub directories)

Parameters
SearchPatternSearch pattern to use
OptionsSearch options to use
Returns
The list of directories

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 262 of file DirectoryInfo.cs.

IEnumerable<IDirectory> Utilities.IO.DirectoryInfo.EnumerateDirectories ( Predicate< IDirectory Predicate,
SearchOption  Options = SearchOption.TopDirectoryOnly 
)

Enumerates sub directories (defaults to top level sub directories)

Parameters
PredicatePredicate used to filter directories
OptionsSearch options to use
Returns
The list of directories

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 279 of file DirectoryInfo.cs.

IEnumerable<IFile> Utilities.IO.DirectoryInfo.EnumerateFiles ( string  SearchPattern = "*",
SearchOption  Options = SearchOption.TopDirectoryOnly 
)

Enumerates files within the directory (defaults to top level directory and not the sub directories)

Parameters
SearchPatternSearch pattern to use
OptionsSearch options to use
Returns
The list of files

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 294 of file DirectoryInfo.cs.

IEnumerable<IFile> Utilities.IO.DirectoryInfo.EnumerateFiles ( Predicate< IFile Predicate,
SearchOption  Options = SearchOption.TopDirectoryOnly 
)

Enumerates files within the directory (defaults to top level directory and not the sub directories)

Parameters
PredicatePredicate used to filter files
OptionsSearch options to use
Returns
The list of files

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 311 of file DirectoryInfo.cs.

override bool Utilities.IO.DirectoryInfo.Equals ( object  obj)

Determines if the two directories are the same

Parameters
objObject to compare to
Returns
True if they're the same, false otherwise

Definition at line 325 of file DirectoryInfo.cs.

bool Utilities.IO.DirectoryInfo.Equals ( IDirectory  other)

Determines if the directories are equal

Parameters
otherOther directory
Returns
True if they are equal, false otherwise

Definition at line 336 of file DirectoryInfo.cs.

IEnumerator<IFile> Utilities.IO.DirectoryInfo.GetEnumerator ( )

Enumerates the files in the directory

Returns
The files in the directory

Definition at line 347 of file DirectoryInfo.cs.

override int Utilities.IO.DirectoryInfo.GetHashCode ( )

Returns the hash code for the directory

Returns
The hash code for the directory

Definition at line 357 of file DirectoryInfo.cs.

IDirectory Utilities.IO.DirectoryInfo.MoveTo ( IDirectory  Directory)

Moves the directory to the specified parent directory

Parameters
DirectoryDirectory to move to

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 366 of file DirectoryInfo.cs.

static bool Utilities.IO.DirectoryInfo.operator!= ( DirectoryInfo  Directory1,
DirectoryInfo  Directory2 
)
static

Determines if two directories are not equal

Parameters
Directory1Directory 1
Directory2Directory 2
Returns
True if they are not equal, false otherwise

Definition at line 114 of file DirectoryInfo.cs.

static bool Utilities.IO.DirectoryInfo.operator< ( DirectoryInfo  Directory1,
DirectoryInfo  Directory2 
)
static

Less than

Parameters
Directory1Directory 1
Directory2Directory 2
Returns
The result

Definition at line 125 of file DirectoryInfo.cs.

static bool Utilities.IO.DirectoryInfo.operator<= ( DirectoryInfo  Directory1,
DirectoryInfo  Directory2 
)
static

Less than or equal

Parameters
Directory1Directory 1
Directory2Directory 2
Returns
The result

Definition at line 138 of file DirectoryInfo.cs.

static bool Utilities.IO.DirectoryInfo.operator== ( DirectoryInfo  Directory1,
DirectoryInfo  Directory2 
)
static

Determines if two directories are equal

Parameters
Directory1Directory 1
Directory2Directory 2
Returns
True if they are, false otherwise

Definition at line 151 of file DirectoryInfo.cs.

static bool Utilities.IO.DirectoryInfo.operator> ( DirectoryInfo  Directory1,
DirectoryInfo  Directory2 
)
static

Greater than

Parameters
Directory1Directory 1
Directory2Directory 2
Returns
The result

Definition at line 166 of file DirectoryInfo.cs.

static bool Utilities.IO.DirectoryInfo.operator>= ( DirectoryInfo  Directory1,
DirectoryInfo  Directory2 
)
static

Greater than or equal

Parameters
Directory1Directory 1
Directory2Directory 2
Returns
The result

Definition at line 179 of file DirectoryInfo.cs.

void Utilities.IO.DirectoryInfo.Rename ( string  Name)

Renames the directory

Parameters
NameThe new name of the directory

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 377 of file DirectoryInfo.cs.

override string Utilities.IO.DirectoryInfo.ToString ( )

Gets info for the directory

Returns
The full path to the directory

Definition at line 398 of file DirectoryInfo.cs.

Property Documentation

DateTime Utilities.IO.DirectoryInfo.Accessed
get

Last time it was accessed

Definition at line 61 of file DirectoryInfo.cs.

DateTime Utilities.IO.DirectoryInfo.Created
get

When it was created

Definition at line 66 of file DirectoryInfo.cs.

bool Utilities.IO.DirectoryInfo.Exists
get

Does the directory exist

Definition at line 71 of file DirectoryInfo.cs.

string Utilities.IO.DirectoryInfo.FullName
get

Full path to the directory

Definition at line 76 of file DirectoryInfo.cs.

IDirectory Utilities.IO.DirectoryInfo.InternalDirectory
getprotected

Internal directory object

Definition at line 106 of file DirectoryInfo.cs.

DateTime Utilities.IO.DirectoryInfo.Modified
get

When it was last modified

Definition at line 81 of file DirectoryInfo.cs.

string Utilities.IO.DirectoryInfo.Name
get

Name of the directory

Definition at line 86 of file DirectoryInfo.cs.

IDirectory Utilities.IO.DirectoryInfo.Parent
get

Parent directory

Definition at line 91 of file DirectoryInfo.cs.

IDirectory Utilities.IO.DirectoryInfo.Root
get

Root directory

Definition at line 96 of file DirectoryInfo.cs.

long Utilities.IO.DirectoryInfo.Size
get

Size of the contents of the directory in bytes

Definition at line 101 of file DirectoryInfo.cs.


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