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

Inherits: Progress.Windows.UserControl

File:UltraTreeWithSearchControl
Purpose:Menu Tree with Search Capability
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Dec 15 17:43:28 CET 2010
Notes:Used for the Menubar Band of SmartExplorerBar2

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
# 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
# OnTreeNodeSelected (TreeNodeSelectedEventArgs) Raises the TreeNodeSelected event
+ PerformSearch () Performs the search
- 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
+ UltraTreeWithSearchControl () Constructor for the UltraTreeWithSearchControl 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 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
+ 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

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

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

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 UltraTreeWithSearchControl ()
Purpose: Constructor for the UltraTreeWithSearchControl 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 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 Infragistics.Win.UltraWinListView.UltraListView UltraListView
Purpose: Gets the reference to the contained UltraListView
Notes: Used by SmartExplorerBar2 to render the menu structure

Returns Infragistics.Win.UltraWinListView.UltraListView
Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTree UltraTree
Purpose: Gets the reference to the contained UltraTree
Notes: Used by SmartExplorerBar2 to render the menu structure

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:47:48