Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartUpdatableBrowser Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Implements: Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget, Consultingwerk.SmartComponents.Interfaces.Design.IDesignGroupAssignSource, Consultingwerk.SmartComponents.Interfaces.Design.IDesignToolbarTarget, Consultingwerk.SmartComponents.Interfaces.IAfterRetrieveDataSubscriber, Consultingwerk.SmartComponents.Base.IAlwaysEnabledControl, Consultingwerk.SmartComponents.Interfaces.ICheckOkToClose, ICustomTypeDescriptor, IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.ILaunchDetailForm, Consultingwerk.SmartComponents.Interfaces.ISaveChangesOnDeactivateForm, Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowser, Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget, Consultingwerk.SmartComponents.Interfaces.ISmartDataTargetWithBindingSource, Consultingwerk.SmartComponents.Interfaces.ISmartExportTarget, Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignSource, Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget, Consultingwerk.SmartComponents.Interfaces.ISmartToolbarTarget, Consultingwerk.SmartComponents.Interfaces.ISupportFormShownHandler
Inherited by: Consultingwerk.SmartComponents.Implementation.SmartDynamicUpdatableBrowser

File:SmartUpdatableBrowser
Purpose:Updatable browser implementation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Jul 16 14:36:37 CEST 2010
Notes:The SmartUpdatableBrowser can use a SmartLookup
(SmartBusinessEntityLookup) Control as an embedded editor
by assigning a columns EditorComponent property to an
instance of a lookup control.
The communication between the SmartUpdatableBrowser and
the SmartBusinessEntityLookup is mediated through the
IEmbeddedSmartEditor interface. The SmartLookup needs to
be referencing the Grid using the OwningGrid property



Top Method Summary
Options Name Purpose
AddRecord () Add a new record to the SmartDataSource. The Method CreateRecord of SmartUpdatableBrowser gets called to Handle this Task. This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the AddRecord Tool. Enforced by Interface ISmartDataTarget.
AddRecordFromBindingSource () Ensures the SmartUpdatableBrowser is in AddingRecord mode and the right fields are enabled etc. after a new row was created by the BindingSource
AddSmartTableIOSource (ISmartTableIOSource) Adds a(nother) SmartTableIOSource to the SmartDataAdapter instance
System.Windows.Forms.Control ApplyFocusToErrorField (IFieldValidationError) Set's focus into a field that is related to an error
CancelUpdate () Reverts the changes to the current record. This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the corresponding Tool. Enforced by Interface ISmartDataTarget.
ClearFilterRow (FilterClearButtonUIElement) Clears the Filter Row
LOGICAL ControlFocus (Control) Calls the Focus() method for a .NET Control
CopyRecord () Copy the current record to a new one. The Method CreateRecord of SmartViewerControl gets called to Handle this Task. This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the corresponding Tool. Enforced by Interface ISmartDataTarget.
CreateRecord (logical) Creates a new record in the viewer. This Method is called by AddRecord and CopyRecord from the current Class but may be overridden.
DeleteRecord () Widens access to the DeleteRecord method of the SmartBrowserControl
DeregisterSmartGroupAssignTarget (ISmartGroupAssignTarget) Deregister a SmartDataTarget with the SmartGroupAssignTarget
DisableFields () Disables the fields of the SmartUpdatableBrowser
DisableForUpdate (ISmartDataTarget) Disable the Controls during an Update.
DisplayError (Error) Display ErrorMessages shows a predefined Error Dialog and is called from the Method SaveChanges () of the SmartUpdatableBrowser Class.
DisplayError (Error, character) Display ErrorMessages shows a predefined Error Dialog and is called from the Method SaveChanges () of the SmartUpdatableBrowser Class.
EnableAfterUpdate () Enable the Controls after an Update. This Method is called by the SmartDataAdapter when setting the SmartDataSourceState Property to Navigatable. Enforced by Interface ISmartDataTarget.
EnableFields (character) Enable all controls of the SmartUpdatableBrowser.
EnableFields (character, logical) Enable all controls of the SmartUpdatableBrowser.
EnsureVisible () Ensures that this SmartUpdatableBrowser is visible
EvaluateTableIOState () This Method sets the Property SmartTableIOState to a value according to the SmartDataSources state of the current class. Possible values for SmartTableIOState are defined in the TableIOStateEnum.
Infragistics.Win.UltraWinGrid.UltraGridRow FindFirstChildDataRow (UltraGridGroupByRow) Finds the first child row of a group by row that is a data row
Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignTarget GetViewerForBoundControl (character) Returns the reference to the SmartGroupAssignTarget that contains a Control bound to the given field name
HandleValidationError (Error) Handles an error raised by validation routines
LOGICAL IsOkToClose (logical, CloseReason) Check if it is ok to close the parent form.
OnAddingRecordChanged (EventArgs) Raises the AddingRecordChanged event
OnAfterAddRecord (EventArgs) Raises the AfterAddRecord event
OnAfterCancelledUpdate (AfterCancelledUpdateEventArgs) Raises the AfterCancelledUpdate event
OnAfterCancelUpdate (EventArgs) Raises the AfterCancelUpdate event
OnAfterCellActivate () Called after a cell is activated
OnAfterCellListCloseUp (CellEventArgs) Raises the AfterCellListCloseUp event
OnAfterCellUpdate (CellEventArgs) Raises the AfterCellUpdate event
OnAfterCopyRecord (EventArgs) Raises the AfterCopyRecord event
OnAfterFieldsEnabled (EventArgs) Raises the AfterFieldsEnabled
OnAfterPerformAction (AfterUltraGridPerformActionEventArgs) Raises the AfterPerformAction event
OnAfterRowActivate () Called after a row is activated
OnAfterSaveChanges (EventArgs) Raises the AfterSaveChanges event
OnBeforeAddRecord (CancelEventArgs) Raises the BeforeAddRecord event
OnBeforeCancelUpdate (CancelEventArgs) Raises the BeforeCancelUpdate event
OnBeforeCellDeactivate (CancelEventArgs) Called before a cell is deactivated
OnBeforeCopyRecord (CancelEventArgs) Raises the BeforeCopyRecord event
OnBeforeEnableFields (CancelableEventArgs) Raises the BeforeEnableFields
OnBeforeRowDeactivate (CancelEventArgs) Raises the BeforeRowDeactivate event
OnBeforeSaveChanges (CancelEventArgs) Raises the BeforeSaveChanges event
OnCellChange (CellEventArgs) Raises the CellChange event
OnCopyingRecordChanged (EventArgs) Raises the CopyingRecordChanged
OnEndInit () Invoked during the System.ComponentModel.ISupportInitialize.EndInit of the component.
OnFieldsDisabled (EventArgs) Raises the FieldsDisabled event.
OnFieldsEnabled (EventArgs) Raises the FieldsEnabled event.
OnFocusErrorField (FocusErrorFieldEventArgs) Raises the FocusErrorField event
OnKeyDown (KeyEventArgs) Raises the Key Down Event
OnKeyPress (KeyPressEventArgs) Raises the KeyPress event
OnLeave (EventArgs) Raises the Leave event
OnSmartTableIOSourceChanged (EventArgs) Publishes the SmartGroupAssignSourceChanged event
OnSmartTableIOStateChanged (SmartTableIOStateChangedEventArgs) Publishes the SmartTableIOStateChanged event
PerformLookups () Performs lookup on the current grid row
ProcessFieldSecurity (UltraGridColumn, FieldRestrictionEnum) Processes field security from the IFieldAuthorizationProvider
LOGICAL PromptForSaveValuesOnRowDeactivate () Prompt the user to save changes when selecting a different row while editing a row.
System.Windows.Forms.Control RecurseLocateBindingControl (Control, character) Recurses through the Controls in this SmartViewerControl and nested controls searching for a Control that is bound to the named BindingProperty (a field attached to the ProBindingSource).
RegisterSmartGroupAssignTarget (ISmartGroupAssignTarget) Register a SmartDataTarget with the SmartGroupAssignTarget
RemoveSmartTableIOSource (ISmartTableIOSource) Removes a SmartTableIOSource from the SmartDataAdapter instance
RestoreValuesForCopy () Restore the Current Values of all Controls on a SmartViewerControl and in all SmartGroupAssignTargets.
SaveChanges () Saves the current changes to the database.
SaveChanges (logical) Saves the current changes to the database.
LOGICAL SaveChangesOnDeactivateForm (logical) Saves pending changes when a Form is deactivated
SetModifyingState () Sets the TableIOState to ModifyingData
SetOpenedEditorDropDownControl (Control) Sets the Opened Drop Down Editor Control
StoreValuesForCopy () Store the Current Values of all Controls on a SmartViewerControl and do the same in all SmartGroupAssignTargets.
TextChangedEventHandler (Object, EventArgs) Initiate switching to the ModifyingData Mode if the user enters data.

Top Constructor Summary
Options Name Purpose
SmartUpdatableBrowser () Constructor for the SmartUpdatableBrowser class

Top Event Summary
Options Name Purpose
AddingRecordChanged DELEGATE System.EventHandler Event fired when the AddingRecord Property is changed
AfterAddRecord DELEGATE System.EventHandler Event fired when the viewer has successfully started an Add operation
AfterCancelledUpdate (Object, AfterCancelledUpdateEventArgs) Event fired when the viewer has successfully cancelled an update
AfterCancelUpdate DELEGATE System.EventHandler Event fired when the viewer has successfully cancelled an update
AfterCopyRecord DELEGATE System.EventHandler Event fired when the viewer has successfully started a Copy operation
AfterFieldsEnabled DELEGATE System.EventHandler Raised after the fields have been enabled
AfterSaveChanges DELEGATE System.EventHandler Event fired when the viewer has successfully saved changes
BeforeAddRecord DELEGATE System.ComponentModel.CancelEventHandler Event fired when the Viewer starts adding a new record. This event is cancelable
BeforeCancelUpdate DELEGATE System.ComponentModel.CancelEventHandler Event fired when the Viewer begins cancelling an update. This event is cancellable
BeforeCopyRecord DELEGATE System.ComponentModel.CancelEventHandler Event fired when the Viewer begins copying a record. This event is cancellable
BeforeEnableFields (Object, CancelableEventArgs) Raised before the fields are enabled
BeforeSaveChanges DELEGATE System.ComponentModel.CancelEventHandler Event fired when the Viewer starts saving a record. This event is cancellable
CopyingRecordChanged DELEGATE System.EventHandler Raised when the CopyingRecord property has changed
FieldsDisabled DELEGATE System.EventHandler Event fired when the columns of this browser become disabled
FieldsEnabled DELEGATE System.EventHandler Event fired when the columns of this browser become enabled
FocusErrorField (Object, FocusErrorFieldEventArgs) Raised to allow subscribers to set focus to an error field
SmartTableIOSourceChanged DELEGATE System.EventHandler Event fired when the SmartTableIOSource Property is changed
SmartTableIOStateChanged (Object, SmartTableIOStateChangedEventArgs) Event fired when the SmartTableIOSource Property is changed

Top Property Summary
Options Name Purpose
LOGICAL AddingRecord
Infragistics.Win.UltraWinGrid.AllowAddNew AllowAddNew
LOGICAL AllowEditOfUncommittedAdd
LOGICAL BeginEditModeOnCellListCloseUp
LOGICAL CopyingRecord
LOGICAL DisabledColumnsDisabled
CHARACTER DisabledColumnsForAdd
CHARACTER DisabledColumnsForUpdate
CHARACTER ExcludeColumnsFromCopy
Consultingwerk.SmartComponents.Interfaces.Design.IDesignTableIOSource LinkTableIOSource
LOGICAL PromptForSaveValuesOnRowDeactivate
LOGICAL SaveChangesOnLeave
LOGICAL SaveMode
LOGICAL SimpleKeyboardNavigationDuringUpdate
LOGICAL SimpleKeyboardNavigationDuringUpdateForced
LOGICAL SimpleKeyboardNavigationDuringUpdateForLeftRight
Consultingwerk.SmartComponents.Base.ListISmartGroupAssignTarget SmartGroupAssignTargets
Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource SmartTableIOSource
CHARACTER SmartTableIOState
Consultingwerk.SmartComponents.Enum.UpdateStateEnum UpdateState


Method Detail
Top

AddRecord ()

Purpose: Add a new record to the SmartDataSource. The Method CreateRecord of
SmartUpdatableBrowser gets called to Handle this Task.
This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the AddRecord Tool.
Enforced by Interface ISmartDataTarget.
Notes:

Top

AddRecordFromBindingSource ()

Purpose: Ensures the SmartUpdatableBrowser is in AddingRecord mode and the
right fields are enabled etc. after a new row was created by the
BindingSource
Notes: SCL-826

Top

AddSmartTableIOSource (ISmartTableIOSource)

Purpose: Adds a(nother) SmartTableIOSource to the SmartDataAdapter
instance
Notes: Enables multiple SmartTableIOSources to the SmartViewerControl.

Parameters:
poSmartTableIOSource Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource
The ISmartTableIOSource to add to this instance
Top

System.Windows.Forms.Control ApplyFocusToErrorField (IFieldValidationError)

Purpose: Set's focus into a field that is related to an error
Notes: Protected method, so behavior can be customized
Returns the focussed Control, so that visual hints may be added

Parameters:
e Consultingwerk.SmartComponents.Base.IFieldValidationError
The IFieldValidationError instance that contains the information about which Control/Field to focus
Returns System.Windows.Forms.Control
The Control that the focus was applied to
Top

CancelUpdate ()

Purpose: Reverts the changes to the current record.
This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the corresponding Tool.
Enforced by Interface ISmartDataTarget.
Notes:

Top

ClearFilterRow (FilterClearButtonUIElement)

Purpose: Clears the Filter Row
Notes: Method overridden in the SmartUpdatableBrowse to allow to save pending
updates before clearing the filter

Parameters:
poUIElement Infragistics.Win.UltraWinGrid.FilterClearButtonUIElement
The UIElement that was clicked to distinguish between clear filter row and a single filter cell
Top

LOGICAL ControlFocus (Control)

Purpose: Calls the Focus() method for a .NET Control
Notes: SCL-659 : A customer was setting the SET-WAIT-STATE("GENERAL") using
the WaitStateManager around all TableIO Operations - with the consequence,
that all Focus() operations on
- error message putting focus to error field
- FocusControlOnAdd, etc.
were not working anymore. Seems that .NET Controls ignore the Focus()
during the WAIT-STATE. In order to workaround those situation we have
moved all calls to the Focus() method of Viewer Controls to the
overridable method ControlFocus() that receives the Control reference
as the input parameter. This overridable method can be extended by
customers to make sure no WAIT-STATE is active anymore before the
Control:Focus() Focus() is called.

Parameters:
poControl System.Windows.Forms.Control
The reference to the .NET Control that should receive Focus
Returns LOGICAL
Logical value indicating if the input focus request was successful
Top

CopyRecord ()

Purpose: Copy the current record to a new one. The Method CreateRecord of
SmartViewerControl gets called to Handle this Task.
This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the corresponding Tool.
Enforced by Interface ISmartDataTarget.
Notes:

Top

CreateRecord (logical)

Purpose: Creates a new record in the viewer.
This Method is called by AddRecord and CopyRecord from the current
Class but may be overridden.
Notes: The parameter plCopy tells the method if it has been called from
AddRecord or CopyRecord.

Parameters:
plCopy LOGICAL
Logical value, FALSE = Add new record, TRUE = Copy existing record
Top

DeleteRecord ()

Purpose: Widens access to the DeleteRecord method of the SmartBrowserControl
Notes: ISmartTableIOTarget requires this method to be public

Top

DeregisterSmartGroupAssignTarget (ISmartGroupAssignTarget)

Purpose: Deregister a SmartDataTarget with the SmartGroupAssignTarget
Notes: Enforced by Interface ISmartGroupAssignSource.

Parameters:
poSmartGroupAssignTarget Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignTarget
The ISmartGroupAssignTarget to remove from this instance
Top

DisableFields ()

Purpose: Disables the fields of the SmartUpdatableBrowser
Notes:

Top

DisableForUpdate (ISmartDataTarget)

Purpose: Disable the Controls during an Update.
Notes: This Method is called by the SmartDataAdapter by a call to
BeginUpdateState () which is defined in the Interface ISmartDataSource.
Enforced by Interface ISmartDataTarget.
Do not disable this browser, when the browser itself initiated the
Update mode

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The SmartDataTarget that is currently in update state
Top

DisplayError (Error)

Purpose: Display ErrorMessages shows a predefined Error Dialog and is called
from the Method SaveChanges () of the SmartUpdatableBrowser Class.
Notes:

Parameters:
e Progress.Lang.Error
The error to display
Top

DisplayError (Error, character)

Purpose: Display ErrorMessages shows a predefined Error Dialog and is called
from the Method SaveChanges () of the SmartUpdatableBrowser Class.
Notes:

Parameters:
e Progress.Lang.Error
The error to display
pcMessageTitle CHARACTER
The title to use for the error message
Top

EnableAfterUpdate ()

Purpose: Enable the Controls after an Update.
This Method is called by the SmartDataAdapter when setting the
SmartDataSourceState Property to Navigatable.
Enforced by Interface ISmartDataTarget.
Notes: Use this only in a Browser!

Top

EnableFields (character)

Purpose: Enable all controls of the SmartUpdatableBrowser.
Notes: This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the Tools for Add or Edit Data.
Enforced by Interface ISmartDataTarget or ISmartGroupAssignTarget.

Parameters:
pcFields CHARACTER
The EnableFieldsEnum value
Top

EnableFields (character, logical)

Purpose: Enable all controls of the SmartUpdatableBrowser.
Notes: This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the Tools for Add or Edit Data.
Enforced by Interface ISmartDataTarget or ISmartGroupAssignTarget.

Parameters:
pcFields CHARACTER
The EnableFieldsEnum value
plApplyFocus LOGICAL
Apply Focus to the SmartUpdatableBrowser
Top

EnsureVisible ()

Purpose: Ensures that this SmartUpdatableBrowser is visible
Notes:

Top

EvaluateTableIOState ()

Purpose: This Method sets the Property SmartTableIOState to a value according
to the SmartDataSources state of the current class. Possible values
for SmartTableIOState are defined in the TableIOStateEnum.
Notes: This Method is called by the SmartDataAdapter when the
PositionChangedHandler is fired or inside the SmartViewerControl if
a new BindingSource is attached.
Enforced by ISmartDataTarget

Top

Infragistics.Win.UltraWinGrid.UltraGridRow FindFirstChildDataRow (UltraGridGroupByRow)

Purpose: Finds the first child row of a group by row that is a data row
Notes:

Parameters:
poGroupByRow Infragistics.Win.UltraWinGrid.UltraGridGroupByRow
The group by row to find the first child of
Returns Infragistics.Win.UltraWinGrid.UltraGridRow
The UltraGridRow that is a data row of ?
Top

Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignTarget GetViewerForBoundControl (character)

Purpose: Returns the reference to the SmartGroupAssignTarget that contains
a Control bound to the given field name
Notes:

Parameters:
pcFieldName CHARACTER
The name of the field
Returns Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignTarget
The reference to the SmartGroupAssignTarget that contains a Control bound to the given field name
Top

HandleValidationError (Error)

Purpose: Handles an error raised by validation routines
Notes: Displays the Error message and focusses the field that caused the error

Parameters:
poError Progress.Lang.Error
The reference to the validation error instance
Top

LOGICAL IsOkToClose (logical, CloseReason)

Purpose: Check if it is ok to close the parent form.
Notes:

Parameters:
plShowMessage LOGICAL
When TRUE a message is Shown explaining why it is not ok to close the parent form
poCloseReason System.Windows.Forms.CloseReason
The System.Windows.Forms.CloseReason passed from then OnFormClosing Method of the parent form giving the reason why the form is closed
Returns LOGICAL
Logical value indicating if the parent Form may be closed
Top

OnAddingRecordChanged (EventArgs)

Purpose: Raises the AddingRecordChanged event
Notes:

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

OnAfterAddRecord (EventArgs)

Purpose: Raises the AfterAddRecord event
Notes:

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

OnAfterCancelledUpdate (AfterCancelledUpdateEventArgs)

Purpose: Raises the AfterCancelledUpdate event
Notes:

Parameters:
e Consultingwerk.SmartComponents.Base.AfterCancelledUpdateEventArgs
The AfterCancelledUpdateEventArgs with the data for this event
Top

OnAfterCancelUpdate (EventArgs)

Purpose: Raises the AfterCancelUpdate event
Notes:

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

OnAfterCellActivate ()

Purpose: Called after a cell is activated
Notes: Deactivates cell after Cancel of Save during selection of a different
row

Top

OnAfterCellListCloseUp (CellEventArgs)

Purpose: Raises the AfterCellListCloseUp event
Notes: Called after a CellList is closed up

Parameters:
e Infragistics.Win.UltraWinGrid.CellEventArgs
The CellEventArgs with the data for this event
Top

OnAfterCellUpdate (CellEventArgs)

Purpose: Raises the AfterCellUpdate event
Notes: Called after a cell has been updated

Parameters:
e Infragistics.Win.UltraWinGrid.CellEventArgs
The CellEventArgs with the data for this event
Top

OnAfterCopyRecord (EventArgs)

Purpose: Raises the AfterCopyRecord event
Notes:

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

OnAfterFieldsEnabled (EventArgs)

Purpose: Raises the AfterFieldsEnabled
Notes:

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

OnAfterPerformAction (AfterUltraGridPerformActionEventArgs)

Purpose: Raises the AfterPerformAction event
Notes:

Parameters:
e Infragistics.Win.UltraWinGrid.AfterUltraGridPerformActionEventArgs
The AfterUltraGridPerformActionEventArgs with the data for this event
Top

OnAfterRowActivate ()

Purpose: Called after a row is activated
Notes:

Top

OnAfterSaveChanges (EventArgs)

Purpose: Raises the AfterSaveChanges event
Notes:

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

OnBeforeAddRecord (CancelEventArgs)

Purpose: Raises the BeforeAddRecord event
Notes:

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

OnBeforeCancelUpdate (CancelEventArgs)

Purpose: Raises the BeforeCancelUpdate event
Notes:

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

OnBeforeCellDeactivate (CancelEventArgs)

Purpose: Called before a cell is deactivated
Notes:

Parameters:
e System.ComponentModel.CancelEventArgs
An System.ComponentModel.CancelEventArgs instance that contains the event data.
Top

OnBeforeCopyRecord (CancelEventArgs)

Purpose: Raises the BeforeCopyRecord event
Notes:

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

OnBeforeEnableFields (CancelableEventArgs)

Purpose: Raises the BeforeEnableFields
Notes:

Parameters:
e Consultingwerk.CancelableEventArgs
The CancelableEventArgs with the data for the event
Top

OnBeforeRowDeactivate (CancelEventArgs)

Purpose: Raises the BeforeRowDeactivate event
Notes: Called before a row is deactivated

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

OnBeforeSaveChanges (CancelEventArgs)

Purpose: Raises the BeforeSaveChanges event
Notes:

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

OnCellChange (CellEventArgs)

Purpose: Raises the CellChange event
Notes:

Parameters:
e Infragistics.Win.UltraWinGrid.CellEventArgs
The CellEventArgs with the data for this event
Top

OnCopyingRecordChanged (EventArgs)

Purpose: Raises the CopyingRecordChanged
Notes:

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

OnEndInit ()

Purpose: Invoked during the System.ComponentModel.ISupportInitialize.EndInit
of the component.
Notes:

Top

OnFieldsDisabled (EventArgs)

Purpose: Raises the FieldsDisabled event.
Notes:

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

OnFieldsEnabled (EventArgs)

Purpose: Raises the FieldsEnabled event.
Notes:

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

OnFocusErrorField (FocusErrorFieldEventArgs)

Purpose: Raises the FocusErrorField event
Notes:

Parameters:
e Consultingwerk.SmartComponents.Implementation.FocusErrorFieldEventArgs
The FocusErrorFieldEventArgs with the data for the event
Top

OnKeyDown (KeyEventArgs)

Purpose: Raises the Key Down Event
Notes: Bug 2640: Enable Excel-like navigation during update
SCL-277: Ability to force cursor key navigation (prevent spinning in
numeric fields, etc.). The Grid will not handle the cursor
keys in an ActiveCell itself anymore.

Parameters:
e System.Windows.Forms.KeyEventArgs
The KeyEventArgs with the data for this event
Top

OnKeyPress (KeyPressEventArgs)

Purpose: Raises the KeyPress event
Notes: Starts the Lookup Timer when the Control has Focus

Parameters:
e System.Windows.Forms.KeyPressEventArgs
The KeyPressEventArgs with the data for this event
Top

OnLeave (EventArgs)

Purpose: Raises the Leave event
Notes: Allows invocation of SaveChanges when there are pending updates

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

OnSmartTableIOSourceChanged (EventArgs)

Purpose: Publishes the SmartGroupAssignSourceChanged event
Notes:

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

OnSmartTableIOStateChanged (SmartTableIOStateChangedEventArgs)

Purpose: Publishes the SmartTableIOStateChanged event
Notes:

Parameters:
e Consultingwerk.SmartComponents.Base.SmartTableIOStateChangedEventArgs
The SmartTableIOStateChangedEventArgs with the data for this event
Top

PerformLookups ()

Purpose: Performs lookup on the current grid row
Notes: Executed during SaveChanges

Top

ProcessFieldSecurity (UltraGridColumn, FieldRestrictionEnum)

Purpose: Processes field security from the IFieldAuthorizationProvider
Notes:

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The reference to the UltraGridColumn
poRestricted Consultingwerk.Framework.Authorization.FieldRestrictionEnum
The FieldRestrictionEnum defining the column's authorization
Top

LOGICAL PromptForSaveValuesOnRowDeactivate ()

Purpose: Prompt the user to save changes when selecting a different row
while editing a row.
Notes: This method is meant to be overridden to modify the behavior
when the user selected a different row.

Returns LOGICAL
Logical value indicating if the current values should be saved
Top

System.Windows.Forms.Control RecurseLocateBindingControl (Control, character)

Purpose: Recurses through the Controls in this SmartViewerControl and nested
controls searching for a Control that is bound to the named
BindingProperty (a field attached to the ProBindingSource).
Notes:

Parameters:
poParentControl System.Windows.Forms.Control
The reference to the ParentControl
pcBindingPropertyName CHARACTER
The name of the field in the ProBindingSource
Returns System.Windows.Forms.Control
The reference to the resulting Control
Top

RegisterSmartGroupAssignTarget (ISmartGroupAssignTarget)

Purpose: Register a SmartDataTarget with the SmartGroupAssignTarget
Notes: This Method is executed every time a new SmartGroupAssignSource is
registered to the corresponding Property of a Class implementing the
Interface ISmartGroupAssignSource.
Enforced by Interface ISmartGroupAssignSource.

Parameters:
poSmartGroupAssignTarget Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignTarget
The ISmartGroupAssignTarget to register
Top

RemoveSmartTableIOSource (ISmartTableIOSource)

Purpose: Removes a SmartTableIOSource from the SmartDataAdapter
instance
Notes: Enables multiple SmartTableIOSource to the SmartDataAdapter.

Parameters:
poSmartTableIOSource Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource
The ISmartTableIOSource to remove from this instance
Top

RestoreValuesForCopy ()

Purpose: Restore the Current Values of all Controls on a SmartViewerControl
and in all SmartGroupAssignTargets.
Notes: This Method is called by CreateRecord from the current Class.
Enforced by Interface ISmartGroupAssignTarget.

Top

SaveChanges ()

Purpose: Saves the current changes to the database.
Notes: This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the corresponding Tool.
Enforced by Interface ISmartDataTarget or ISmartGroupAssignTarget.

Top

SaveChanges (logical)

Purpose: Saves the current changes to the database.
Notes: Internal method that allows to specify if or if not the Control is
supported to Focus() itself

Parameters:
plEnforceFocus LOGICAL
Logical value indicating if the Control should Focus() itself
Top

LOGICAL SaveChangesOnDeactivateForm (logical)

Purpose: Saves pending changes when a Form is deactivated
Notes:

Parameters:
plShowMessage LOGICAL
When TRUE a message is asking the user if values should be saved. When FALSE values will be saved silently
Returns LOGICAL
True when the user did choose not to save or the save was successful, False when the control remains in Update state
Top

SetModifyingState ()

Purpose: Sets the TableIOState to ModifyingData
Notes: Useful when modifying Grid cell values through event handlers

Top

SetOpenedEditorDropDownControl (Control)

Purpose: Sets the Opened Drop Down Editor Control
Notes: See Bug 1878 for details

Parameters:
poControl System.Windows.Forms.Control
The reference to the currently opened EditorDropDownControl
Top

StoreValuesForCopy ()

Purpose: Store the Current Values of all Controls on a SmartViewerControl
and do the same in all SmartGroupAssignTargets.
Notes: This Method is called by CreateRecord from the current Class.
Enforced by Interface ISmartGroupAssignTarget.

Top

TextChangedEventHandler (Object, EventArgs)

Purpose: Initiate switching to the ModifyingData Mode if the user enters data.
Notes: This Method is executed every time data changes in the EditorControls
of a SmartViewerControl.
Event handler for the TextChangedEvent event of Editor Controls on
the SmartViewerControl.
Enforced by Interface ISmartGroupAssignSource.

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


Constructor Detail
Top

SmartUpdatableBrowser ()

Purpose: Constructor for the SmartUpdatableBrowser class
Notes:



Event Detail
Top

AddingRecordChanged DELEGATE System.EventHandler

Purpose: Event fired when the AddingRecord Property is changed
Notes:

Delegate: System.EventHandler
Top

AfterAddRecord DELEGATE System.EventHandler

Purpose: Event fired when the viewer has successfully started an Add
operation
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler
Top

AfterCancelledUpdate (Object, AfterCancelledUpdateEventArgs)

Purpose: Event fired when the viewer has successfully cancelled an update
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner
This event fires after the AfterCancelUpdate has fired and all update
status is reset

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

AfterCancelUpdate DELEGATE System.EventHandler

Purpose: Event fired when the viewer has successfully cancelled an update
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler
Top

AfterCopyRecord DELEGATE System.EventHandler

Purpose: Event fired when the viewer has successfully started a Copy operation
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler
Top

AfterFieldsEnabled DELEGATE System.EventHandler

Purpose: Raised after the fields have been enabled
Notes:

Delegate: System.EventHandler
Top

AfterSaveChanges DELEGATE System.EventHandler

Purpose: Event fired when the viewer has successfully saved changes
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler
Top

BeforeAddRecord DELEGATE System.ComponentModel.CancelEventHandler

Purpose: Event fired when the Viewer starts adding a new record.
This event is cancelable
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.ComponentModel.CancelEventHandler
Top

BeforeCancelUpdate DELEGATE System.ComponentModel.CancelEventHandler

Purpose: Event fired when the Viewer begins cancelling an update.
This event is cancellable
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.ComponentModel.CancelEventHandler
Top

BeforeCopyRecord DELEGATE System.ComponentModel.CancelEventHandler

Purpose: Event fired when the Viewer begins copying a record.
This event is cancellable
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.ComponentModel.CancelEventHandler
Top

BeforeEnableFields (Object, CancelableEventArgs)

Purpose: Raised before the fields are enabled
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the BeforeEnableFields event
e Consultingwerk.CancelableEventArgs
The CancelableEventArgs with the data for the event
Top

BeforeSaveChanges DELEGATE System.ComponentModel.CancelEventHandler

Purpose: Event fired when the Viewer starts saving a record.
This event is cancellable
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.ComponentModel.CancelEventHandler
Top

CopyingRecordChanged DELEGATE System.EventHandler

Purpose: Raised when the CopyingRecord property has changed
Notes:

Delegate: System.EventHandler
Top

FieldsDisabled DELEGATE System.EventHandler

Purpose: Event fired when the columns of this browser become disabled
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler
Top

FieldsEnabled DELEGATE System.EventHandler

Purpose: Event fired when the columns of this browser become enabled
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler
Top

FocusErrorField (Object, FocusErrorFieldEventArgs)

Purpose: Raised to allow subscribers to set focus to an error field
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the FocusErrorField event
e Consultingwerk.SmartComponents.Implementation.FocusErrorFieldEventArgs
The FocusErrorFieldEventArgs with the data for the event
Top

SmartTableIOSourceChanged DELEGATE System.EventHandler

Purpose: Event fired when the SmartTableIOSource Property is changed
Notes:

Delegate: System.EventHandler
Top

SmartTableIOStateChanged (Object, SmartTableIOStateChangedEventArgs)

Purpose: Event fired when the SmartTableIOSource Property is changed
Notes:

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


Property Detail
Top

LOGICAL AddingRecord


Returns LOGICAL
Top

Infragistics.Win.UltraWinGrid.AllowAddNew AllowAddNew


Returns Infragistics.Win.UltraWinGrid.AllowAddNew
Top

LOGICAL AllowEditOfUncommittedAdd


Returns LOGICAL
Top

LOGICAL BeginEditModeOnCellListCloseUp


Returns LOGICAL
Top

LOGICAL CopyingRecord


Returns LOGICAL
Top

LOGICAL DisabledColumnsDisabled


Returns LOGICAL
Top

CHARACTER DisabledColumnsForAdd


Returns CHARACTER
Top

CHARACTER DisabledColumnsForUpdate


Returns CHARACTER
Top

CHARACTER ExcludeColumnsFromCopy


Returns CHARACTER
Top

Consultingwerk.SmartComponents.Interfaces.Design.IDesignTableIOSource LinkTableIOSource


Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignTableIOSource
Top

LOGICAL PromptForSaveValuesOnRowDeactivate


Returns LOGICAL
Top

LOGICAL SaveChangesOnLeave


Returns LOGICAL
Top

LOGICAL SaveMode


Returns LOGICAL
Top

LOGICAL SimpleKeyboardNavigationDuringUpdate


Returns LOGICAL
Top

LOGICAL SimpleKeyboardNavigationDuringUpdateForced


Returns LOGICAL
Top

LOGICAL SimpleKeyboardNavigationDuringUpdateForLeftRight


Returns LOGICAL
Top

Consultingwerk.SmartComponents.Base.ListISmartGroupAssignTarget SmartGroupAssignTargets


Returns Consultingwerk.SmartComponents.Base.ListISmartGroupAssignTarget
Top

Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource SmartTableIOSource


Returns Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource
Top

CHARACTER SmartTableIOState


Returns CHARACTER
Top

Consultingwerk.SmartComponents.Enum.UpdateStateEnum UpdateState


Returns Consultingwerk.SmartComponents.Enum.UpdateStateEnum


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:23:50