Class FileDirectoryListbox

A listbox control that displays the file system.

Inheritance
object
ControlBase
CompositeControl
ListBox
FileDirectoryListbox
Implements
Inherited Members
Namespace: SadConsole.UI.Controls
Assembly: SadConsole.Extended.dll
Syntax
public class FileDirectoryListbox : ListBox, IContainer, IList<ControlBase>, ICollection<ControlBase>, IEnumerable<ControlBase>, IEnumerable

Constructors

FileDirectoryListbox(int, int)

Creates a new instance of the control and uses FileDirectoryListboxItem as the item theme.

Declaration
public FileDirectoryListbox(int width, int height)
Parameters
Type Name Description
int width

The width of the control.
int height

The height of the control.

FileDirectoryListbox(int, int, ListBoxItemTheme)

Creates a new instance of the control with the specified item theme.

Declaration
public FileDirectoryListbox(int width, int height, ListBoxItemTheme itemTheme)
Parameters
Type Name Description
int width

The width of the control.
int height

The height of the control.
ListBoxItemTheme itemTheme

The theme to use for the items.

Properties

CurrentFolder

The current folder displayed by the listbox.

Declaration
public string? CurrentFolder { get; set; }
Property Value
Type Description
string

FileFilter

A . wildcard filesystem filter. Use 

;
to split multiple filters.
Declaration
public string FileFilter { get; set; }
Property Value
Type Description
string

HideNonFilterFiles

When true, only displays files that match FileFilter; otherwise false to display all files.

Declaration
public bool HideNonFilterFiles { get; set; }
Property Value
Type Description
bool

HighlightedExtentions

A list of extensions of files to highlight, separated by a semicolon. The extension is just the name without any wildcards or periods, in lowercase. Example: txt;json;xml.

Declaration
public string? HighlightedExtentions { get; set; }
Property Value
Type Description
string

OnlyRootAndSubDirs

When true, only allows navigation from the root folder of the original value provided to CurrentFolder and below; otherwise false.

Declaration
public bool OnlyRootAndSubDirs { get; set; }
Property Value
Type Description
bool

Methods

OnItemAction()

Navigates a directory if a directory is selected. Raises the SelectedItemExecuted event.

Declaration
protected override void OnItemAction()
Overrides

Implements

Extension Methods