Namespace: Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester
Class 
OERABusinessEntityTesterUserControl Copy to Clipboard
Parent classes:
Progress.Windows.UserControl
Consultingwerk.SmartComponents.Base.SmartUserControl
Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.OERABusinessEntityTesterUserControl

Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: IHasDesignerVerbs


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



Top Method Summary
Options Name Purpose
AfterCheckHandler (Object, TreeViewEventArgs) Event handler for the AfterCheck event of the tree
AfterSelectHandler (Object, TreeViewEventArgs) Event handle for the AfterSelect event of the tree
LOGICAL AtLeastOneNodeChecked (TreeNodeCollection) Recursively go through all nodes and return True if at least one if checked
CreateGridContextMenu () Creates the context menu of the data grid
DisposeTableIndexStats () Disposes the User Table and Index Statistics
FetchBatch (character) Fetches the next/previous/first/last Batch
FetchDataFromBackend (character) Get the BusinessEntity Data from Backend
FetchEntity (character) Get an empty ProDataset from a Backend business entity and populates the Tree View
FetchEntityFromBackend (character) Get an empty ProDataset from a Backend business entity
FillTreeViewWithTableNames () Walk through the Dataset TopBuffers and add all of them with their childs to the TreeView
FormShownHandler (Object, EventArgs) Event handler for the Shown event of the parent form
GetSelectedTables (character, character, integer) Returns the list of selected tables
CHARACTER GetSelectedTopBuffer (character, character) Returns the first selected table to display in DataView and builds a list of all selected child tables from the given selected node
GridContextMenuOpeningHandler (Object, CancelEventArgs) Event handler for the Opening event of the data grid's context menu
GridControlAddedHandler (Object, ControlEventArgs) Event handler for the ControlAdded event of the data grid
LOGICAL HasCurrentRecord () Returns if the data grid currently contains at least one record
InitializeComponent ()
InitializeTableIndexStats () Initializes the Table and Index Statistics
LaunchAdapter () Creates the BusinessEntityAdapter instance
NewFetchDataRequestHandler (Object, NewFetchDataRequestEventArgs) Event handler for the NewFetchDataRequest event of the SmartBusinessEntityAdapter instance
NodeMouseClickHandler (Object, TreeNodeMouseClickEventArgs) Switches the view to the table which is selected. Checks whether the table is checked (data available).
OnLoad (EventArgs) Raises the Load event
Consultingwerk.SmartUnit.OERA.RetrieveDataScenario.IScenario OpenScenario (character) Opens a scenario file
ProcessJsonQueryString (IFetchDataRequest) Processes a JSON String in the FetchDataRequest:Queries
ProcessNamedQueryParameter (NamedQueryParameter, JsonObject) Process a single Named Query Parameter from the Json Object
System.Windows.Forms.TreeNode RecurseDatasetRelations (handle, handle, TreeNode) Add the DatasetRelations recursively to the tree
LOGICAL RecurseFindTreeNodeName (character, TreeNodeCollection) Find a TreeNode by Name
CHARACTER RecurseTreeNodeNames (TreeNodeCollection) Builds a list of all selected child tables from the given selected node
CHARACTER RecurseTreeNodeQueries (TreeNodeCollection) Build a list of all Queries stored in the Tag property of the TreeNodes
System.Windows.Forms.TreeNode RecurseTreeNodes (TreeNodeCollection) Returns the first selected table to display in DataView
RefreshGridBindingSource () Refreshes the BindingSource of the data grid
RemoveFilter () Removes the filter from a table.
RetrieveTableIndexStats () Retrieves the current values for the Table and Index Statistics
SaveScenario (character) Saves the current settings as a .scenario file
SelectAll () Selects all Tree nodes
SelectNodes (TreeNodeCollection, logical) Selects or deselects all Tree nodes
SelectNone () Deselects all Tree nodes
SetUpdateRecordToolState () Enables or disables the "UpdateRecord" tool of the hosting form
ShowDataSourceQueryInfo () Shows information about the Data source query strings from the previous request
ShowFilterDialog () Show the Filter Dialog and apply the settings
ShowTableAndIndexStatistics () Display's Table and Index Statistics
ShutDownBusinessEntities () Shuts down all locally running Business Entity instances using the service adapter
TreeViewMouseDownHandler (Object, MouseEventArgs) Event handler for the MouseDown event of the Tree View
UpdateBatchContext () Updates the BatchContext on the Toolbar/Ribbon
UpdateRecord () Opens the modal update dialog for the currently selected table
UpdateRecordMenuItemClickHandler (Object, EventArgs) Event handler for the Click event of the "Update Record" context menu entry of the data grid

Top Constructor Summary
Options Name Purpose
OERABusinessEntityTesterUserControl () Initialize a new instance of the Class and subscribe to events.

Top Property Summary
Options Name Purpose
INTEGER BatchSize
CHARACTER CustomContext
LONGCHAR CustomParameterObject
CHARACTER EntityName
System.Windows.Forms.ImageList ImageList
LOGICAL InitializeUserTableStatsOnShown
Progress.Json.ObjectModel.JsonConstruct JsonFilter
Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.IOERABusinessEntityTesterForm OERABusinessEntityTesterForm
CHARACTER StatusBarText
LOGICAL StatusBarVisible
INTEGER StopAfter
System.Windows.Forms.ContextMenuStrip TreeContextMenuStrip
System.Windows.Forms.TreeView TreeView


Method Detail
Top

AfterCheckHandler (Object, TreeViewEventArgs)
Purpose: Event handler for the AfterCheck event of the tree
Notes: Change settings after a table has been de-/selected

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

AfterSelectHandler (Object, TreeViewEventArgs)
Purpose: Event handle for the AfterSelect event of the tree
Notes: Set the Filter tools en-/disabled

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

LOGICAL AtLeastOneNodeChecked (TreeNodeCollection)
Purpose: Recursively go through all nodes and return True if at least one if
checked
Notes:

Parameters:
poNodes System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection to verify
Returns LOGICAL
Logical value indicating if at least one node was changed
Top

CreateGridContextMenu ()
Purpose: Creates the context menu of the data grid
Notes: Provides the "Update Record" entry which is only enabled when
the data grid currently contains a row (SCL-5397)

Top

DisposeTableIndexStats ()
Purpose: Disposes the User Table and Index Statistics
Notes:

Top

FetchBatch (character)
Purpose: Fetches the next/previous/first/last Batch
Notes:

Parameters:
pcBatch CHARACTER
Character Value NextBatch, PrevBatch, FirstBatch or LastBatch
Top

FetchDataFromBackend (character)
Purpose: Get the BusinessEntity Data from Backend
Notes: Only the first ChildTable is Joined at the moment.

Parameters:
pcEntityName CHARACTER
The name of the business entity to retrieve data from
Top

FetchEntity (character)
Purpose: Get an empty ProDataset from a Backend business entity and populates
the Tree View
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
Top

FetchEntityFromBackend (character)
Purpose: Get an empty ProDataset from a Backend business entity
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
Top

FillTreeViewWithTableNames ()
Purpose: Walk through the Dataset TopBuffers and add all of them with their
childs to the TreeView
Notes:

Top

FormShownHandler (Object, EventArgs)
Purpose: Event handler for the Shown event of the parent form
Notes:

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

GetSelectedTables (character, character, integer)
Purpose: Returns the list of selected tables
Notes:

Parameters:
pcTables CHARACTER
OUTPUT The comma delimited list of tables
pcQueryStrings CHARACTER
OUTPUT The CHR(1) delimited list of query strings
piNumResults INTEGER
OUTPUT The number of result records
Top

CHARACTER GetSelectedTopBuffer (character, character)
Purpose: Returns the first selected table to display in DataView and builds
a list of all selected child tables from the given selected node
Notes: Returns the name of the SelectedTopBuffer with a list of checked
nodes or returns the TreeNode object of the SelectedTopBuffer

Parameters:
cCheckedNodes CHARACTER
OUTPUT Comma delimited list of checked node text
cQueryStrings CHARACTER
OUTPUT Delimited list of query strings of the selected nodes
Returns CHARACTER
The name of the topmost selected buffer
Top

GridContextMenuOpeningHandler (Object, CancelEventArgs)
Purpose: Event handler for the Opening event of the data grid's context
menu
Notes: Enables the "Update Record" entry only when the data grid
currently contains a row

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

GridControlAddedHandler (Object, ControlEventArgs)
Purpose: Event handler for the ControlAdded event of the data grid
Notes: Assigns the grid's context menu to the TextBox controls hosted
by the DataGrid for its cells, which would otherwise show the
standard TextBox context menu instead of ours

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

LOGICAL HasCurrentRecord ()
Purpose: Returns if the data grid currently contains at least one record
Notes: Used to determine if the "Update Record" actions are enabled

Returns LOGICAL
Logical value indicating if the data grid contains a record
Top

InitializeComponent ()

Top

InitializeTableIndexStats ()
Purpose: Initializes the Table and Index Statistics
Notes:

Top

LaunchAdapter ()
Purpose: Creates the BusinessEntityAdapter instance
Notes: Ability to specify a different SmartBusinessEntityAdapter derived
class for the data adapter using -param Adapter=.....

Top

NewFetchDataRequestHandler (Object, NewFetchDataRequestEventArgs)
Purpose: Event handler for the NewFetchDataRequest event of the
SmartBusinessEntityAdapter instance
Notes: Assigns a DataSourceQueryInfo instance to the CustomParameter
property of the IFechtDataRequest instance

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Implementation.NewFetchDataRequestEventArgs
The NewFetchDataRequestEventArgs with the data for this event
Top

NodeMouseClickHandler (Object, TreeNodeMouseClickEventArgs)
Purpose: Switches the view to the table which is selected. Checks whether the
table is checked (data available).
Notes:

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

OnLoad (EventArgs)
Purpose: Raises the Load event
Notes:

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

Consultingwerk.SmartUnit.OERA.RetrieveDataScenario.IScenario OpenScenario (character)
Purpose: Opens a scenario file
Notes:

Parameters:
pcFileName CHARACTER
The name of the file to open
Returns Consultingwerk.SmartUnit.OERA.RetrieveDataScenario.IScenario
The loaded scenario instance
Top

ProcessJsonQueryString (IFetchDataRequest)
Purpose: Processes a JSON String in the FetchDataRequest:Queries
Notes:

Parameters:
poRequest Consultingwerk.OERA.IFetchDataRequest
The FetchDataRequest instance
Top

ProcessNamedQueryParameter (NamedQueryParameter, JsonObject)
Purpose: Process a single Named Query Parameter from the Json Object
Notes:

Parameters:
poNamedQuery Consultingwerk.OERA.NamedQueryParameter
The Named Query Parameter to add a parameter to
poJson Progress.Json.ObjectModel.JsonObject
The Json Object representing the parameter
Top

System.Windows.Forms.TreeNode RecurseDatasetRelations (handle, handle, TreeNode)
Purpose: Add the DatasetRelations recursively to the tree
Notes:

Parameters:
phDataHandle HANDLE
The handle of the ProDataset
phBuffer HANDLE
The current iteration of the parent buffer
poParentTreeNode System.Windows.Forms.TreeNode
The current parent tree node
Returns System.Windows.Forms.TreeNode
The tree node for the current buffer
Top

LOGICAL RecurseFindTreeNodeName (character, TreeNodeCollection)
Purpose: Find a TreeNode by Name
Notes: Returns TRUE if found

Parameters:
cFindTreeNodeName CHARACTER
The name of the tree node to find
oNodeCollection System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection
Returns LOGICAL
Logical value indicating if the node name was found
Top

CHARACTER RecurseTreeNodeNames (TreeNodeCollection)
Purpose: Builds a list of all selected child tables from the given selected
node
Notes:

Parameters:
oNodeCollection System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection
Returns CHARACTER
The comma delimited list of child table names
Top

CHARACTER RecurseTreeNodeQueries (TreeNodeCollection)
Purpose: Build a list of all Queries stored in the Tag property of the
TreeNodes
Notes:

Parameters:
oNodeCollection System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection
Returns CHARACTER
The CHR(1) delimited list of query strings
Top

System.Windows.Forms.TreeNode RecurseTreeNodes (TreeNodeCollection)
Purpose: Returns the first selected table to display in DataView
Notes:

Parameters:
oNodeCollection System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection
Returns System.Windows.Forms.TreeNode
The reference to the first selected TreeNode
Top

RefreshGridBindingSource ()
Purpose: Refreshes the BindingSource of the data grid
Notes: Re-opens the query, e.g. after the update dialog was closed and
records may have been added, changed or deleted

Top

RemoveFilter ()
Purpose: Removes the filter from a table.
Notes:

Top

RetrieveTableIndexStats ()
Purpose: Retrieves the current values for the Table and
Index Statistics
Notes:

Top

SaveScenario (character)
Purpose: Saves the current settings as a .scenario file
Notes:

Parameters:
pcFileName CHARACTER
The file name to save the scenario as
Top

SelectAll ()
Purpose: Selects all Tree nodes
Notes:

Top

SelectNodes (TreeNodeCollection, logical)
Purpose: Selects or deselects all Tree nodes
Notes:

Parameters:
poNodes System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection
plSelected LOGICAL
Logical value indicating if the tree nodes should be selected or not
Top

SelectNone ()
Purpose: Deselects all Tree nodes
Notes:

Top

SetUpdateRecordToolState ()
Purpose: Enables or disables the "UpdateRecord" tool of the hosting form
Notes: The tool is only enabled when the data grid currently contains
a row (SCL-5397)

Top

ShowDataSourceQueryInfo ()
Purpose: Shows information about the Data source query strings from the previous
request
Notes:

Top

ShowFilterDialog ()
Purpose: Show the Filter Dialog and apply the settings
Notes:

Top

ShowTableAndIndexStatistics ()
Purpose: Display's Table and Index Statistics
Notes:

Top

ShutDownBusinessEntities ()
Purpose: Shuts down all locally running Business Entity instances using
the service adapter
Notes: Assumption is, that the Business Entity Tester is running the
Business Entities locally. Otherwise this will need to be implemented
as a call to the AppServer(s)

Top

TreeViewMouseDownHandler (Object, MouseEventArgs)
Purpose: Event handler for the MouseDown event of the Tree View
Notes: Enable/Disable the Remove Filter context-menu item when the user
right clicks on the tree view - before the context menu is opened

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

UpdateBatchContext ()
Purpose: Updates the BatchContext on the Toolbar/Ribbon
Notes:

Top

UpdateRecord ()
Purpose: Opens the modal update dialog for the currently selected table
Notes: When the currently selected table is the EntityTable of the
Business Entity Tester's adapter, that adapter instance is used
directly (sharing the already fetched ProDataset). For any other
table a dedicated adapter is created that fetches the records of
that table from the Business Entity.
When an IAuthenticationService is registered and no user is
logged in yet, the SmartFramework login dialog is shown first,
as updates through the backend typically require an
authenticated user (SCL-5397)

Top

UpdateRecordMenuItemClickHandler (Object, EventArgs)
Purpose: Event handler for the Click event of the "Update Record" context
menu entry of the data grid
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


Constructor Detail
Top

OERABusinessEntityTesterUserControl ()
Purpose: Initialize a new instance of the Class and subscribe to events.
Notes:



Property Detail
Top

INTEGER BatchSize

Returns INTEGER
Top

CHARACTER CustomContext

Returns CHARACTER
Top

LONGCHAR CustomParameterObject

Returns LONGCHAR
Top

CHARACTER EntityName

Returns CHARACTER
Top

System.Windows.Forms.ImageList ImageList

Returns System.Windows.Forms.ImageList
Top

LOGICAL InitializeUserTableStatsOnShown

Returns LOGICAL
Top

Progress.Json.ObjectModel.JsonConstruct JsonFilter

Returns Progress.Json.ObjectModel.JsonConstruct
Top

Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.IOERABusinessEntityTesterForm OERABusinessEntityTesterForm

Returns Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.IOERABusinessEntityTesterForm
Top

CHARACTER StatusBarText

Returns CHARACTER
Top

LOGICAL StatusBarVisible

Returns LOGICAL
Top

INTEGER StopAfter

Returns INTEGER
Top

System.Windows.Forms.ContextMenuStrip TreeContextMenuStrip

Returns System.Windows.Forms.ContextMenuStrip
Top

System.Windows.Forms.TreeView TreeView

Returns System.Windows.Forms.TreeView


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       20.07.2026 16:05:15