Namespace: Consultingwerk.Windows.Framework.Repository.Rendering
Class 
TreeViewViewerBindingHandler Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Windows.Framework.Repository.Rendering.TreeViewViewerBindingHandler

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Windows.Controls.IDynamicTreeViewRootNodeFilterProvider


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AfterCancelUpdateHandler (Object, EventArgs) Event handler for the AfterCancelUpdate event of the viewer
AfterSaveChangesHandler (Object, EventArgs) Event handler for the AfterSaveChanges event of the viewer
BeforeSaveChangesHandler (Object, CancelEventArgs) Event handler for the BeforeSaveChanges event of the viewer
CHARACTER BuildRootNodeFilter () Builds the root node filter for the current record of the viewer's data source
LOGICAL CanEditNodes () Returns if the user may edit the node cells now
CurrentChangedHandler (Object, EventArgs) Event handler for the CurrentChanged event of the viewer
LOGICAL DataSourceReady () Returns if the viewer's data source is ready to provide the field values of its current record
FieldsDisabledHandler (Object, EventArgs) Event handler for the FieldsDisabled event of the viewer
FieldsEnabledHandler (Object, EventArgs) Event handler for the FieldsEnabled event of the viewer
CHARACTER GetRootNodeFilter () Returns the root node filter to repeat the root node fetch of the tree view with
LoadHandler (Object, EventArgs) Event handler for the Load event of the tree view control
RefreshTree () Populates the tree with the root node matching the current record of the viewer's data source
TreeNodeCheckedHandler (Object, TreeNodeCheckedEventArgs) Event handler for the TreeNodeChecked and TreeNodeUnchecked events of the tree view control
TreeNodeValueChangedHandler (Object, TreeNodeValueChangedEventArgs) Event handler for the TreeNodeValueChanged event of the tree view control

Top Constructor Summary
Options Name Purpose
TreeViewViewerBindingHandler (SmartViewerControl, DynamicTreeViewControl, character, character, character) Constructor for the TreeViewViewerBindingHandler class
TreeViewViewerBindingHandler (SmartViewerControl, DynamicTreeViewControl, character, character, character, logical) Constructor for the TreeViewViewerBindingHandler class


Method Detail
Top

AfterCancelUpdateHandler (Object, EventArgs)
Purpose: Event handler for the AfterCancelUpdate event of the viewer
Notes: SCL-5849. The viewer's Cancel discards the node changes

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

AfterSaveChangesHandler (Object, EventArgs)
Purpose: Event handler for the AfterSaveChanges event of the viewer
Notes: SCL-5849. The record has been saved - now the changed nodes are
saved through the tree node provider (record first). When that
fails, the error is shown, the node changes stay pending and the
viewer is put back into the modifying state, so the user can
correct the nodes and save again (the record then has no changes
and only the nodes are sent)

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

BeforeSaveChangesHandler (Object, CancelEventArgs)
Purpose: Event handler for the BeforeSaveChanges event of the viewer
Notes: SCL-5849. A toolbar click does not take the focus from the
tree - the value of the cell in edit mode is taken over into
its node before the viewer saves

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

CHARACTER BuildRootNodeFilter ()
Purpose: Builds the root node filter for the current record of the
viewer's data source
Notes: The values of the RootNodeFilterFields fields replace the
&1 .. &9 placeholders of the RootNodeFilter template. Without
a template the field values are returned as a JSON object;
without filter fields the RootNodeFilter value is returned
verbatim

Returns CHARACTER
The root node filter to pass to ISmartTreeNodeProvider:GetRootNode
Top

LOGICAL CanEditNodes ()
Purpose: Returns if the user may edit the node cells now
Notes: SCL-5849. While the viewer's fields are enabled - but not while
adding or copying a record: the new record has no key yet, so
the tree holds no nodes belonging to it

Returns LOGICAL
Logical value indicating if the node cells can be edited
Top

CurrentChangedHandler (Object, EventArgs)
Purpose: Event handler for the CurrentChanged event of the viewer
Notes: Rebuilds the root node filter from the now current record and
refreshes the tree when the filter changed

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

LOGICAL DataSourceReady ()
Purpose: Returns if the viewer's data source is ready to provide the
field values of its current record
Notes: The Available property returns the unknown value while the
data source's binding source is not yet initialized (e.g. when
the tree view control loads before the initial data retrieval),
so only a definite TRUE counts as ready. A SmartDatasetAdapter
additionally reads the field values through its query, which
may not have been created yet at that point

Returns LOGICAL
Logical value indicating if the field values can be read
Top

FieldsDisabledHandler (Object, EventArgs)
Purpose: Event handler for the FieldsDisabled event of the viewer
Notes: SCL-5833. The viewer left update mode - the check boxes only
display the CheckedNodes value again. SCL-5849: the node cells
are no longer editable

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

FieldsEnabledHandler (Object, EventArgs)
Purpose: Event handler for the FieldsEnabled event of the viewer
Notes: SCL-5833. The viewer entered update mode - the user may check
and uncheck nodes now. SCL-5849: and edit the node cells, unless
the viewer adds or copies a record

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

CHARACTER GetRootNodeFilter ()
Purpose: Returns the root node filter to repeat the root node fetch of
the tree view with
Notes: SCL-5861. Invoked by DynamicTreeViewControl:RefreshTree, so that
a refresh triggered by a RefreshTreeViewUiAction uses the filter
of the record that is current at that moment rather than the one
the tree happens to have been populated with. Keeps the
bookkeeping of RefreshTree (this class) in sync, as the control
repopulates itself with the returned filter without going
through it

Returns CHARACTER
The root node filter to pass to ISmartTreeNodeProvider:GetRootNode
Top

LoadHandler (Object, EventArgs)
Purpose: Event handler for the Load event of the tree view control
Notes: Performs the initial population of the tree

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

RefreshTree ()
Purpose: Populates the tree with the root node matching the current
record of the viewer's data source
Notes: Does nothing before the tree view control has been loaded and
when the root node filter did not change since the previous
population. Clears the tree when filter fields are configured
and no record is available

Top

TreeNodeCheckedHandler (Object, TreeNodeCheckedEventArgs)
Purpose: Event handler for the TreeNodeChecked and TreeNodeUnchecked
events of the tree view control
Notes: SCL-5833. Checking a node changes the field the CheckedNodes
value is bound to, so the viewer is put into the modifying
state - the way a custom event handler changing a viewer value
does - which enables Save and starts the update on the data
source

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.Windows.Controls.TreeNodeCheckedEventArgs
The TreeNodeCheckedEventArgs with the data for this event
Top

TreeNodeValueChangedHandler (Object, TreeNodeValueChangedEventArgs)
Purpose: Event handler for the TreeNodeValueChanged event of the tree
view control
Notes: SCL-5849. Changing a node value puts the viewer into the
modifying state, which enables Save and starts the update on
the data source

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.Windows.Controls.TreeNodeValueChangedEventArgs
The TreeNodeValueChangedEventArgs with the data for this event


Constructor Detail
Top

TreeViewViewerBindingHandler (SmartViewerControl, DynamicTreeViewControl, character, character, character)
Purpose: Constructor for the TreeViewViewerBindingHandler class
Notes: Subscribes to the tree view control's Load event for the
initial population and - when filter fields are configured -
to the viewer's CurrentChanged event to follow the record
navigation. SCL-5833: for a tree view in checkbox mode the
check boxes follow the update mode of the viewer, and
checking a node puts the viewer into the modifying state

Parameters:
poViewer Consultingwerk.SmartComponents.Base.SmartViewerControl
The reference to the SmartViewerControl hosting the tree view
poTreeViewControl Consultingwerk.Windows.Controls.DynamicTreeViewControl
The reference to the DynamicTreeViewControl to populate
pcRootNodeType CHARACTER
The root node type to populate the tree with
pcRootNodeFilter CHARACTER
The root node filter template (&1 .. &9 placeholders)
pcRootNodeFilterFields CHARACTER
The comma-delimited list of fields of the viewer's data source providing the filter values
Top

TreeViewViewerBindingHandler (SmartViewerControl, DynamicTreeViewControl, character, character, character, logical)
Purpose: Constructor for the TreeViewViewerBindingHandler class
Notes: See the constructor without the plUseTableIOControl parameter.
SCL-5849: with plUseTableIOControl the editable node cells rely
on the Table IO of the viewer - they are editable only while
the viewer's fields are enabled (not while adding or copying a
record), the first change puts the viewer into the modifying
state, the viewer's Save saves the changed nodes after the
record (AfterSaveChanges) and its Cancel discards them

Parameters:
poViewer Consultingwerk.SmartComponents.Base.SmartViewerControl
The reference to the SmartViewerControl hosting the tree view
poTreeViewControl Consultingwerk.Windows.Controls.DynamicTreeViewControl
The reference to the DynamicTreeViewControl to populate
pcRootNodeType CHARACTER
The root node type to populate the tree with
pcRootNodeFilter CHARACTER
The root node filter template (&1 .. &9 placeholders)
pcRootNodeFilterFields CHARACTER
The comma-delimited list of fields of the viewer's data source providing the filter values
plUseTableIOControl LOGICAL
Logical value indicating if the editable node cells rely on the Table IO of the viewer (the UseTableIOControl attribute)


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:38:51