Namespace: Consultingwerk.SmartComponents.Base
Class 
SmartGridUiControlHandler Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartComponents.Base.SmartUiControlHandlerBase
Consultingwerk.SmartComponents.Base.SmartGridUiControlHandler

Inherits: Consultingwerk.SmartComponents.Base.SmartUiControlHandlerBase


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



Top Method Summary
Options Name Purpose
ActivateCell (character) Activates the cell of the column event row in the column identified by the field name and enters edit mode
ApplyCellFieldControls (UiControl) Applies the FieldControls of the UiControl to the cells of the column event row
LOGICAL ApplyReturnedRows (handle, handle) Copies the rows returned by the server-side event handler back into the records of the data source
ApplyRowValues (handle) Writes the field values returned by the server-side event handler to the cells of the column event row
AssignActiveRowKeys () Stores the row keys of the current record of the data source per buffer (EntityTable, EntityView)
AssignRowValuesToScreenValues (handle) Assigns the current cell values of the column event row to the screen values dataset
AssignScreenValuesProperties (EventHandlerParameter) Assigns the SelectedRowCount and the ActiveRowKey of the EventHandlerParameter
System.Windows.Forms.Form FindForm () Finds the form associated with the control
Infragistics.Win.UltraWinGrid.UltraGridCell GetColumnEventCell (character) Returns the cell of the column event row in the column identified by the field name
INTEGER GetCurrentRowCount () Returns the number of rows sent when only the current record is sent
Consultingwerk.SmartComponents.Base.SmartDatasetAdapter GetDatasource () Gets the datasource associated with the grid
Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget GetDefaultTableIOTarget () Returns the TableIO target of a SetTableIoActionDisabledUiAction without a TargetInstanceName
Infragistics.Win.UltraWinGrid.UltraGridColumn GetGridColumn (character) Returns the grid column identified by the given field name
HANDLE GetScreenValueField (handle, character) Returns the buffer field of the screen values dataset bound to a grid column
HANDLE GetScreenValuesDataset () Returns a ProDataset with the current screen values
HANDLE GetSelectedRowsDataset () Returns a ProDataset with the selected rows of the grid
System.Windows.Forms.Control GetViewerField (character) Retrieves the control associated with the field
HandleCancelEvent (Object, logical) Handles cancel event by setting Cancel flag on event arguments
HandleUiControl (UiControl, handle, Object) Applies UiControl changes to the grid
LOGICAL IsColumnEvent () Returns if the handler processes a field event of a grid column
PositionScreenValues (handle) Positions the buffers (EntityTable, EntityView) of the screen values dataset on the active row
RefreshSelectedRows (SmartDatasetAdapter) Refreshes the values displayed in the selected rows of the grid
ShowMessages (ListValidationMessage) Shows the messages
TableIoAction (TableIoUiAction, Object) Handles TableIoUiActions

Top Constructor Summary
Options Name Purpose
SmartGridUiControlHandler (SmartDataBrowser) Constructor for the SmartGridUiControlHandler class

Top Property Summary
Options Name Purpose
Infragistics.Win.UltraWinGrid.UltraGridColumn ColumnEventColumn
Infragistics.Win.UltraWinGrid.UltraGridRow ColumnEventRow
System.Object ColumnEventStartValue
Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl SmartToolbarControl


Method Detail
Top

ActivateCell (character)
Purpose: Activates the cell of the column event row in the column identified
by the field name and enters edit mode
Notes: SCL-6074

Parameters:
pcFieldName CHARACTER
The name of the field identifying the grid column
Top

ApplyCellFieldControls (UiControl)
Purpose: Applies the FieldControls of the UiControl to the cells of the
column event row
Notes: SCL-6074. Enabled applies to the cell of the row (Enabled cannot
enable a cell of a column that is disabled itself), Style and
Mandatory assign the AppStylist resource of the cell appearance (the
resource "mandatory" for Mandatory), the value list properties assign
the value list of the cell. Width, Label and Visible apply to the
column (SCL-6099), see HandleUiControl. SCL-6177: LookupButtonEnabled
and LookupButtonVisible apply to the lookup editor of the column

Parameters:
poUiControl Consultingwerk.CommonUi.UiControl
The UiControl with the FieldControls
Top

LOGICAL ApplyReturnedRows (handle, handle)
Purpose: Copies the rows returned by the server-side event handler back
into the records of the data source
Notes: SCL-6076 / SCL-6087. A single returned row is copied into the
current record (the source buffer is positioned on it). With
several rows (selected rows) each row is copied into the record
with the same primary unique key: the row of the current record
through the source buffer, the other rows through a separate
buffer so the data source keeps its position. Rows of a table
without a primary unique index cannot be assigned to records and
are ignored, as are rows created or deleted by the handler.
Unchanged records are not touched

Parameters:
phBuffer HANDLE
The buffer of the returned screen values dataset
phSourceBuffer HANDLE
The buffer of the data source, positioned on the current record
Returns LOGICAL
Logical value indicating if records other than the current record were changed
Top

ApplyRowValues (handle)
Purpose: Writes the field values returned by the server-side event handler to
the cells of the column event row
Notes: SCL-6074. Only cells whose value differs are written. The cell that is
in edit mode receives the value through its editor

Parameters:
phDataset HANDLE
The handle of the dataset with the screen values
Top

AssignActiveRowKeys ()
Purpose: Stores the row keys of the current record of the data source per
buffer (EntityTable, EntityView)
Notes: SCL-6087. Used for the ActiveRowKey of the EventHandlerParameter
and to position the screen values dataset on the active row.
Buffers of tables without a primary unique index have no key

Top

AssignRowValuesToScreenValues (handle)
Purpose: Assigns the current cell values of the column event row to the
screen values dataset
Notes: SCL-6074. Includes the value of the cell in edit mode. Cells whose
edited text cannot be converted are skipped

Parameters:
phScreenValues HANDLE
The handle of the dataset with the screen values
Top

AssignScreenValuesProperties (EventHandlerParameter)
Purpose: Assigns the SelectedRowCount and the ActiveRowKey of the
EventHandlerParameter
Notes: SCL-6087 - from the values stored by GetScreenValuesDataset

Parameters:
poParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter to assign the properties of
Top

System.Windows.Forms.Form FindForm ()
Purpose: Finds the form associated with the control
Notes:

Returns System.Windows.Forms.Form
The form associated with the control
Top

Infragistics.Win.UltraWinGrid.UltraGridCell GetColumnEventCell (character)
Purpose: Returns the cell of the column event row in the column identified by
the field name
Notes: SCL-6074

Parameters:
pcFieldName CHARACTER
The name of the field identifying the grid column
Returns Infragistics.Win.UltraWinGrid.UltraGridCell
The UltraGridCell or ? when the column does not exist or no column event is handled
Top

INTEGER GetCurrentRowCount ()
Purpose: Returns the number of rows sent when only the current record is
sent
Notes: SCL-6087 - 1 when the data source has a current record, 0 otherwise

Returns INTEGER
The number of rows
Top

Consultingwerk.SmartComponents.Base.SmartDatasetAdapter GetDatasource ()
Purpose: Gets the datasource associated with the grid
Notes:

Returns Consultingwerk.SmartComponents.Base.SmartDatasetAdapter
The datasource associated with the grid
Top

Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget GetDefaultTableIOTarget ()
Purpose: Returns the TableIO target of a SetTableIoActionDisabledUiAction
without a TargetInstanceName
Notes: SCL-6176. The grid of this handler when it is a TableIO target
(updatable grid), otherwise the active TableIO target of the toolbar

Returns Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
The ISmartTableIOTarget or ? when there is none
Top

Infragistics.Win.UltraWinGrid.UltraGridColumn GetGridColumn (character)
Purpose: Returns the grid column identified by the given field name
Notes: SCL-5418 - supports both unqualified field names (e.g. Name) and
qualified field names (e.g. Customer.Name). Qualified names are
matched against a band with the matching key or the Table:Field
column key used for joined/view fields. Returns ? when no
matching column exists

Parameters:
pcFieldName CHARACTER
The name of the field identifying the grid column
Returns Infragistics.Win.UltraWinGrid.UltraGridColumn
The UltraGridColumn identified by the field name or ?
Top

HANDLE GetScreenValueField (handle, character)
Purpose: Returns the buffer field of the screen values dataset bound to a grid
column
Notes: SCL-6074. The column key is the field name of the EntityTable or
<table>:<field> <field> for a field of another table (e.g. the EntityView).
Without a SmartDatasetAdapter the key of the band of the row names the
table

Parameters:
phDataset HANDLE
The handle of the dataset with the screen values
pcColumnKey CHARACTER
The key of the grid column
Returns HANDLE
The handle of the buffer field or ? when the column is not bound to a field of an available record
Top

HANDLE GetScreenValuesDataset ()
Purpose: Returns a ProDataset with the current screen values
Notes: SCL-6074. For a field event of a grid column the current cell values
of the row (including the value of the cell in edit mode) replace the
values of the current record of the data source
SCL-6087. With more than one selected row the dataset carries one
row per selected grid row instead of the current record only
(unless a record is being added), the buffers are positioned on
the active row. Stores the SelectedRowCount and the row keys of
the active row for AssignScreenValuesProperties and for writing
the returned rows back

Returns HANDLE
The handle of the ProDataset
Top

HANDLE GetSelectedRowsDataset ()
Purpose: Returns a ProDataset with the selected rows of the grid
Notes: SCL-6087. Returns ? when less than two rows are selected, a record
is being added (the new record is sent alone) or the selected
rows cannot be located by their primary unique key (see
UltraGridSelectedRowsHelper:CopySelectedRowsToProDatasetByKey) CopySelectedRowsToProDatasetByKey) -
the current record is sent then. The position of the data source
is not changed. Change tracking is active on the returned dataset

Returns HANDLE
The handle of the ProDataset with the selected rows or ?
Top

System.Windows.Forms.Control GetViewerField (character)
Purpose: Retrieves the control associated with the field
Notes: SCL-6074. Returns the editor component (e.g. the
SmartBusinessEntityLookup) of the grid column identified by the field
name, so that an UpdateLookupDefinitionUiAction can change the lookup
definition of a lookup column. The editor component is shared by all
rows of the column. Returns ? for columns without an editor control

Parameters:
pcFieldName CHARACTER
The name of the field
Returns System.Windows.Forms.Control
The control associated with the field
Top

HandleCancelEvent (Object, logical)
Purpose: Handles cancel event by setting Cancel flag on event arguments
Notes: SCL-6074. A cancelled Leave event of a grid column restores the value
of the cell when it entered edit mode and activates the cell again

Parameters:
e Progress.Lang.Object
The event arguments
plCancel LOGICAL
The cancel flag
Top

HandleUiControl (UiControl, handle, Object)
Purpose: Applies UiControl changes to the grid
Notes:

Parameters:
poUiControl Consultingwerk.CommonUi.UiControl
The UiControl with changes to apply
phDataset HANDLE
The dataset with screen values
sender Progress.Lang.Object
The sender of the event
Top

LOGICAL IsColumnEvent ()
Purpose: Returns if the handler processes a field event of a grid column
Notes: SCL-6074

Returns LOGICAL
Logical value indicating if a column event is handled
Top

PositionScreenValues (handle)
Purpose: Positions the buffers (EntityTable, EntityView) of the screen
values dataset on the active row
Notes: SCL-6087. With several rows the row with the key of the current
record, otherwise (and when the key is not found) the first row

Parameters:
phDataset HANDLE
The handle of the dataset with the screen values
Top

RefreshSelectedRows (SmartDatasetAdapter)
Purpose: Refreshes the values displayed in the selected rows of the grid
Notes: SCL-6087 - after the rows returned by the server-side event
handler were written back into the records of the data source.
Refreshes the rows one by one (BindingSource:Refresh with the
1-based index in the query result), RefreshAll would move the
data source to the first record

Parameters:
poDataSource Consultingwerk.SmartComponents.Base.SmartDatasetAdapter
The data source of the grid
Top

ShowMessages (ListValidationMessage)
Purpose: Shows the messages
Notes: SCL-6074. For a field event of a grid column the cell of the first
message with a field name is activated instead of focusing a control

Parameters:
poMessages Consultingwerk.OERA.ValidationMessages.ListValidationMessage
The list of messages
Top

TableIoAction (TableIoUiAction, Object)
Purpose: Handles TableIoUiActions
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.TableIoUiAction
The TableIoUiAction to handle
sender Progress.Lang.Object
The sender of the event


Constructor Detail
Top

SmartGridUiControlHandler (SmartDataBrowser)
Purpose: Constructor for the SmartGridUiControlHandler class
Notes:

Parameters:
poGrid Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
The reference to the SmartDataBrowser instance


Property Detail
Top

Infragistics.Win.UltraWinGrid.UltraGridColumn ColumnEventColumn

Returns Infragistics.Win.UltraWinGrid.UltraGridColumn
Top

Infragistics.Win.UltraWinGrid.UltraGridRow ColumnEventRow

Returns Infragistics.Win.UltraWinGrid.UltraGridRow
Top

System.Object ColumnEventStartValue

Returns System.Object
Top

Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
Top

Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl SmartToolbarControl

Returns Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:06:56