Namespace: Consultingwerk.SmartComponents.Base
Class 
SmartDataAdapter Copy to Clipboard
Parent classes:
Consultingwerk.SmartComponents.ComponentBase
Consultingwerk.SmartComponents.Base.SmartComponent
Consultingwerk.SmartComponents.Base.SmartDataAdapter

Inherits: Consultingwerk.SmartComponents.Base.SmartComponent
Implements: Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource, Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget, ICustomTypeDescriptor, IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.ISmartDataSource, Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget, Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget, System.ComponentModel.ISupportInitialize
Inherited by: Consultingwerk.SmartComponents.Implementation.SmartDataObjectAdapter Consultingwerk.SmartComponents.Implementation.SmartTempTableAdapter Consultingwerk.SmartComponents.Base.SmartDatasetAdapter Consultingwerk.SmartComponents.Implementation.SmartDatasetChildAdapter Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.SmartBusinessEntityAdapterTester
ABSTRACT

File:SmartDataAdapter
Purpose:Abstract base class for all Data Adapter implementations
in the SmartComponent Library
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Jan 21 11:42:57 CET 2009

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



Top Method Summary
Options Name Purpose
ActivateSmartViewerEventHandler () Activates SmartViewer TextChanged/CheckedChanged Event Handlers after a navigation (FetchFirst/FetchNext/FetchPrev/FetchLast)
AddRecordInUpdatableGrid () Ensures an updatable browser is in the correct adding state after a record was created through the Binding Source event
AddSmartNavigationSource (ISmartNavigationSource) Adds a(nother) SmartNavigationSource to the SmartDataAdapter instance
AttachBindingSource (BindingSource) This Method is used to attach a new BindingSource to a SmartDataTarget. Inside a SmartDataAdapter which can be a SmartDataTarget a new BindingSource is created or borrowed from a Browser.
AttachSchemaToBindingSource (BindingSource) Attaches the Data Schema to the BindingSource
BeginInit () Invoked at the beginning of a Containers InitializeComponents method
BeginUpdateState (ISmartDataTarget) The Message to for instance Disable a Browser is send to all SmartDataTargets except the calling one
BeginUpdateStateHandler (Object, DataSourceUpdateStateEventArgs) Event handler for the BeginUpdateState event of the SmartDataSource
CancelCreateRecord () Invoked from the SmartDataTarget to cancel the creation of a new row
A CancelCreateRowHandler (Object, CancelCreateRowEventArgs) Event Handler for the CancelCreateRow event of the ProBindingSource
CloseQuery () Empties the result set of this SmartDataAdapter. Used to clear grids
CHARACTER ColumnDataType (character) Returns the ABL data-type of the column
HANDLE ConnectService () Returns the handle of the AppServer partition associated with this SmartDataAdapter
CreateBindingSource () CreateBindingSource is to be called inside the RetrieveData Method if no valid BindingSource is present inside the SmartDataAdapter. The newly created BindingSource is then registered to all SmartDataTargets of this SmartDataAdapter.
CreateRecord () Invoked from the SmartDataTarget to create a new row
A CreateRowHandler (Object, CreateRowEventArgs) Handler for the CreateRow event of the ProBindingSource
DeactivateSmartViewerEventHandler () Activates SmartViewer TextChanged/CheckedChanged Event Handlers after a navigation (FetchFirst/FetchNext/FetchPrev/FetchLast) */
LOGICAL DeleteQueryRow () This protected method can be used to remove the current row from a Query. This method calls DeleteQueryRow(FALSE).
LOGICAL DeleteQueryRow (logical) This protected method can be used to remove the current row from a Query. The parameter is logical and controls if only the first table (FALSE) or all rows shall be removed.
A DeleteRow () The DeleteRow is an abstract method - that means that it needs to be overridden in a class that inherits from this base class. Enforced by Interface ISmartDataSource.
DeregisterSmartDataTarget (ISmartDataTarget) Deregister a SmartDataTarget with the SmartDataSource. Usually done when a SmartDataTarget is deleted and the SmartDataSource is still running
DisposedHandler (Object, EventArgs) Event handler for the Disposed event of this instance
EndInit () Invoked at the end of a Containers InitializeComponents method
EndUpdateState (ISmartDataTarget) The Message to for instance enable a Browser is send to all SmartDataTargets except the calling one.
EndUpdateStateHandler (Object, DataSourceUpdateStateEventArgs) Event handler for the EndUpdateState event of the SmartDataSource
EndUpdateStateInDataSource (ISmartDataTarget) Invokes EndUpdateState in the SmartDataSource of this SmartDataAdapter
EvaluateTableIOState () This Method is enforced by the Interface ISmartDataTarget and is only required for visual DataTargets.
LOGICAL FetchFirst () This Method moves to the first DataRow inside the BindingSource.
LOGICAL FetchLast () This Method moves to the last DataRow inside the BindingSource.
LOGICAL FetchNext () This Method moves to the next DataRow inside the BindingSource.
LOGICAL FetchPrev () This Method moves to the previous DataRow inside the BindingSource.
Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowser FindLinkedSmartDataBrowser () Returns the reference to the linked SmartDataBrowser, if any
Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget FindLinkedUpdatingSmartDataTarget () Returns the reference to the first linked ISmartDataTarget which is also an ISmartTableIOTarget, that has a valid SmartTableIOSource assigned
CHARACTER GetFieldValues (character) Returns a CHR(1) delimited list of field values from the DataSource
CHARACTER GetRecordPosition () Evaluates the current record position property value
LOGICAL HasFields (character) Returns a logical value indicating if the SmartDataAdapter can provide the given fields
LOGICAL HasUpdatingDataTarget () Returns if the SmartDataAdapter has a SmartDataTarget that is currently modifying data
InvokeParentPositionChanged (Object, EventArgs) Invokes the ParentPositionChanged event handler in all connected SmartDataAdapter instances
LOGICAL IsUpdating (logical) Returns if if this Adapter or any of it's Data-Target Adapters are updating (a Data-Target with SmartTableIOState:ModifyingData)
OffEndHandler (Object, OffEndEventArgs) Event handler for the OffEnd event of the ProBindingSource object
OnAfterQueryPositionChanged (EventArgs) Raises the AfterQueryPositionChanged event
OnAfterRetrieveData (EventArgs) Raises the AfterRetrieveData event
OnBeforeRetrieveData (CancelEventArgs) Raises the BeforeRetrieveData event
OnBeginUpdateState (DataSourceUpdateStateEventArgs) Raises the BeginUpdateState event
OnBindingSourceChanged (BindingSourceChangedEventArgs) Raises the BindingSourceChanged event
OnCurrentChanged (EventArgs) Raises the CurrentChanged event
OnEndUpdateState (DataSourceUpdateStateEventArgs) Raises the EndUpdateState event
OnQueryClosed (EventArgs) Raises the QueryClosed
OnSmartDataSourceChanged (EventArgs) Publishes the SmartGroupAssignSourceChanged event
OnSmartNavigationTargetPositionChanged (SmartNavigationTargetPositionChangedEventArgs) Raises the SmartNavigationTargetPositionChanged event
OnSmartNavigationTargetStateChanged (SmartNavigationTargetStateChangedEventArgs) Raises the SmartNavigationTargetStateChanged event
ParentBindingSourceChangedHandler (Object, BindingSourceChangedEventArgs) Event Handler for the BindingSourceChanged event of the SmartDataSource
ParentPositionChanged (Object, EventArgs) This Method is invoked by the ParentPositionChangedBase Event Handler of the SmartDataAdapters base class when the PositionChanged Event of the SmartDataSources BindingSource is fired.
F ParentPositionChangedBase (Object, EventArgs) Handler for the PositionChanged Event of the SmartDataSources BindingSource.
PositionChangedHandler (Object, EventArgs) Handler for the PositionChanged event of the BindingSource attached to this SmartDataAdapter instance.
RegisterSmartDataTarget (ISmartDataTarget) Register a SmartDataTarget with the SmartDataSource. This Method is called by Classes implementing the ISmartDataTarget Interface when a new SmartDataSource is set.
RemoveSmartNavigationSource (ISmartNavigationSource) Removes a SmartNavigationSource from the SmartDataAdapter instance
RepositionToRowid (character) Repositions to a Rowid list from a character
RepositionToRowid (rowid) Repositions to a single Rowid
RepositionToRowid (rowid[]) Repositions to a Rowid Array
A LOGICAL RetrieveData () RetrieveData is an abstract method - that means that it needs to be overridden in a class that inherits from this base class. Enforced by Interface ISmartDataSource.
SetSmartDataSource (ISmartDataSource) SetSmartDataSource sets the SmartDataSource of the current instance of the SmartDataAdapter.
SubscribeAfterRetrieveData (IAfterRetrieveDataSubscriber) Subscribes an instance of an object to the AfterRetrieveData callback.
A UpdateRow () The UpdateRow is an abstract method - that means that it needs to be overridden in a class that inherits from this base class. Enforced by Interface ISmartDataSource.

Top Constructor Summary
Options Name Purpose
SmartDataAdapter () The Constructor initializes a new SmartDataAdapter. The Default Value for cSmartDataSourceState is set to Navigatable.
SmartDataAdapter (IContainer) The Constructor initializes a new SmartDataAdapter. The Default Value for cSmartDataSourceState is set to Navigatable.

Top Event Summary
Options Name Purpose
AfterQueryPositionChanged DELEGATE System.EventHandler Event fired whenever the QueryPosition has changed (i.e. Add or Delete and Grids etc. need to update the current position)
AfterRetrieveData DELEGATE System.EventHandler Event fired whenever the SmartDataAdapter has opened a new query
BeforeRetrieveData DELEGATE System.ComponentModel.CancelEventHandler Event fired before the SmartDataAdapter is about to open a new query
BeginUpdateState (Object, DataSourceUpdateStateEventArgs) Event raised when a ISmartDataTarget of this SmartDataAdapter instance begins the update state
BindingSourceChanged (Object, BindingSourceChangedEventArgs) Event fired whenever the SmartDataAdapters BindingSource property changes
CurrentChanged DELEGATE System.EventHandler Raised whenever the Data Adapter is positioned on a new row.
EndUpdateState (Object, DataSourceUpdateStateEventArgs) Event raised when a ISmartDataTarget of this SmartDataAdapter instance ends the update state
QueryClosed DELEGATE System.EventHandler Raised when the CloseQuery method is called
SmartDataSourceChanged DELEGATE System.EventHandler Event fired when the SmartDataSource Property is changed
SmartNavigationTargetPositionChanged (Object, SmartNavigationTargetPositionChangedEventArgs) Event fired whenever the RecordPosition properties has changed
SmartNavigationTargetStateChanged (Object, SmartNavigationTargetStateChangedEventArgs) Event fired whenever the SmartDataSourceState property has changed

Top Property Summary
Options Name Purpose
CHARACTER AppServerPartition
LOGICAL Available
Progress.Data.BindingSource BindingSource
CHARACTER BindingSourceExcludeFields
CHARACTER BindingSourceIncludeFields
Progress.Data.BindingSource DataSourceBindingSource
LOGICAL Initializing
Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource LinkNavigationSource
INTEGER PreviousPosition
CHARACTER RecordPosition
Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
LOGICAL SmartDataSourceActive
CHARACTER SmartDataSourceState
Consultingwerk.SmartComponents.Base.ListISmartDataTarget SmartDataTargets
Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource SmartNavigationSource
Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget UpdatingSmartDataTarget


Method Detail
Top

ActivateSmartViewerEventHandler ()
Purpose: Activates SmartViewer TextChanged/CheckedChanged Event Handlers
after a navigation (FetchFirst/FetchNext/FetchPrev/FetchLast)
Notes:

Top

AddRecordInUpdatableGrid ()
Purpose: Ensures an updatable browser is in the correct adding state after
a record was created through the Binding Source event
Notes: SCL-826

Top

AddSmartNavigationSource (ISmartNavigationSource)
Purpose: Adds a(nother) SmartNavigationSource to the SmartDataAdapter
instance
Notes: Enabled multiple SmartNavigationSources to the SmartDataAdapter.

Parameters:
poSmartNavigationSource Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource
The ISmartNavigationSource to add to the list of NavigationSources
Top

AttachBindingSource (BindingSource)
Purpose: This Method is used to attach a new BindingSource to a SmartDataTarget.
Inside a SmartDataAdapter which can be a SmartDataTarget a new
BindingSource is created or borrowed from a Browser.
Notes: Enforced by Interface ISmartDataTarget

Parameters:
poBindingSource Progress.Data.BindingSource
The BindingSource to be attached to the Grids DataSource Property
Top

AttachSchemaToBindingSource (BindingSource)
Purpose: Attaches the Data Schema to the BindingSource
Notes: Do not call this method from an overloaded method when the
overloaded method does set the Except fields

Parameters:
poBindingSource Progress.Data.BindingSource
The BindingSource to attach the Schema to
Top

BeginInit ()
Purpose: Invoked at the beginning of a Containers InitializeComponents
method
Notes: Enforced by System.ComponentModel.ISupportInitialize
http://msdn.microsoft.com/de-de/library/system.componentmodel.isupportinitialize.begininit(VS.80).aspx

Top

BeginUpdateState (ISmartDataTarget)
Purpose: The Message to for instance Disable a Browser is send to all
SmartDataTargets except the calling one
Notes: This Method is called from the SmartViewerControl derived Class when
starting to Modify or Add data.
Enforced by Interface ISmartDataSource.

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The reference to the ISmartDataTarget which is in UpdateState now
Top

BeginUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)
Purpose: Event handler for the BeginUpdateState event of the SmartDataSource
Notes:

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

CancelCreateRecord ()
Purpose: Invoked from the SmartDataTarget to cancel the creation of a new
row
Notes:

Top

CancelCreateRowHandler (Object, CancelCreateRowEventArgs)
Purpose: Event Handler for the CancelCreateRow event of the ProBindingSource
Notes: This method is abstract and needs to be overridden by the actual
implementation of the BindingSource.

Parameters:
sender System.Object
The reference to the System.Object that raised the event
args Progress.Data.CancelCreateRowEventArgs
The CancelCreateRowEventArgs with the data for this event
Top

CloseQuery ()
Purpose: Empties the result set of this SmartDataAdapter. Used to clear grids
Notes: This method used to be abstract, but contains implementation now!

Top

CHARACTER ColumnDataType (character)
Purpose: Returns the ABL data-type of the column
Notes: Column names are resolved in the same way as GetFieldValues does

Parameters:
pcColumnName CHARACTER
The column name
Returns CHARACTER
The ABL data type
Top

HANDLE ConnectService ()
Purpose: Returns the handle of the AppServer partition associated with
this SmartDataAdapter
Notes:

Returns HANDLE
The handle of the AppServer partition used by this SmartDataAdapter
Top

CreateBindingSource ()
Purpose: CreateBindingSource is to be called inside the RetrieveData Method
if no valid BindingSource is present inside the SmartDataAdapter.
The newly created BindingSource is then registered to all
SmartDataTargets of this SmartDataAdapter.
Notes: This method is not intended to be executed during Design time

Top

CreateRecord ()
Purpose: Invoked from the SmartDataTarget to create a new row
Notes:

Top

CreateRowHandler (Object, CreateRowEventArgs)
Purpose: Handler for the CreateRow event of the ProBindingSource
Notes: This method is abstract and needs to be overridden by the actual
implementation of the BindingSource.

Parameters:
sender System.Object
The reference to the System.Object that raised the event
args Progress.Data.CreateRowEventArgs
The reference to the CreateRowEventArgs instance with the data for this event
Top

DeactivateSmartViewerEventHandler ()
Purpose: Activates SmartViewer TextChanged/CheckedChanged Event Handlers
after a navigation (FetchFirst/FetchNext/FetchPrev/FetchLast)

Top

LOGICAL DeleteQueryRow ()
Purpose: This protected method can be used to remove the current row from a
Query. This method calls DeleteQueryRow(FALSE).
Notes:

Returns LOGICAL
Logical value indicating if the method was successful
Top

LOGICAL DeleteQueryRow (logical)
Purpose: This protected method can be used to remove the current row from a
Query. The parameter is logical and controls if only the first
table (FALSE) or all rows shall be removed.
Notes: Any error (like AppError from a Database trigger will not be catched
so that the caller cna

Parameters:
plRemoveAll LOGICAL
Logical value indicating if all buffers should be deleted (TRUE) or just the first query buffer (FALSE)
Returns LOGICAL
Logical value indicating if the method was successful
Top

DeleteRow ()
Purpose: The DeleteRow is an abstract method - that means that it needs
to be overridden in a class that inherits from this base class.
Enforced by Interface ISmartDataSource.
Notes:

Top

DeregisterSmartDataTarget (ISmartDataTarget)
Purpose: Deregister a SmartDataTarget with the SmartDataSource. Usually done
when a SmartDataTarget is deleted and the SmartDataSource is still
running
Notes:

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The reference to the ISmartDataTarget to deregister
Top

DisposedHandler (Object, EventArgs)
Purpose: Event handler for the Disposed event of this instance
Notes:

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

EndInit ()
Purpose: Invoked at the end of a Containers InitializeComponents method
Notes: Enforced by System.ComponentModel.ISupportInitialize
http://msdn.microsoft.com/de-de/library/system.componentmodel.isupportinitialize.endinit(VS.80).aspx

Top

EndUpdateState (ISmartDataTarget)
Purpose: The Message to for instance enable a Browser is send to all
SmartDataTargets except the calling one.
Notes: This Method is called from the SmartViewerControl derived Class when
starting to Modify or Add data.
Enforced by Interface ISmartDataSource.

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The reference to the ISmartDataTarget that ends the UpdateState
Top

EndUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)
Purpose: Event handler for the EndUpdateState event of the SmartDataSource
Notes:

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

EndUpdateStateInDataSource (ISmartDataTarget)
Purpose: Invokes EndUpdateState in the SmartDataSource of this SmartDataAdapter
Notes: Method is overridable, so that a child class of this class (e.g.
SmartBusinessEntityAdapter) can override this and add further criteria
to the call

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The reference to the ISmartDataTarget that ends the UpdateState
Top

EvaluateTableIOState ()
Purpose: This Method is enforced by the Interface ISmartDataTarget and is
only required for visual DataTargets.
Notes: Required only for visual DataTargets (Viewer)

Top

LOGICAL FetchFirst ()
Purpose: This Method moves to the first DataRow inside the BindingSource.
Notes: It is called by The Navigation Tools of the Toolbars.
Enforced by Interface ISmartNavigationTarget.

Returns LOGICAL
Logical value, currently not used
Top

LOGICAL FetchLast ()
Purpose: This Method moves to the last DataRow inside the BindingSource.
Notes: It is called by The Navigation Tools of the Toolbars.
Enforced by Interface ISmartNavigationTarget.

Returns LOGICAL
Logical value, currently not used
Top

LOGICAL FetchNext ()
Purpose: This Method moves to the next DataRow inside the BindingSource.
Notes: It is called by The Navigation Tools of the Toolbars.
Enforced by Interface ISmartNavigationTarget.

Returns LOGICAL
Logical value, currently not used
Top

LOGICAL FetchPrev ()
Purpose: This Method moves to the previous DataRow inside the BindingSource.
Notes: It is called by The Navigation Tools of the Toolbars.
Enforced by Interface ISmartNavigationTarget.

Returns LOGICAL
Logical value, currently not used
Top

Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowser FindLinkedSmartDataBrowser ()
Purpose: Returns the reference to the linked SmartDataBrowser, if any
Notes: Returns ? when no browser is linked

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowser
The reference to the linked ISmartDataBrowser or ? when no browser is linked
Top

Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget FindLinkedUpdatingSmartDataTarget ()
Purpose: Returns the reference to the first linked ISmartDataTarget which is
also an ISmartTableIOTarget, that has a valid SmartTableIOSource assigned
Notes: Returns ? when no updating ISmartDataTarget is linked

Returns Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
The reference to the linked updating ISmartDataTarget as a ISmartTableIOTarget or ? when no updating ISmartDataTarget is linked
Top

CHARACTER GetFieldValues (character)
Purpose: Returns a CHR(1) delimited list of field values from the
DataSource
Notes: The fields parameter is a CHR(1) delimited list of field names.
Unqualified field names (CustNum) must exist in the first buffer
of the data source (e.g. Entity Table), qualified field names are
expected in the named buffer (eCustomer.CustNum)

Parameters:
pcFields CHARACTER
The comma delimited list of fields to return
Returns CHARACTER
The CHR(1) delimited list of field values
Top

CHARACTER GetRecordPosition ()
Purpose: Evaluates the current record position property value
Notes: Protected method so that child classes may have a different
implementation

Returns CHARACTER
The current record position as a CHARACTER representing an RecordPositionEnum value
Top

LOGICAL HasFields (character)
Purpose: Returns a logical value indicating if the SmartDataAdapter can provide
the given fields
Notes: Useful to validate if the GetFieldValues method can return values for
the given fields

Parameters:
pcFields CHARACTER
Comma delimited list of field names
Returns LOGICAL
Logical value indicating if the given fields are available in the Data Adapter instance
Top

LOGICAL HasUpdatingDataTarget ()
Purpose: Returns if the SmartDataAdapter has a SmartDataTarget that
is currently modifying data
Notes:

Returns LOGICAL
Logical value indicating if the SmartDataAdapter has a SmartDataTarget that is currently modifying data
Top

InvokeParentPositionChanged (Object, EventArgs)
Purpose: Invokes the ParentPositionChanged event handler in all connected
SmartDataAdapter instances
Notes:

Parameters:
sender System.Object
The reference to the sender associated with the event
e System.EventArgs
The reference to the System.EventArgs with the data for the event
Top

LOGICAL IsUpdating (logical)
Purpose: Returns if if this Adapter or any of it's Data-Target Adapters are
updating (a Data-Target with SmartTableIOState:ModifyingData)
Notes:

Parameters:
plIndirectOnly LOGICAL
Logical value indicating if only TableIOChilds of linked data adapters are tested
Returns LOGICAL
Logical value indicating if this Adapter or any of it's Data-Target Adapters are updating
Top

OffEndHandler (Object, OffEndEventArgs)
Purpose: Event handler for the OffEnd event of the ProBindingSource object
Notes: Used as abstract method / place holder here. Batching needs to be
supported by the actual DataAdapter class.

Parameters:
sender System.Object
The reference to the object that raised the event
e Progress.Data.OffEndEventArgs
The OffEndEventArgs with the data for the event
Top

OnAfterQueryPositionChanged (EventArgs)
Purpose: Raises the AfterQueryPositionChanged event
Notes:

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

OnAfterRetrieveData (EventArgs)
Purpose: Raises the AfterRetrieveData event
Notes: Invokes the AfterRetrieveDataCallback method in all subscribers

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

OnBeforeRetrieveData (CancelEventArgs)
Purpose: Raises the BeforeRetrieveData event
Notes:

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

OnBeginUpdateState (DataSourceUpdateStateEventArgs)
Purpose: Raises the BeginUpdateState event
Notes:

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

OnBindingSourceChanged (BindingSourceChangedEventArgs)
Purpose: Raises the BindingSourceChanged event
Notes:

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

OnCurrentChanged (EventArgs)
Purpose: Raises the CurrentChanged event
Notes:

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

OnEndUpdateState (DataSourceUpdateStateEventArgs)
Purpose: Raises the EndUpdateState event
Notes:

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

OnQueryClosed (EventArgs)
Purpose: Raises the QueryClosed
Notes:

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

OnSmartDataSourceChanged (EventArgs)
Purpose: Publishes the SmartGroupAssignSourceChanged event
Notes:

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

OnSmartNavigationTargetPositionChanged (SmartNavigationTargetPositionChangedEventArgs)
Purpose: Raises the SmartNavigationTargetPositionChanged event
Notes:

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

OnSmartNavigationTargetStateChanged (SmartNavigationTargetStateChangedEventArgs)
Purpose: Raises the SmartNavigationTargetStateChanged event
Notes:

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

ParentBindingSourceChangedHandler (Object, BindingSourceChangedEventArgs)
Purpose: Event Handler for the BindingSourceChanged event of the
SmartDataSource
Notes:

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

ParentPositionChanged (Object, EventArgs)
Purpose: This Method is invoked by the ParentPositionChangedBase Event Handler
of the SmartDataAdapters base class when the PositionChanged Event of
the SmartDataSources BindingSource is fired.
Notes: Refresh Data when a new line is selected inside the Parent
SmartDataSource.

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

ParentPositionChangedBase (Object, EventArgs)
Purpose: Handler for the PositionChanged Event of the SmartDataSources
BindingSource.
Notes: Calls the ParentPositionChanged Method which is implemented in the
specialized classes to refresh data.
The PositionChanged or CloseQuery Method is invoked
in all existing ChildSmartDataAdapter to refresh the Dataset inside
of them.

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

PositionChangedHandler (Object, EventArgs)
Purpose: Handler for the PositionChanged event of the BindingSource attached
to this SmartDataAdapter instance.
Notes: The current RecordPosition is passed to the SmartNavigationSource.

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

RegisterSmartDataTarget (ISmartDataTarget)
Purpose: Register a SmartDataTarget with the SmartDataSource.
This Method is called by Classes implementing the ISmartDataTarget
Interface when a new SmartDataSource is set.
Notes: After a new SmartDataTargetCollection Row is created this routine
tests if there is a valid BindingSource inside the new SmartDataTarget.
If there is one, the BindingSource of the SmartDataAdapter is disposed
and replaced by the one of the SmartDataTarget. A new BindingSource is
then populated to all SmartDataTargets of this SmartDataAdapter.
Enforced by Interface ISmartDataSource.

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The reference to the ISmartDataTarget to add to this SmartDataAdapter
Top

RemoveSmartNavigationSource (ISmartNavigationSource)
Purpose: Removes a SmartNavigationSource from the SmartDataAdapter
instance
Notes: Enabled multiple SmartNavigationSources to the SmartDataAdapter.

Parameters:
poSmartNavigationSource Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource
The reference to the ISmartNavigationSource to be removed
Top

RepositionToRowid (character)
Purpose: Repositions to a Rowid list from a character
Notes:

Parameters:
pcRowids CHARACTER
A comma delimited list of ROWIDs
Top

RepositionToRowid (rowid)
Purpose: Repositions to a single Rowid
Notes:

Parameters:
prRowid ROWID
The ROWID to reposition to
Top

RepositionToRowid (rowid[])
Purpose: Repositions to a Rowid Array
Notes:

Parameters:
prRowid ROWID
An Array of ROWIDs
Top

LOGICAL RetrieveData ()
Purpose: RetrieveData is an abstract method - that means that it needs
to be overridden in a class that inherits from this base class.
Enforced by Interface ISmartDataSource.
Notes: Do NOT call SUPER:RetrieveData() in the overriding method.
Remember to test if a BindingSource exists. If not call
CreateBindingSource from this base class.

Returns LOGICAL
Logical value indicating the success of the method, not always used
Top

SetSmartDataSource (ISmartDataSource)
Purpose: SetSmartDataSource sets the SmartDataSource of the current instance
of the SmartDataAdapter.
Notes: This Method is called from the Property Setter of SmartDataSource in
the Base Class.
Gets the ForeignFields from the hDataset which if not read before is
fetched from the Backend. Afterwards the backward handshake with the
SmartDataSource is completed and the Handler for the PositionChanged
Event is subscribed to be able to recognize that the Parent Data has
changed.
You do not need to call SetSmartDataSource () in the overriding method.

Parameters:
arg Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
The SmartDataSource for this instance
Top

SubscribeAfterRetrieveData (IAfterRetrieveDataSubscriber)
Purpose: Subscribes an instance of an object to the AfterRetrieveData
callback.
Notes: The object needs to implement the IAfterRetrieveDataSubscriber interface

Parameters:
poSubscriber Consultingwerk.SmartComponents.Interfaces.IAfterRetrieveDataSubscriber
The reference to the IAfterRetrieveDataSubscribe to add to the list of subscribers
Top

UpdateRow ()
Purpose: The UpdateRow is an abstract method - that means that it needs
to be overridden in a class that inherits from this base class.
Enforced by Interface ISmartDataSource.
Notes: Do NOT call SUPER:UpdateRow() in the overriding method.



Constructor Detail
Top

SmartDataAdapter ()
Purpose: The Constructor initializes a new SmartDataAdapter. The Default
Value for cSmartDataSourceState is set to Navigatable.
Notes:

Top

SmartDataAdapter (IContainer)
Purpose: The Constructor initializes a new SmartDataAdapter. The Default
Value for cSmartDataSourceState is set to Navigatable.
Notes:

Parameters:
poContainer System.ComponentModel.IContainer
The IContainer to add the current SmartDataAdapter to.


Event Detail
Top

AfterQueryPositionChanged DELEGATE System.EventHandler
Purpose: Event fired whenever the QueryPosition has changed (i.e. Add or
Delete and Grids etc. need to update the current position)
Notes:

Delegate: System.EventHandler
Top

AfterRetrieveData DELEGATE System.EventHandler
Purpose: Event fired whenever the SmartDataAdapter has opened a new query
Notes:

Delegate: System.EventHandler
Top

BeforeRetrieveData DELEGATE System.ComponentModel.CancelEventHandler
Purpose: Event fired before the SmartDataAdapter is about to open a new query
Notes:

Delegate: System.ComponentModel.CancelEventHandler
Top

BeginUpdateState (Object, DataSourceUpdateStateEventArgs)
Purpose: Event raised when a ISmartDataTarget of this SmartDataAdapter instance
begins the update state
Notes:

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

BindingSourceChanged (Object, BindingSourceChangedEventArgs)
Purpose: Event fired whenever the SmartDataAdapters BindingSource property
changes
Notes:

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

CurrentChanged DELEGATE System.EventHandler
Purpose: Raised whenever the Data Adapter is positioned on a new row.
Notes: The event is raised, when the BindingSource PositionChanged event
is raised, when the ParentPosition has changed and the Query is closed
etc.

Delegate: System.EventHandler
Top

EndUpdateState (Object, DataSourceUpdateStateEventArgs)
Purpose: Event raised when a ISmartDataTarget of this SmartDataAdapter instance
ends the update state
Notes:

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

QueryClosed DELEGATE System.EventHandler
Purpose: Raised when the CloseQuery method is called
Notes: E.g. when the parent SmartDataAdapter of the current instance does
not hold any record anymore

Delegate: System.EventHandler
Top

SmartDataSourceChanged DELEGATE System.EventHandler
Purpose: Event fired when the SmartDataSource Property is changed
Notes:

Delegate: System.EventHandler
Top

SmartNavigationTargetPositionChanged (Object, SmartNavigationTargetPositionChangedEventArgs)
Purpose: Event fired whenever the RecordPosition properties has changed
Notes:

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

SmartNavigationTargetStateChanged (Object, SmartNavigationTargetStateChangedEventArgs)
Purpose: Event fired whenever the SmartDataSourceState property has changed
Notes:

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


Property Detail
Top

CHARACTER AppServerPartition

Returns CHARACTER
Top

LOGICAL Available

Returns LOGICAL
Top

Progress.Data.BindingSource BindingSource

Returns Progress.Data.BindingSource
Top

CHARACTER BindingSourceExcludeFields

Returns CHARACTER
Top

CHARACTER BindingSourceIncludeFields

Returns CHARACTER
Top

Progress.Data.BindingSource DataSourceBindingSource

Returns Progress.Data.BindingSource
Top

LOGICAL Initializing

Returns LOGICAL
Top

Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource LinkNavigationSource

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource
Top

INTEGER PreviousPosition

Returns INTEGER
Top

CHARACTER RecordPosition

Returns CHARACTER
Top

Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
Top

LOGICAL SmartDataSourceActive

Returns LOGICAL
Top

CHARACTER SmartDataSourceState

Returns CHARACTER
Top

Consultingwerk.SmartComponents.Base.ListISmartDataTarget SmartDataTargets

Returns Consultingwerk.SmartComponents.Base.ListISmartDataTarget
Top

Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource SmartNavigationSource

Returns Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource
Top

Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget UpdatingSmartDataTarget

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget


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