Class GorgonFolderBrowser

A file folder browser.

Inheritance
object
MarshalByRefObject
Component
Control
ScrollableControl
ContainerControl
UserControl
GorgonFolderBrowser
Implements
Inherited Members
Namespace: Gorgon.UI
Assembly: Gorgon.Windows.dll
Syntax
public class GorgonFolderBrowser : UserControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl
Remarks

This control is meant as a drop in component to allow for easy selection of file folders on a drive. This can be considered a replacement for the built-in .NET folder browser dialog as the UI for this control is much easier to navigate around.

The control is patterned after the FileDialogBrowser control, but without needing to have a file name. It is also more customizable allowing users to supply their own icons for folders and drive types.

Constructors

| Edit this page View Source

GorgonFolderBrowser()

Initializes a new instance of the GorgonFolderBrowser class.

Declaration
public GorgonFolderBrowser()

Properties

| Edit this page View Source

BackColor

Property to set or return the background color.

Declaration
[Browsable(true)]
public Color BackColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

CaptionFont

Property to set or return the font to use for the caption.

Declaration
[Browsable(true)]
public Font CaptionFont { get; set; }
Property Value
Type Description
Font
| Edit this page View Source

CdRomImage

Property to set or return the image to use as the icon for a hard drive.

Declaration
[Browsable(true)]
public Image CdRomImage { get; set; }
Property Value
Type Description
Image
Remarks

If this value is null, the image used will be the default for the operating system.

| Edit this page View Source

CurrentDirectory

Property to return the current directory.

Declaration
[Browsable(false)]
public string CurrentDirectory { get; }
Property Value
Type Description
string
| Edit this page View Source

DirectoryImage

Property to set or return the image to use as the icon for a directory.

Declaration
[Browsable(true)]
public Image DirectoryImage { get; set; }
Property Value
Type Description
Image
Remarks

If this value is null, the image used will be the default for the operating system.

| Edit this page View Source

DirectoryListFont

Property to set or return the font to use for the directory list items.

Declaration
[Browsable(true)]
public Font DirectoryListFont { get; set; }
Property Value
Type Description
Font
| Edit this page View Source

DirectoryNameFont

Property to set or return the font to use for the directory name text box.

Declaration
[Browsable(true)]
public Font DirectoryNameFont { get; set; }
Property Value
Type Description
Font
| Edit this page View Source

DirectorySeparator

Property to set or return the character to use as the directory separator.

Declaration
[Browsable(false)]
public char DirectorySeparator { get; set; }
Property Value
Type Description
char
| Edit this page View Source

FileImage

Property to set or return the image to use as the icon for a directory.

Declaration
[Browsable(true)]
public Image FileImage { get; set; }
Property Value
Type Description
Image
Remarks

If this value is null, the image used will be the default for the operating system.

| Edit this page View Source

HardDriveImage

Property to set or return the image to use as the icon for a hard drive.

Declaration
[Browsable(true)]
public Image HardDriveImage { get; set; }
Property Value
Type Description
Image
Remarks

If this value is null, the image used will be the default for the operating system.

| Edit this page View Source

IsDesignTime

Property to return whether or not the control is in design mode.

Declaration
[Browsable(false)]
public bool IsDesignTime { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsErrorPaneOpen

Property to return whether or not the error pane is open on the control.

Declaration
[Browsable(false)]
public bool IsErrorPaneOpen { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsReadOnly

Property to set or return whether the browser is in read only mode.

Declaration
[Browsable(true)]
public bool IsReadOnly { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

NetworkDriveImage

Property to set or return the image to use as the icon for a hard drive.

Declaration
[Browsable(true)]
public Image NetworkDriveImage { get; set; }
Property Value
Type Description
Image
Remarks

If this value is null, the image used will be the default for the operating system.

| Edit this page View Source

RamDriveImage

Property to set or return the image to use as the icon for a hard drive.

Declaration
[Browsable(true)]
public Image RamDriveImage { get; set; }
Property Value
Type Description
Image
Remarks

If this value is null, the image used will be the default for the operating system.

| Edit this page View Source

RemovableDriveImage

Property to set or return the image to use as the icon for a hard drive.

Declaration
[Browsable(true)]
public Image RemovableDriveImage { get; set; }
Property Value
Type Description
Image
Remarks

If this value is null, the image used will be the default for the operating system.

| Edit this page View Source

RootFolder

Property to set or return the folder that should be used as the root of the file system.

Declaration
[Browsable(false)]
public DirectoryInfo RootFolder { get; set; }
Property Value
Type Description
DirectoryInfo
| Edit this page View Source

Text

Gets or sets the text associated with this control.

Declaration
[Browsable(true)]
[Bindable(false)]
public string Text { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

AssignInitialDirectory(DirectoryInfo)

Function to set the initial directory.

Declaration
public void AssignInitialDirectory(DirectoryInfo dir)
Parameters
Type Name Description
DirectoryInfo dir

The directory to assign.
| Edit this page View Source

Dispose(bool)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true if managed resources should be disposed; otherwise, false.
Overrides
| Edit this page View Source

OnLoad(EventArgs)

Raises the Load event.

Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type Name Description
EventArgs e

An EventArgs that contains the event data.
Overrides
| Edit this page View Source

SetErrorMessage(string)

Function to show an error message for the folder selector.

Declaration
public void SetErrorMessage(string message)
Parameters
Type Name Description
string message

The message to display.
Remarks

Passing null, or an empty string to the message parameter will reset and hide the message bar on the control.

Events

| Edit this page View Source

FolderAdding

Event triggered when a folder is about to be created on the file system.

Declaration
public event EventHandler<FolderAddArgs> FolderAdding
Event Type
Type Description
EventHandler<FolderAddArgs>
| Edit this page View Source

FolderDeleting

Event triggered when a folder is about to be deleted from the file system.

Declaration
public event EventHandler<FolderDeleteArgs> FolderDeleting
Event Type
Type Description
EventHandler<FolderDeleteArgs>
| Edit this page View Source

FolderEntered

Event triggered when a folder is entered.

Declaration
public event EventHandler<FolderSelectedArgs> FolderEntered
Event Type
Type Description
EventHandler<FolderSelectedArgs>
| Edit this page View Source

FolderRenaming

Event triggered when a folder is about to be renamed on the file system.

Declaration
public event EventHandler<FolderRenameArgs> FolderRenaming
Event Type
Type Description
EventHandler<FolderRenameArgs>
| Edit this page View Source

FolderSelected

Event triggered when a folder is selected.

Declaration
public event EventHandler<FolderSelectedArgs> FolderSelected
Event Type
Type Description
EventHandler<FolderSelectedArgs>

Implements

Extension Methods