Namespace: Consultingwerk.Windows.Framework.Repository.MergeUtil
Class 
ObjectMasterTreeControl Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: IHasDesignerVerbs

File:ObjectMasterTreeControl
Author(s):Sebastian Wandel / Consultingwerk Ltd.
Created:Fri Mar 17 11:17:02 CET 2023



Top Method Summary
Options Name Purpose
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildAttributeNode (character, SmartAttributeTableModel, handle) Builds an Attribute node
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildFieldNode (character, handle) Builds a Node for a field of the Object Master or Object Instance node
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildFieldsNode (character, handle) Builds the master "Fields" node
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildInstanceAttributesNode (character, handle) Builds the instance "Attributes" node
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildInstanceNode (character, handle) Builds an instance node
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildInstancesNode (character, handle) Builds the "Instances" node
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildLinkNode (character, handle) Builds a Node for a SmartLink record
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildLinksNode (character, character) Builds the "Links" node
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildMasterAttributesNode (character, character) Builds the master "Attributes" node
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildPageNode (character, handle) Builds a Page node
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildPagesNode (character, character) Builds the "Pages" node
# Infragistics.Win.UltraWinTree.UltraTreeNode BuildSmartObjectMasterNode (handle) Builds the root node
+ BuildTree () Populates the tree
# ClearNode (UltraTreeNode) Clears (removes) a tree node
+ CopyNodeFrom (ObjectMasterTreeControl) Copied the active node from the source control to this control instance
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ Infragistics.Win.UltraWinTree.UltraTreeNode ExpandNode (character, logical) Expands a Node by it's key
# HANDLE FindBufferForNode (character) Finds the record for the given node and returns the buffer handle
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER GetAttributeValue (SmartAttributeTableModel, handle) Returns an Attribute Value
# System.Collections.Generic.List <System.String> GetExpandedNodes () Returns the list of keys of currently expanded nodes
- InitializeComponent () Initializes the Visual Design
# OnLoad (EventArgs) Raises the Load event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# OnNodeCollapsed (NodeEventArgs) Raises the NodeCollapsed event
# OnNodeExpanded (NodeEventArgs) Raises the NodeExpanded event
# OnNodeSelected (SelectEventArgs) Raises the NodeSelected event
# OnTreeUpdated (EventArgs) Raises the TreeUpdated
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ RemoveNode () Removes a Node from the Merged Tree
# RestoreExpandedNodes (String>) Restores the expanded nodes
+ SaveChanges () Saves the changes to the repository object
+ Infragistics.Win.UltraWinTree.UltraTreeNode SelectNode (character) Selects a Node by it's key
+ SetNodeColor (UltraTree) Sets the Node color by comparing the Node to another tree instance
+ SubscribeParentFormDestroyed () Subscribes the ParentFormDestroyed event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# SubscribeUserControlEvents () Allows for custom event subscriptions during OnLoad()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
- ultraTree1_AfterCollapse (Object, NodeEventArgs) Event handler for the AfterCollapse event of the ultraTree1
- ultraTree1_AfterExpand (Object, NodeEventArgs) Event handler for the AfterExpand event of the ultraTree1
- ultraTree1_AfterSelect (Object, SelectEventArgs)

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

Top Event Summary
Options Name Purpose
+ NodeCollapsed (Object, NodeEventArgs) Raised when a Node is Collapsed
+ NodeExpanded (Object, NodeEventArgs) Raised when a Node is Expanded
+ NodeSelected (Object, SelectEventArgs) Raised when a Node is Selected
+ TreeUpdated DELEGATE System.EventHandler Raised when the tree is updated

Top Property Summary
Options Name Purpose
+ Infragistics.Win.UltraWinTree.UltraTreeNode ActiveNode
+ HANDLE DatasetHandle
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ Consultingwerk.Windows.Framework.Repository.MergeUtil.TreePurposeEnum Purpose
+ Infragistics.Win.UltraWinTree.UltraTree TreeControl
# LOGICAL UserControlEventsSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl


Method Detail
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildAttributeNode (character, SmartAttributeTableModel, handle)

Purpose: Builds an Attribute node
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent node
poAttribute Consultingwerk.SmartFramework.Repository.Class.SmartAttributeTableModel
The TableModel describing the Attribute
phAttributeValue HANDLE
The handle of the Attribute Value buffer
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new tree node
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildFieldNode (character, handle)

Purpose: Builds a Node for a field of the Object Master or Object Instance node
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent node
phField HANDLE
The handle of the buffer field
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new tree node
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildFieldsNode (character, handle)

Purpose: Builds the master "Fields" node
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent node
phBuffer HANDLE
The handle of the buffer
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new TreeNode
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildInstanceAttributesNode (character, handle)

Purpose: Builds the instance "Attributes" node
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent node
phInstance HANDLE
The handle of the eSmartObjectInstance buffer
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new TreeNode
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildInstanceNode (character, handle)

Purpose: Builds an instance node
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent node
phInstance HANDLE
The handle of the eSmartObjectInstance buffer
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new TreeNode
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildInstancesNode (character, handle)

Purpose: Builds the "Instances" node
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent node
phBuffer HANDLE
The handle of the eSmartObjectMaster buffer
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new TreeNode
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildLinkNode (character, handle)

Purpose: Builds a Node for a SmartLink record
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent Node
phLink HANDLE
The handle of the eSmartLink record
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new TreeNode
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildLinksNode (character, character)

Purpose: Builds the "Links" node
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent Node
pcObjectMasterGuid CHARACTER
The GUID of the SmartObjectMaster
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new TreeNode
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildMasterAttributesNode (character, character)

Purpose: Builds the master "Attributes" node
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent node
pcObjectMasterGuid CHARACTER
The GUID of the SmartObjectMaster
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new TreeNode
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildPageNode (character, handle)

Purpose: Builds a Page node
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent node
phPage HANDLE
The handle of the eSmartPage buffer
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new TreeNode
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildPagesNode (character, character)

Purpose: Builds the "Pages" node
Notes:

Parameters:
pcParentKey CHARACTER
The key of the parent node
pcObjectMasterGuid CHARACTER
The GUID of the SmartObjectMaster
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the new TreeNode
Top

PROTECTED Infragistics.Win.UltraWinTree.UltraTreeNode BuildSmartObjectMasterNode (handle)

Purpose: Builds the root node
Notes:

Parameters:
phBuffer HANDLE
The handle of the eSmartObjectMaster record
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the root node
Top

PUBLIC BuildTree ()

Purpose: Populates the tree
Notes:

Top

PROTECTED ClearNode (UltraTreeNode)

Purpose: Clears (removes) a tree node
Notes:

Parameters:
poNode Infragistics.Win.UltraWinTree.UltraTreeNode
The UltraTreeNode to remove
Top

PUBLIC CopyNodeFrom (ObjectMasterTreeControl)

Purpose: Copied the active node from the source control to this control instance
Notes:

Parameters:
poSource Consultingwerk.Windows.Framework.Repository.MergeUtil.ObjectMasterTreeControl
The reference to the source ObjectMasterTreeControl instance
Top

PROTECTED CreateVerbs ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTreeNode ExpandNode (character, logical)

Purpose: Expands a Node by it's key
Notes:

Parameters:
pcNodeKey CHARACTER
The key of the Node to select
plExpand LOGICAL
Logical value indicating if it's expand or collapse
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the UltraTreeNode
Top

PROTECTED HANDLE FindBufferForNode (character)

Purpose: Finds the record for the given node and returns the buffer handle
Notes:

Parameters:
pcKey CHARACTER
The key of the Node to locate
Returns HANDLE
The handle of the relevant buffer
Top

PUBLIC System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Returns a List of all Components in the Form
Notes: Supported on OpenEdge 11 only, due to dependency to the ComponentsCollection
list not available on 10.2B

Returns System.Collections.Generic.List <System.ComponentModel.Component>
The List of Components in the Form
Top

PROTECTED CHARACTER GetAttributeValue (SmartAttributeTableModel, handle)

Purpose: Returns an Attribute Value
Notes:

Parameters:
poAttribute Consultingwerk.SmartFramework.Repository.Class.SmartAttributeTableModel
The TableModel describing the Attribute
phAttributeValue HANDLE
The handle of the attribute value
Returns CHARACTER
The attribute value
Top

PROTECTED System.Collections.Generic.List <System.String> GetExpandedNodes ()

Purpose: Returns the list of keys of currently expanded nodes
Notes:

Returns System.Collections.Generic.List <System.String>
The list of keys of the currently expanded nodes
Top

PRIVATE InitializeComponent ()

Purpose: Initializes the Visual Design
Notes:

Top

PROTECTED OnLoad (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Raises the Load event
Notes: Subscribes the FormDestroyed event from the ParentForm

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

PROTECTED OnNodeCollapsed (NodeEventArgs)

Purpose: Raises the NodeCollapsed event
Notes:

Parameters:
e Infragistics.Win.UltraWinTree.NodeEventArgs
The NodeEventArgs with the data for this event
Top

PROTECTED OnNodeExpanded (NodeEventArgs)

Purpose: Raises the NodeExpanded event
Notes:

Parameters:
e Infragistics.Win.UltraWinTree.NodeEventArgs
The NodeEventArgs with the data for this event
Top

PROTECTED OnNodeSelected (SelectEventArgs)

Purpose: Raises the NodeSelected event
Notes:

Parameters:
e Infragistics.Win.UltraWinTree.SelectEventArgs
The SelectEventArgs with the data for this event
Top

PROTECTED OnTreeUpdated (EventArgs)

Purpose: Raises the TreeUpdated
Notes:

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

PUBLIC OnVerbClicked (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event Handler method for Designer Verbs
Notes: This method is intended to be overridden

Parameters:
pcDesignerVerb CHARACTER
The name (Label) of the Designer Verb that was invoked
Top

PROTECTED ParentFormDestroyedHandler (Object, EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event handler for the FormDestroyed event of the owning Form
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

PUBLIC RemoveNode ()

Purpose: Removes a Node from the Merged Tree
Notes:

Top

PROTECTED RestoreExpandedNodes (String>)

Purpose: Restores the expanded nodes
Notes:

Parameters:
poNodeKeys System.Collections.Generic.List
The list of keys of the currently expanded nodes
Top

PUBLIC SaveChanges ()

Purpose: Saves the changes to the repository object
Notes:

Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTreeNode SelectNode (character)

Purpose: Selects a Node by it's key
Notes:

Parameters:
pcNodeKey CHARACTER
The key of the Node to select
Returns Infragistics.Win.UltraWinTree.UltraTreeNode
The reference to the UltraTreeNode
Top

PUBLIC SetNodeColor (UltraTree)

Purpose: Sets the Node color by comparing the Node to another tree instance
Notes:

Parameters:
poReferenceTree Infragistics.Win.UltraWinTree.UltraTree
The reference tree instance
Top

PUBLIC SubscribeParentFormDestroyed ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Subscribes the ParentFormDestroyed event
Notes:

Top

PROTECTED SubscribeUserControlEvents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Allows for custom event subscriptions during OnLoad()
Notes: Intended to be overridden in the inheriting user control

Top

PRIVATE ultraTree1_AfterCollapse (Object, NodeEventArgs)

Purpose: Event handler for the AfterCollapse event of the ultraTree1
Notes:

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

PRIVATE ultraTree1_AfterExpand (Object, NodeEventArgs)

Purpose: Event handler for the AfterExpand event of the ultraTree1
Notes:

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

PRIVATE ultraTree1_AfterSelect (Object, SelectEventArgs)

Purpose:
Notes:

Parameters:
sender System.Object
: System.Object
e Infragistics.Win.UltraWinTree.SelectEventArgs
: Infragistics.Win.UltraWinTree.SelectEventArgs


Constructor Detail
Top

PUBLIC ObjectMasterTreeControl ()

Purpose: Constructor for the ObjectMasterTreeControl class
Notes:



Event Detail
Top

PUBLIC NodeCollapsed (Object, NodeEventArgs)

Purpose: Raised when a Node is Collapsed
Notes:

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

PUBLIC NodeExpanded (Object, NodeEventArgs)

Purpose: Raised when a Node is Expanded
Notes:

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

PUBLIC NodeSelected (Object, SelectEventArgs)

Purpose: Raised when a Node is Selected
Notes:

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

PUBLIC TreeUpdated DELEGATE System.EventHandler

Purpose: Raised when the tree is updated
Notes:

Delegate: System.EventHandler


Property Detail
Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTreeNode ActiveNode


Returns Infragistics.Win.UltraWinTree.UltraTreeNode
Top

PUBLIC HANDLE DatasetHandle


Returns HANDLE
Top

PROTECTED CHARACTER DesignerVerbs

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PROTECTED CHARACTER NonBrowsableProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PUBLIC Consultingwerk.Windows.Framework.Repository.MergeUtil.TreePurposeEnum Purpose


Returns Consultingwerk.Windows.Framework.Repository.MergeUtil.TreePurposeEnum
Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTree TreeControl


Returns Infragistics.Win.UltraWinTree.UltraTree
Top

PROTECTED LOGICAL UserControlEventsSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL


Temp-Table Detail


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:21:16