Consultingwerk.Windows.Util.UltraTreeHelper

Namespace:

Consultingwerk.Windows.Util

Class

UltraTreeHelper

Parent classes:

Progress.Lang.Object

Consultingwerk.Windows.Util.UltraTreeHelper

Inherits:

Progress.Lang.Object

Top Method Summary

Options	Name	Purpose
+	Infragistics.Win.UltraWinTree.UltraTreeNodeColumn AddColumnToNodeLevelColumnSet (integer, character, character, character)	Creates a new column on one of the Node Level based ColumnSets
+	Infragistics.Win.UltraWinTree.UltraTreeNodeColumn AddColumnToNodeLevelColumnSet (integer, character, character, character, integer)	Creates a new column on one of the Node Level based ColumnSets
#	Infragistics.Win.UltraWinTree.UltraTreeNodeColumn CreateColumnInColumnSet (UltraTreeColumnSet, character, logical)	Creates or returns a ColumnSet of the Tree
+	ExpandNodes (TreeNodesCollection, logical)	Recursively sets the Expanded of the nodes
+	ExpandNodesToLevel (UltraTree, integer)	Expands the tree nodes up to the provided level
#	ExpandNodesToLevel (UltraTreeNode, integer)	Expands the tree nodes up to the provided level
+	Infragistics.Win.UltraWinTree.UltraTreeNode FindNodeByText (TreeNodesCollection, character)	Finds a tree node by its Text
#	GetAllNodes (TreeNodesCollection, List)	Returns a list of all nodes in the tree
+	System.Collections.Generic.List <UltraTreeNode> GetAllNodes (UltraTree)	Returns a list of all nodes in the tree
+	CHARACTER GetNodeKeys (UltraTreeNode)	Returns an array with the keys of the provided node
+	Infragistics.Win.UltraWinTree.UltraTreeNode GetOrCreateNode (TreeNodesCollection, character, character)	Returns an existing node from the collection or adds a new one
+	Infragistics.Win.UltraWinTree.UltraTreeColumnSet GetOrCreateNodeLevelBasedColumnSet (integer)	Creates or returns a ColumnSet for the Tree and assigns it to a NodeLevelOverride
+	HideColumnHeaderForNodeLevel (integer)	Hides the ColumnHeader of a given NodeLevel
+	ParameterizeTree ()	Set Properties of the Tree
+	Infragistics.Win.UltraWinTree.UltraTreeNodeColumn ReplaceColumnInNodeLevelColumnSet (integer, character, character, character, character)	Replaces a column identified by the OldColumnKey on one of the Node Level based ColumnSets
+	ResetNodeLevelOverride (integer)	Resets the node collection of a NodeLevelOverride
+	ResetNodeLevelOverride (integer, integer)	Resets a list of NodeLevelOverrides
+	SetNodeColumnsEditable (UltraTreeNode, integer)	Enable the NodeColumns to be editable
+	ViewHideNodes (TreeNodesCollection, logical)	Recursively sets the visibility of the nodes

Top Constructor Summary

	Options	Name	Purpose
	+	UltraTreeHelper (UltraTree, integer, character)	Constructor for the UltraTreeHelper class

Top Property Summary

	Options	Name	Purpose
	+	Consultingwerk.Windows.Util.UltraTreeColumnResizeHelper ColumnResizer
	+	CHARACTER FirstColumnKey
	+	INTEGER PreferredCellSize
	+	Infragistics.Win.UltraWinTree.UltraTree Tree

Method Detail

Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTreeNodeColumn AddColumnToNodeLevelColumnSet (integer, character, character, character)

Purpose:	Creates a new column on one of the Node Level based ColumnSets
Notes:	Always add the Column at the end of the list

Parameters:
piNodeLevel	INTEGER
	The Level of the Node for which a column is created
pcColumnKey	CHARACTER
	The Key of the new column
pcColumnLabel	CHARACTER
	The Label of the new column
pcDataType	CHARACTER
	The DataType of the new column
Returns	Infragistics.Win.UltraWinTree.UltraTreeNodeColumn
	The created UltraTreeNodeColumn

Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTreeNodeColumn AddColumnToNodeLevelColumnSet (integer, character, character, character, integer)

Purpose:	Creates a new column on one of the Node Level based ColumnSets
Notes:	Add the column at a specific position

Parameters:
piNodeLevel	INTEGER
	The Level of the Node for which a column is created
pcColumnKey	CHARACTER
	The Key of the new column
pcColumnLabel	CHARACTER
	The Label of the new column
pcDataType	CHARACTER
	The DataType of the new column
piPosition	INTEGER
	The Position of the new column
Returns	Infragistics.Win.UltraWinTree.UltraTreeNodeColumn
	The created UltraTreeNodeColumn

Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNodeColumn CreateColumnInColumnSet (UltraTreeColumnSet, character, logical)

Purpose:	Creates or returns a ColumnSet of the Tree
Notes:

Parameters:
poColumnSet	Infragistics.Win.UltraWinTree.UltraTreeColumnSet
	Description
pcColumnKey	CHARACTER
	The key of the new column
plNewColumn	LOGICAL
	Flags if the column was newly added or preexisting
Returns	Infragistics.Win.UltraWinTree.UltraTreeNodeColumn
	The new Infragistics.Win.UltraWinTree.UltraTreeNodeColumn

Top

PUBLIC ExpandNodes (TreeNodesCollection, logical)

Purpose:	Recursively sets the Expanded of the nodes
Notes:

Parameters:
poNodes	Infragistics.Win.UltraWinTree.TreeNodesCollection
	The nodes collection to set
plExpand	LOGICAL
	The Expanded state

Top

PUBLIC ExpandNodesToLevel (UltraTree, integer)

Purpose:	Expands the tree nodes up to the provided level
Notes:

Parameters:
poTree	Infragistics.Win.UltraWinTree.UltraTree
	The UltraTree to expand
piLevel	INTEGER
	The level to expand to

Top

PROTECTED ExpandNodesToLevel (UltraTreeNode, integer)

Purpose:	Expands the tree nodes up to the provided level
Notes:	Recursive method

Parameters:
poTreeNode	Infragistics.Win.UltraWinTree.UltraTreeNode
	The UltraTree node to expand
piLevel	INTEGER
	The level to expand to

Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTreeNode FindNodeByText (TreeNodesCollection, character)

Purpose:	Finds a tree node by its Text
Notes:

Parameters:
poNodes	Infragistics.Win.UltraWinTree.TreeNodesCollection
	The UltraTree nodes collection to search in
pcText	CHARACTER
	The Text to search for
Returns	Infragistics.Win.UltraWinTree.UltraTreeNode
	The UltraTreeNode with the Text

Top

PROTECTED GetAllNodes (TreeNodesCollection, List)

Purpose:	Returns a list of all nodes in the tree
Notes:	Recursively processes all nodes

Parameters:
poNodes	Infragistics.Win.UltraWinTree.TreeNodesCollection
	The TreeNodesCollection to process
poList	System.Collections.Generic.List
	The List<UltraTreeNode> to add nodes to

Top

PUBLIC System.Collections.Generic.List <UltraTreeNode> GetAllNodes (UltraTree)

Purpose:	Returns a list of all nodes in the tree
Notes:	Recursively processes all nodes

Parameters:
poTree	Infragistics.Win.UltraWinTree.UltraTree
	The UltraTree to return all Nodes from
Returns	System.Collections.Generic.List <UltraTreeNode>
	The List<UltraTreeNode> with all nodes of the tree

Top

PUBLIC CHARACTER GetNodeKeys (UltraTreeNode)

Purpose:	Returns an array with the keys of the provided node
Notes:	Includes the parent node's keys

Parameters:
poNode	Infragistics.Win.UltraWinTree.UltraTreeNode
	The node to return the keys's fork
Returns	CHARACTER
	The Character array with the keys of the node

Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTreeNode GetOrCreateNode (TreeNodesCollection, character, character)

Purpose:	Returns an existing node from the collection or adds a new one
Notes:

Parameters:
poTreeNodesCollection	Infragistics.Win.UltraWinTree.TreeNodesCollection
	The TreeNodesCollection to add the new UltraTreeNode to
pcNodeKey	CHARACTER
	The key of the new Node
pcNodeLabel	CHARACTER
	The label of the new Node
Returns	Infragistics.Win.UltraWinTree.UltraTreeNode
	The new UltraTreeNode instance

Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTreeColumnSet GetOrCreateNodeLevelBasedColumnSet (integer)

Purpose:	Creates or returns a ColumnSet for the Tree and assigns it to a
	NodeLevelOverride
Notes:

Parameters:
piNodeLevel	INTEGER
	The Level of the Node for which a column is created
Returns	Infragistics.Win.UltraWinTree.UltraTreeColumnSet
	The reference to the Infragistics.Win.UltraWinTree.UltraTreeColumnSet

Top

PUBLIC HideColumnHeaderForNodeLevel (integer)

Purpose:	Hides the ColumnHeader of a given NodeLevel
Notes:

Parameters:
piNodeLevel	INTEGER
	The INTEGER value of the NodeLevel to be changed

Top

PUBLIC ParameterizeTree ()

Purpose:	Set Properties of the Tree
Notes:

Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTreeNodeColumn ReplaceColumnInNodeLevelColumnSet (integer, character, character, character, character)

Purpose:	Replaces a column identified by the OldColumnKey on one of the Node
	Level based ColumnSets
Notes:

Parameters:
piNodeLevel	INTEGER
	The Level of the Node for which a column is replaced
pcOldColumnKey	CHARACTER
	The Key of the column to be replaced
pcNewColumnKey	CHARACTER
	The new Key of the column
pcNewColumnLabel	CHARACTER
	The new Label of the column
pcDataType	CHARACTER
	The DataType of the column
Returns	Infragistics.Win.UltraWinTree.UltraTreeNodeColumn
	The created UltraTreeNodeColumn

Top

PUBLIC ResetNodeLevelOverride (integer)

Purpose:	Resets the node collection of a NodeLevelOverride
Notes:

Parameters:
piNodeLevel	INTEGER
	The NodeLevel to process

Top

PUBLIC ResetNodeLevelOverride (integer, integer)

Purpose:	Resets a list of NodeLevelOverrides
Notes:

Parameters:
piStartNodeLevel	INTEGER
	The start NodeLevel to process
piStopNodeLevel	INTEGER
	The stop NodeLevel to process

Top

PUBLIC SetNodeColumnsEditable (UltraTreeNode, integer)

Purpose:	Enable the NodeColumns to be editable
Notes:

Parameters:
poTreeNode	Infragistics.Win.UltraWinTree.UltraTreeNode
	The Node which has to be editable
piColumnOffset	INTEGER
	Index of the Column to start edit in. The others won't be editable

Top

PUBLIC ViewHideNodes (TreeNodesCollection, logical)

Purpose:	Recursively sets the visibility of the nodes
Notes:

Parameters:
poNodes	Infragistics.Win.UltraWinTree.TreeNodesCollection
	The nodes collection to set
plView	LOGICAL
	The visibility of the nodes

Constructor Detail

Top

PUBLIC UltraTreeHelper (UltraTree, integer, character)

Purpose:	Constructor for the UltraTreeHelper class
Notes:

Parameters:
poTree	Infragistics.Win.UltraWinTree.UltraTree
	An UltraTree instance which has to be valid.
piPreferredCellSize	INTEGER
	The preferred cell size to be applied
pcFirstColumnKey	CHARACTER
	The reference to the first column of the tree

Property Detail

Top

PUBLIC Consultingwerk.Windows.Util.UltraTreeColumnResizeHelper ColumnResizer

Returns	Consultingwerk.Windows.Util.UltraTreeColumnResizeHelper

Top

PUBLIC CHARACTER FirstColumnKey

Returns	CHARACTER

Top

PUBLIC INTEGER PreferredCellSize

Returns	INTEGER

Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTree Tree

Returns	Infragistics.Win.UltraWinTree.UltraTree

info@consultingwerk.de http://www.consultingwerk.de 09.11.2024 19:13:22