C# Class Nexus.UI.Controls.FileSystemTreeViewBase

A tree view that allow browsing through a file system.

The tree view will browse into archives.

Inheritance: System.Windows.Forms.MultiSelectTreeView

Show file Open project: NexusMods/NexusModManager-4.5

Private Properties

Property	Type	Description

Public Methods

Method	Description
AddPath ( FileSystemTreeNode p_tndRoot, string p_strFile ) : FileSystemTreeNode	This adds a file/folder to the source file structure.
AddPath ( string p_strFile ) : void	Adds the given file to the source tree.
AddPaths ( FileSystemTreeNode p_tndRoot, string p_strFileNames ) : void	Addes the specified files to the source tree.
AddPaths ( string p_strFileNames ) : void	Addes the specified files to the source tree.
FileSystemTreeViewBase ( ) : System	The default constructor.
RemoveNodes ( IList p_lstNodes ) : void	Removes the specified nodes from the tree view. The user is asked to confirm the removal.
SetSelectedNode ( string p_strPath ) : void	Sets the selected node to the one specifide by the given path.

Protected Methods

Method	Description
FindNearestAncestor ( FileSystemTreeNode p_tndRoot, string p_strPath, Queue &p_queMissingPath ) : FileSystemTreeNode	Finds the specified node, or the specified node's nearest ancestor if the specified node does not exist.
LoadChildren ( FileSystemTreeNode p_tndFolder ) : void	Loads the children of the given node.
OnKeyDown ( KeyEventArgs e ) : void	Raises the Control.OnKeyDown event of the tree view. This makes the delete key remove the selected nodes.
OnNodeAdded ( NodesChangedEventArgs e ) : void	Raises the NodeAdded event.
OnNodeRemoved ( NodesChangedEventArgs e ) : void	Raises the NodeRemoved event.
SetNodeImage ( FileSystemTreeNode p_fsnItem ) : void	Sets the image of the given node.
ShouldLoadChildren ( FileSystemTreeNode p_fsnItem ) : bool	Determines if the children of the given node should be loaded.

Method Details

AddPath() public method

This adds a file/folder to the source file structure.

public AddPath ( FileSystemTreeNode p_tndRoot, string p_strFile ) : FileSystemTreeNode
p_tndRoot	FileSystemTreeNode	The node to which to add the file/folder.
p_strFile	string	The path to add to the source file structure.
return	FileSystemTreeNode

AddPath() public method

Adds the given file to the source tree.

public AddPath ( string p_strFile ) : void
p_strFile	string	The file to add.
return	void

AddPaths() public method

Addes the specified files to the source tree.

public AddPaths ( FileSystemTreeNode p_tndRoot, string p_strFileNames ) : void
p_tndRoot	FileSystemTreeNode	The node to which to add the file/folder.
p_strFileNames	string	The paths to add to the source tree.
return	void

AddPaths() public method

Addes the specified files to the source tree.

public AddPaths ( string p_strFileNames ) : void
p_strFileNames	string	The paths to add to the source tree.
return	void

FileSystemTreeViewBase() public method

The default constructor.

public FileSystemTreeViewBase ( ) : System
return	System

FindNearestAncestor() protected method

Finds the specified node, or the specified node's nearest ancestor if the specified node does not exist.

protected FindNearestAncestor ( FileSystemTreeNode p_tndRoot, string p_strPath, Queue &p_queMissingPath ) : FileSystemTreeNode
p_tndRoot	FileSystemTreeNode	The node under which to search for the specified node.
p_strPath	string	The path to the node to be found.
p_queMissingPath	Queue	An out parameter that returns the path parts that were not found.
return	FileSystemTreeNode

LoadChildren() protected method

Loads the children of the given node.

protected LoadChildren ( FileSystemTreeNode p_tndFolder ) : void
p_tndFolder	FileSystemTreeNode	The node whose children are to be loaded.
return	void

OnKeyDown() protected method

Raises the Control.OnKeyDown event of the tree view.

This makes the delete key remove the selected nodes.

protected OnKeyDown ( KeyEventArgs e ) : void
e	System.Windows.Forms.KeyEventArgs	A describing the event arguments.
return	void

OnNodeAdded() protected method

Raises the NodeAdded event.

protected OnNodeAdded ( NodesChangedEventArgs e ) : void
e	NodesChangedEventArgs	A describing the event arguments.
return	void

OnNodeRemoved() protected method

Raises the NodeRemoved event.

protected OnNodeRemoved ( NodesChangedEventArgs e ) : void
e	NodesChangedEventArgs	A describing the event arguments.
return	void

RemoveNodes() public method

Removes the specified nodes from the tree view.

The user is asked to confirm the removal.

public RemoveNodes ( IList p_lstNodes ) : void
p_lstNodes	IList	The nodes to remove.
return	void

SetNodeImage() protected method

Sets the image of the given node.

protected SetNodeImage ( FileSystemTreeNode p_fsnItem ) : void
p_fsnItem	FileSystemTreeNode	The node whose image shuld be set.
return	void

SetSelectedNode() public method

Sets the selected node to the one specifide by the given path.

public SetSelectedNode ( string p_strPath ) : void
p_strPath	string	The path to the node to be selected.
return	void

ShouldLoadChildren() protected method

Determines if the children of the given node should be loaded.

protected ShouldLoadChildren ( FileSystemTreeNode p_fsnItem ) : bool
p_fsnItem	FileSystemTreeNode	The node for which it is to be determined if the children should be loaded.
return	bool