FilePath Class

Summary

Represents a file path.
Assembly
Wyam.Common.dll
Namespace
Wyam.Common.IO
Interfaces
  • IComparable
  • IEquatable<>
Base Types
graph TD Base0["NormalizedPath"]-->Type click Base0 "/api/Wyam.Common.IO/NormalizedPath" Base1["IComparable<>"]-->Base0 Interface0["IComparable"]-.->Type Interface1["IEquatable<>"]-.->Type Type["FilePath"] class Type type-node

Syntax

public sealed class FilePath : NormalizedPath, IComparable, IEquatable<NormalizedPath>

Constructors

Name Summary
FilePath(string) Initializes a new instance of the Wyam.Common.IO.FilePath class. The path will be considered absolute if the underlying OS file system considers it absolute.
FilePath(string, PathKind) Initializes a new instance of the Wyam.Common.IO.FilePath class..
FilePath(string, string) Initializes a new instance of the Wyam.Common.IO.FilePath class with the specified file provider. The path will be considered absolute if the underlying OS file system considers it absolute.
FilePath(string, string, PathKind) Initializes a new instance of the Wyam.Common.IO.FilePath class with the specified file provider.
FilePath(Uri) Initializes a new instance of the Wyam.Common.IO.FilePath class with the specified file provider and/or path.
FilePath(Uri, string) Initializes a new instance of the Wyam.Common.IO.FilePath class with the specified file provider. The path will be considered absolute if the underlying OS file system considers it absolute.
FilePath(Uri, string, PathKind) Initializes a new instance of the Wyam.Common.IO.FilePath class with the specified file provider.

Fields

Name Constant Value Summary
DefaultFileProvider
The default file provider.
Inherited from NormalizedPath
static

Properties

Name Value Summary
Directory DirectoryPath
Gets the directory part of the path.
Extension string
Gets the file extension (including the preceding ".").
FileName FilePath
Gets the filename.
FileNameWithoutExtension FilePath
Gets the filename without it's extension.
FileProvider Uri
Gets the file provider for this path. If this is a relative path, the file provider will always be null. If this is an absolute path and the file provider is null it indicates the path is not intended for use with an actual file provider.
Inherited from NormalizedPath
FullPath string
Gets the full path.
Inherited from NormalizedPath
HasExtension bool
Gets a value indicating whether this path has a file extension.
IsAbsolute bool
Gets or sets a value indicating whether this path is absolute.
Inherited from NormalizedPath
IsRelative bool
Gets a value indicating whether this path is relative.
Inherited from NormalizedPath
Root DirectoryPath
Gets the root of this path or "." if this is a relative path or there is no root.
Inherited from NormalizedPath
RootRelative FilePath
Gets the file path relative to it's root path.
Segments string[]
Gets the segments making up the path.
Inherited from NormalizedPath

Methods

Name Value Summary
AppendExtension(string) FilePath
Appends a file extension to the path.
ChangeExtension(string) FilePath
Changes the file extension of the path.
Collapse() FilePath
Collapses a Wyam.Common.IO.FilePath containing ellipses.
CompareTo(NormalizedPath) int
Inherited from NormalizedPath
CompareTo(object) int
Inherited from NormalizedPath
Equals(object) bool
Inherited from NormalizedPath
FromString(string) FilePath
Performs a conversion from System.String to Wyam.Common.IO.FilePath.
static
FromUri(Uri) FilePath
Performs a conversion from Uri to Wyam.Common.IO.FilePath.
static
GetHashCode() int
Inherited from NormalizedPath
ToString() string
Returns a System.String that represents this path.
Inherited from NormalizedPath

Operators

Name Value Summary
implicit operator FilePath(string) FilePath
implicit operator FilePath(Uri) FilePath
GitHub