Class FileSystemKnownFolder

Namespace

Microsoft.WindowsAPICodePack.Shell

Assembly

Microsoft.WindowsAPICodePack.Shell.dll

Represents a registered file system Known Folder

public class FileSystemKnownFolder : ShellFileSystemFolder, IEquatable<ShellObject>, IKnownFolder, IDisposable, IEnumerable<ShellObject>, IEnumerable

Inheritance

object

ShellObject

ShellContainer

ShellFolder

ShellFileSystemFolder

FileSystemKnownFolder

Implements

IEquatable<ShellObject>

IKnownFolder

IDisposable

IEnumerable<ShellObject>

IEnumerable

Inherited Members

ShellFileSystemFolder.FromFolderPath(string)

ShellContainer.GetEnumerator()

ShellObject.FromParsingName(string)

ShellObject.Dispose()

ShellObject.Equals(ShellObject)

ShellObject.Equals(object)

ShellObject.GetDisplayName(DisplayNameType)

ShellObject.GetHashCode()

ShellObject.ToString()

ShellObject.Update(IBindCtx)

ShellObject.IsPlatformSupported

ShellObject.IsFileSystemObject

ShellObject.IsLink

ShellObject.Name

ShellObject.Parent

ShellObject.Properties

ShellObject.Thumbnail

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Properties

CanonicalName

Gets this known folder's canonical name.

public string CanonicalName { get; }

Property Value

string

A string object.

Category

Gets the category designation for this known folder.

public FolderCategory Category { get; }

Property Value

FolderCategory

A FolderCategory value.

DefinitionOptions

Gets an value that describes this known folder's behaviors.

public DefinitionOptions DefinitionOptions { get; }

Property Value

DefinitionOptions

A DefinitionOptions value.

Description

Gets this known folder's description.

public string Description { get; }

Property Value

string

A string object.

FileAttributes

Gets this known folder's file attributes, such as "read-only".

public FileAttributes FileAttributes { get; }

Property Value

FileAttributes

A FileAttributes value.

FolderId

Gets the unique identifier for this known folder.

public Guid FolderId { get; }

Property Value

Guid

A Guid value.

FolderType

Gets a string representation of this known folder's type.

public string FolderType { get; }

Property Value

string

A string object.

FolderTypeId

Gets the unique identifier for this known folder's type.

public Guid FolderTypeId { get; }

Property Value

Guid

A Guid value.

LocalizedName

Gets this known folder's localized name.

public string LocalizedName { get; }

Property Value

string

A string object.

LocalizedNameResourceId

Gets the resource identifier for this known folder's localized name.

public string LocalizedNameResourceId { get; }

Property Value

string

A string object.

ParentId

Gets the unique identifier for this known folder's parent folder.

public Guid ParentId { get; }

Property Value

Guid

A Guid value.

ParsingName

Gets this known folder's parsing name.

public override string ParsingName { get; }

Property Value

string

A string object.

Path

Gets the path for this known folder.

public override string Path { get; }

Property Value

string

A string object.

PathExists

Gets a value that indicates whether this known folder's path exists on the computer.

public bool PathExists { get; }

Property Value

bool

A bool bool value.

Remarks

If this property value is false, the folder might be a virtual folder ( Category property will be Virtual for virtual folders)

Redirection

Gets a value that states whether this known folder can have its path set to a new value, including any restrictions on the redirection.

public RedirectionCapability Redirection { get; }

Property Value

RedirectionCapability

A RedirectionCapability value.

RelativePath

Gets this known folder's relative path.

public string RelativePath { get; }

Property Value

string

A string object.

Security

Gets this known folder's security attributes.

public string Security { get; }

Property Value

string

A string object.

Tooltip

Gets this known folder's tool tip text.

public string Tooltip { get; }

Property Value

string

A string object.

TooltipResourceId

Gets the resource identifier for this known folder's tool tip text.

public string TooltipResourceId { get; }

Property Value

string

A string object.

Methods

Dispose(bool)

Release resources

protected override void Dispose(bool disposing)

Parameters

disposing bool

Indicates that this mothod is being called from Dispose() rather than the finalizer.