Namespace: Consultingwerk.Windows.Framework.Controls
Class 
MenuTreeViewControl Copy to Clipboard
Parent classes:
Progress.Windows.UserControl
Consultingwerk.Windows.Framework.Controls.MenuTreeViewControl

Inherits: Progress.Windows.UserControl

File:MenuTreeViewControl
Purpose:Menu Tree that is populated from an IMenuStructureProvider
service and can start menu functions using the IMenuFunctionLauncher
service
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Dec 07 16:56:15 CET 2012

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ LOGICAL ExpandNode (character, logical) Expands or collapses the TreeNode with the given key
+ FillMenuStructure (character, logical) Fills the tree menu
# FindNodes (character, TreeNodesCollection) Searches the Tree View Nodes for a Search String
+ FocusSearchField () Puts the Focus into the Search Field
- InitializeComponent () Initializes the Visual Design
# ItemSelected (UltraTreeNode) Raises the TreeNodeSelected event if the given Node is enabled
# ListViewItemSelected () Raises the ItemSelected event for the UltraTreeNode that correspondents to the currently selected ListViewItem
+ LoadMenu () Loads the Menu Structure in the Tree
# OnLoad (EventArgs) Raises the Load event
# OnTreeNodeSelected (TreeNodeSelectedEventArgs) Raises the TreeNodeSelected event
+ PerformSearch () Performs the search
# PopulateNodes (TreeNodesCollection, character) Populates the Nodes in the Tree
+ LOGICAL SelectNode (character) Expands or collapses the TreeNode with the given key
- timer1_Tick (Object, EventArgs) Eventhandler for the Tick Event of the timer Component
- ultraListView1_DoubleClick (Object, EventArgs) Event handler for the DoubleClick Event of the ultraListView1
- ultraListView1_KeyDown (Object, KeyEventArgs) Event handler for the KeyDown Event of the ultraListView1
- ultraListView1_MouseDown (Object, MouseEventArgs) Event handler for the MouseDown Event of the ultraListView1
- ultraTextEditor1_EditorButtonClick (Object, EditorButtonEventArgs) Event handler for the EditorButtonClick Event of the ultraTextEditor1
- ultraTextEditor1_KeyDown (Object, KeyEventArgs) Event handler for the KeyDown Event of the ultraTextEditor1
- ultraTextEditor1_KeyPress (Object, KeyPressEventArgs) Event handler for the KeyPress Event of the ultraTextEditor1
- ultraTree1_AfterExpand (Object, NodeEventArgs) Event handler for the AfterExpand event handler of the ultraTree1 instance
- ultraTree1_KeyDown (Object, KeyEventArgs) Event handler for the KeyDown Event of the ultraTree1
- ultraTree1_MouseClick (Object, MouseEventArgs) Event handler for the MouseClick Event of the ultraTree1
- ultraTree1_MouseDoubleClick (Object, MouseEventArgs) Event handler for the MouseDoubleClick Event of the ultraTree1

Top Constructor Summary
Options Name Purpose
+ MenuTreeViewControl () Constructor for the MenuTreeViewControl class

Top Event Summary
Options Name Purpose
+ TreeNodeSelected (Object, TreeNodeSelectedEventArgs) Event raised when the user selectes a TreeNode or the corresponding item in the UltraListView

Top Property Summary
Options Name Purpose
+ LOGICAL ExpandFirstLevelAfterStart Gets and sets if the first level of TreeNodes (root nodes) should be expanded during OnLoad
+ LOGICAL ExpandSecondLevelAfterStart Gets and sets if the second level of TreeNodes should be expanded during OnLoad
+ LOGICAL IncludeParentNodeTextIntoSearchResult Gets and sets if the parent nodes (if present) Text should be included in the text shown for the search results
+ CHARACTER ParentNodeTextSubstitute Gets and sets the substitute pattern used for the search result texts when IncludeParentNodeTextIntoSearchResult is set to true
+ LOGICAL RenderRootNode Gets and sets the root node's key
+ CHARACTER RootNodeKey Gets and sets the root node's key
+ LOGICAL SkipAuthorizationCheck Returns if the authorization checks should be skipps
+ LOGICAL Sorted Gets and sets if the tree nodes should be sorted by the tree
+ Infragistics.Win.UltraWinListView.UltraListView UltraListView Gets the reference to the contained UltraListView
+ Infragistics.Win.UltraWinTree.UltraTree UltraTree Gets the reference to the contained UltraTree
+ LOGICAL UseDoubleClickForItemSelect Gets and sets if the double click should be used for selecting items in the UltraTree


Method Detail
Top

PUBLIC LOGICAL ExpandNode (character, logical)
Purpose: Expands or collapses the TreeNode with the given key
Notes:

Parameters:
pcNodeKey CHARACTER
The key of the node to process
plExpand LOGICAL
Logical value indicating if the Node should be expanded or collapsed
Returns LOGICAL
Logical value indicating if the Node could be found
Top

PUBLIC FillMenuStructure (character, logical)
Purpose: Fills the tree menu
Notes:

Parameters:
pcRootNodeKey CHARACTER
The root node key to retrieve
plRenderRootNode LOGICAL
Render the Root Node as a Tree Node itself
Top

PROTECTED FindNodes (character, TreeNodesCollection)
Purpose: Searches the Tree View Nodes for a Search String
Notes: Populates the search results in the ultraListView1 instance, recursive method

Parameters:
pcSearchString CHARACTER
The string to search for
poNodes Infragistics.Win.UltraWinTree.TreeNodesCollection
The current iteration of the TreeNodesCollection
Top

PUBLIC FocusSearchField ()
Purpose: Puts the Focus into the Search Field
Notes:

Top

PRIVATE InitializeComponent ()
Purpose: Initializes the Visual Design
Notes:

Top

PROTECTED ItemSelected (UltraTreeNode)
Purpose: Raises the TreeNodeSelected event if the given Node is enabled
Notes:

Parameters:
poNode Infragistics.Win.UltraWinTree.UltraTreeNode
The UltraTreeNode to raise the TreeNodeSelected event for
Top

PROTECTED ListViewItemSelected ()
Purpose: Raises the ItemSelected event for the UltraTreeNode that correspondents
to the currently selected ListViewItem
Notes:

Top

PUBLIC LoadMenu ()
Purpose: Loads the Menu Structure in the Tree
Notes:

Top

PROTECTED OnLoad (EventArgs)
Purpose: Raises the Load event
Notes: Populates the Menu Structrur

Parameters:
e System.EventArgs
The System.EventArgs with the data for the Load event
Top

PROTECTED OnTreeNodeSelected (TreeNodeSelectedEventArgs)
Purpose: Raises the TreeNodeSelected event
Notes:

Parameters:
e Consultingwerk.Windows.Controls.TreeNodeSelectedEventArgs
The TreeNodeSelectedEventArgs with the data for this event
Top

PUBLIC PerformSearch ()
Purpose: Performs the search
Notes:

Top

PROTECTED PopulateNodes (TreeNodesCollection, character)
Purpose: Populates the Nodes in the Tree
Notes:

Parameters:
poNodes Infragistics.Win.UltraWinTree.TreeNodesCollection
The current root node nodes collection
pcParentMenuKey CHARACTER
The Root Node Key for the current level
Top

PUBLIC LOGICAL SelectNode (character)
Purpose: Expands or collapses the TreeNode with the given key
Notes:

Parameters:
pcNodeKey CHARACTER
The key of the node to process
Returns LOGICAL
Logical value indicating if the Node could be found
Top

PRIVATE timer1_Tick (Object, EventArgs)
Purpose: Eventhandler for the Tick Event of the timer Component
Notes: Calls PerformSearch ()

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PRIVATE ultraListView1_DoubleClick (Object, EventArgs)
Purpose: Event handler for the DoubleClick Event of the ultraListView1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PRIVATE ultraListView1_KeyDown (Object, KeyEventArgs)
Purpose: Event handler for the KeyDown Event of the ultraListView1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.KeyEventArgs
The KeyEventArgs with the data for this event
Top

PRIVATE ultraListView1_MouseDown (Object, MouseEventArgs)
Purpose: Event handler for the MouseDown Event of the ultraListView1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.MouseEventArgs
The MouseEventArgs with the data for this event
Top

PRIVATE ultraTextEditor1_EditorButtonClick (Object, EditorButtonEventArgs)
Purpose: Event handler for the EditorButtonClick Event of the ultraTextEditor1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Infragistics.Win.UltraWinEditors.EditorButtonEventArgs
The EditorButtonEventArgs with the data for this event
Top

PRIVATE ultraTextEditor1_KeyDown (Object, KeyEventArgs)
Purpose: Event handler for the KeyDown Event of the ultraTextEditor1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.KeyEventArgs
The KeyEventArgs with the data for this event
Top

PRIVATE ultraTextEditor1_KeyPress (Object, KeyPressEventArgs)
Purpose: Event handler for the KeyPress Event of the ultraTextEditor1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.KeyPressEventArgs
The KeyPressEventArgs with the data for this event
Top

PRIVATE ultraTree1_AfterExpand (Object, NodeEventArgs)
Purpose: Event handler for the AfterExpand event handler of the ultraTree1
instance
Notes: Ensures that the expanded node and child nodes are visible

Parameters:
sender System.Object
The reference to the object that raised this event
e Infragistics.Win.UltraWinTree.NodeEventArgs
The NodeEventArgs with the data for this event
Top

PRIVATE ultraTree1_KeyDown (Object, KeyEventArgs)
Purpose: Event handler for the KeyDown Event of the ultraTree1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.KeyEventArgs
The KeyEventArgs with the data for this event
Top

PRIVATE ultraTree1_MouseClick (Object, MouseEventArgs)
Purpose: Event handler for the MouseClick Event of the ultraTree1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.MouseEventArgs
The MouseEventArgs with the data for this event
Top

PRIVATE ultraTree1_MouseDoubleClick (Object, MouseEventArgs)
Purpose: Event handler for the MouseDoubleClick Event of the ultraTree1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.MouseEventArgs
The MouseEventArgs with the data for this event


Constructor Detail
Top

PUBLIC MenuTreeViewControl ()
Purpose: Constructor for the MenuTreeViewControl class
Notes:



Event Detail
Top

PUBLIC TreeNodeSelected (Object, TreeNodeSelectedEventArgs)
Purpose: Event raised when the user selectes a TreeNode or the corresponding
item in the UltraListView
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Consultingwerk.Windows.Controls.TreeNodeSelectedEventArgs
The TreeNodeSelectedEventArgs with the dat for this event


Property Detail
Top

PUBLIC LOGICAL ExpandFirstLevelAfterStart
Purpose: Gets and sets if the first level of TreeNodes (root nodes) should be
expanded during OnLoad
Notes: This is default behaviour

Returns LOGICAL
Top

PUBLIC LOGICAL ExpandSecondLevelAfterStart
Purpose: Gets and sets if the second level of TreeNodes should be
expanded during OnLoad
Notes: By default only the Root Nodes will be expanded

Returns LOGICAL
Top

PUBLIC LOGICAL IncludeParentNodeTextIntoSearchResult
Purpose: Gets and sets if the parent nodes (if present) Text should be included
in the text shown for the search results
Notes: When true, the ParentNodeTextSubstitute is used to compute the text
used in the search results, &1 for the parent nodes text, &2 for the
actual node

Returns LOGICAL
Top

PUBLIC CHARACTER ParentNodeTextSubstitute
Purpose: Gets and sets the substitute pattern used for the search result texts
when IncludeParentNodeTextIntoSearchResult is set to true
Notes: &1 for the parent nodes text, &2 for the
actual node

Returns CHARACTER
Top

PUBLIC LOGICAL RenderRootNode
Purpose: Gets and sets the root node's key
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER RootNodeKey
Purpose: Gets and sets the root node's key
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL SkipAuthorizationCheck
Purpose: Returns if the authorization checks should be skipps
Notes: Allows to retrieve full menu structure to clients that perform
authentication only after the first menu item has been selected
etc.

Returns LOGICAL
Top

PUBLIC LOGICAL Sorted
Purpose: Gets and sets if the tree nodes should be sorted by the tree
Notes: By default tree nodes are not sorted by the tree and thus use the
order which is provided by the menu structure

Returns LOGICAL
Top

PUBLIC Infragistics.Win.UltraWinListView.UltraListView UltraListView
Purpose: Gets the reference to the contained UltraListView
Notes:

Returns Infragistics.Win.UltraWinListView.UltraListView
Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTree UltraTree
Purpose: Gets the reference to the contained UltraTree
Notes:

Returns Infragistics.Win.UltraWinTree.UltraTree
Top

PUBLIC LOGICAL UseDoubleClickForItemSelect
Purpose: Gets and sets if the double click should be used for selecting items
in the UltraTree
Notes: Previously the single click was used to select items. This property
is to achieve backwards compatibility

Returns LOGICAL


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:49:18