Class ContentFileExplorer

A file explorer used to display editor content files.

Inheritance
object
MarshalByRefObject
Component
Control
ScrollableControl
ContainerControl
UserControl
EditorBaseControl
ContentFileExplorer
Implements
Inherited Members
Namespace: Gorgon.Editor.UI.Controls
Assembly: Gorgon.Editor.API.dll
Syntax
public class ContentFileExplorer : EditorBaseControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl

Constructors

| Edit this page View Source

ContentFileExplorer()

Initializes a new instance of the ContentFileExplorer class.

Declaration
public ContentFileExplorer()

Properties

| Edit this page View Source

CurrentDirectory

Property to return the current directory.

Declaration
[Browsable(false)]
public string CurrentDirectory { get; }
Property Value
Type Description
string
Remarks

This will only return a value if MultiSelect is false.

| Edit this page View Source

Entries

Property to set or return the list of entries to display.

Declaration
[Browsable(false)]
public IReadOnlyList<ContentFileExplorerDirectoryEntry> Entries { get; set; }
Property Value
Type Description
IReadOnlyList<ContentFileExplorerDirectoryEntry>
| Edit this page View Source

FileColumnText

Property to set or return the text to display in the file column header.

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

MultiSelect

Property to set or return whether to use single selection, or multi-selection.

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

ShowSearch

Property to set or return whether search is available or not.

Declaration
[Browsable(true)]
public bool ShowSearch { get; set; }
Property Value
Type Description
bool

Methods

| 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

OnSearch(GorgonSearchEventArgs)

Function to send the search event.

Declaration
protected virtual void OnSearch(GorgonSearchEventArgs e)
Parameters
Type Name Description
GorgonSearchEventArgs e

The arguments for the event.

Events

| Edit this page View Source

FileEntriesFocused

Event triggered when the files are focused/highlighted on the file list.

Declaration
public event EventHandler<ContentFileEntriesFocusedArgs> FileEntriesFocused
Event Type
Type Description
EventHandler<ContentFileEntriesFocusedArgs>
| Edit this page View Source

FileEntrySelected

Event triggered when a file entry is selected.

Declaration
public event EventHandler<ContentFileEntrySelectedEventArgs> FileEntrySelected
Event Type
Type Description
EventHandler<ContentFileEntrySelectedEventArgs>
| Edit this page View Source

FileEntryUnselected

Event tiggered when a file entry is unselected.

Declaration
public event EventHandler<ContentFileEntrySelectedEventArgs> FileEntryUnselected
Event Type
Type Description
EventHandler<ContentFileEntrySelectedEventArgs>
| Edit this page View Source

Event triggered when a search term is entered into the search box.

Declaration
public event EventHandler<GorgonSearchEventArgs> Search
Event Type
Type Description
EventHandler<GorgonSearchEventArgs>

Implements

Extension Methods