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

Inherits: Consultingwerk.SmartComponents.Base.SmartUiControlHandlerBase


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



Top Method Summary
Options Name Purpose
AfterCancelledUpdateHandler (Object, AfterCancelledUpdateEventArgs) Event handler for the AfterCancelledUpdate event of the SmartViewerControl
AfterSaveChangesHandler (Object, EventArgs) Event handler for the AfterSaveChanges event of the SmartViewerControl
ApplyLookupButtonState (SmartBusinessEntityLookup, FieldControl) Applies the LookupButtonEnabled and LookupButtonVisible of a FieldControl to a lookup field of the viewer
BeforeUpdateLookupDefinition (SmartBusinessEntityLookup) Invoked before an UpdateLookupDefinitionUiAction changes the lookup definition of a SmartBusinessEntityLookup
System.Windows.Forms.Form FindForm () Finds the form associated with the control
Consultingwerk.SmartComponents.Base.SmartDatasetAdapter GetDatasource () Gets the datasource associated with the viewer
Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget GetDefaultTableIOTarget () Returns the TableIO target of a SetTableIoActionDisabledUiAction without a TargetInstanceName
CHARACTER GetLabel (Control) Returns the current label of a control
HANDLE GetScreenValuesDataset () Returns a ProDataset with the current screen values
System.Windows.Forms.Control GetViewerField (character) Retrieves the control associated with the field
HandleUiControl (UiControl, handle, Object) Returns a ProDataset with the current screen values
ResetViewerState (logical) Resets the state of the Viewer
CHARACTER SetLabel (Control, character) Sets the label of a control
SetMandatory (Control, logical) Changes the mandatory state of a field
StoreControlStyles () Stores the StyleSetName of the controls of the viewer layout
StoreFieldStatus (handle) Stores the status of the fields
TableIoAction (TableIoUiAction, Object) Handles TableIoUiActions

Top Constructor Summary
Options Name Purpose
SmartViewerUiControlHandler (SmartViewerControl, handle) Constructor for the SmartViewerUiControlHandler class

Top Property Summary
Options Name Purpose
Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl SmartToolbarControl


Method Detail
Top

AfterCancelledUpdateHandler (Object, AfterCancelledUpdateEventArgs)
Purpose: Event handler for the AfterCancelledUpdate event of the SmartViewerControl
Notes: Resets the viewers state

Parameters:
sender System.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Base.AfterCancelledUpdateEventArgs
The AfterCancelledUpdateEventArgs with the data for this event
Top

AfterSaveChangesHandler (Object, EventArgs)
Purpose: Event handler for the AfterSaveChanges event of the SmartViewerControl
Notes: Resets the viewers state

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

ApplyLookupButtonState (SmartBusinessEntityLookup, FieldControl)
Purpose: Applies the LookupButtonEnabled and LookupButtonVisible of a
FieldControl to a lookup field of the viewer
Notes: SCL-6177. Unknown values keep the current state. The state of the
viewer layout is stored on the first change and restored by
ResetViewerState (cancel / save), like the other FieldControl
properties

Parameters:
poLookup Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityLookup
The lookup field
poFieldControl Consultingwerk.CommonUi.FieldControl
The FieldControl
Top

BeforeUpdateLookupDefinition (SmartBusinessEntityLookup)
Purpose: Invoked before an UpdateLookupDefinitionUiAction changes the
lookup definition of a SmartBusinessEntityLookup
Notes: SCL-6066. Remembers the lookup definition of the viewer layout
(before the first change) next to the other field status, so that
ResetViewerState restores it when the update is cancelled

Parameters:
poLookup Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityLookup
The SmartBusinessEntityLookup whose definition is about to change
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

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

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

Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget GetDefaultTableIOTarget ()
Purpose: Returns the TableIO target of a SetTableIoActionDisabledUiAction
without a TargetInstanceName
Notes: SCL-6176. The viewer of this handler

Returns Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
The ISmartTableIOTarget
Top

CHARACTER GetLabel (Control)
Purpose: Returns the current label of a control
Notes: SCL-6067. Without the trailing colon; ? when the control has no label

Parameters:
poControl System.Windows.Forms.Control
The control
Returns CHARACTER
The label of the control
Top

HANDLE GetScreenValuesDataset ()
Purpose: Returns a ProDataset with the current screen values
Notes: SCL-6179 - returns the unknown value for a viewer without a data
source (e.g. an unbound filter viewer). The values of its unbound
editors reach the server-side event handler through the
UnboundValues of the EventHandlerParameter

Returns HANDLE
The handle of the ProDataset or the unknown value
Top

System.Windows.Forms.Control GetViewerField (character)
Purpose: Retrieves the control associated with the field
Notes:

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

HandleUiControl (UiControl, handle, Object)
Purpose: Returns a ProDataset with the current screen values
Notes: SCL-6179 - the values of phDataset are only written back to the
bound controls when the viewer has a data source

Parameters:
poUiControl Consultingwerk.CommonUi.UiControl
The reference to the UiControl instance to process
phDataset HANDLE
The handle of the ProDataset with the screen values
sender Progress.Lang.Object
The sender of the event
Top

ResetViewerState (logical)
Purpose: Resets the state of the Viewer
Notes: Restores the state of the viewer layout changed by server-side event
handlers (FieldControl): enable mode, visibility, label (including the
mandatory suffix), value list, StyleSetName and lookup definition.
SCL-6067: the captured layout state is kept for later resets; on the
Load event (after the Initializing event handler) the current state
becomes the layout state

Parameters:
plLoadEvent LOGICAL
Logical value indicating if we're called from the Load event
Top

CHARACTER SetLabel (Control, character)
Purpose: Sets the label of a control
Notes:

Parameters:
poControl System.Windows.Forms.Control
The control
pcLabel CHARACTER
The label
Returns CHARACTER
The original (previous) label
Top

SetMandatory (Control, logical)
Purpose: Changes the mandatory state of a field
Notes: SCL-6067. Assigns or removes the StyleSet "mandatory" and the label
suffix " (*)". The label of the viewer layout is remembered for
ResetViewerState, the StyleSetName is restored from the layout state
(StoreControlStyles)

Parameters:
poControl System.Windows.Forms.Control
The control of the field
plMandatory LOGICAL
Logical value indicating if the field is mandatory
Top

StoreControlStyles ()
Purpose: Stores the StyleSetName of the controls of the viewer layout
Notes: SCL-6067. ResetViewerState restores these StyleSets (e.g. "mandatory"
assigned by the repository rendering), so that a StyleSet set by a
server-side event handler (FieldControl:Style) only overrides them
until the reset

Top

StoreFieldStatus (handle)
Purpose: Stores the status of the fields
Notes:

Parameters:
phEnableFields HANDLE
The handle of the buffer of the ttEnableFields temp-table
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

SmartViewerUiControlHandler (SmartViewerControl, handle)
Purpose: Constructor for the SmartViewerUiControlHandler class
Notes:

Parameters:
poViewer Consultingwerk.SmartComponents.Base.SmartViewerControl
The reference to the SmartViewerControl instance
phEnableFields HANDLE
The handle of the buffer of the ttEnableFields temp-table


Property Detail
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:07:09