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

Inherits: Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

File:SmartDataObjectAdapter
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun May 31 10:03:56 CEST 2009
Purpose: Gets if the SmartDataObjectAdapter is currently adding a new
row
Notes:

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)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# AddRecordInUpdatableGrid () Ensures an updatable browser is in the correct adding state after a record was created through the Binding Source event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ AddSmartNavigationSource (ISmartNavigationSource) Adds a(nother) SmartNavigationSource to the SmartDataAdapter instance
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL AssignQuerySelection (character, character, character) Assigns selection criteria to the query and distributes the column/value pairs to the corresponding buffer's where-clause. Each buffer's expression will always be embedded in parenthesis.
+ 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.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# AttachSchemaToBindingSource (BindingSource) Attaches the Data Schema to the BindingSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ BeginInit () Invoked at the beginning of a Containers InitializeComponents method
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ BeginUpdateState (ISmartDataTarget) The Message to for instance Disable a Browser is send to all SmartDataTargets except the calling one
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# BeginUpdateStateHandler (Object, DataSourceUpdateStateEventArgs) Event handler for the BeginUpdateState event of the SmartDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ CancelCreateRecord () Invoked from the SmartDataTarget to cancel the creation of a new row
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# CancelCreateRowHandler (Object, CancelCreateRowEventArgs) Event Handler for the CancelCreateRow event of the ProBindingSource
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CancelCreateRowHandler (Object, CancelCreateRowEventArgs)
+ CloseQuery () Empties the result set of this SmartDataAdapter. Used to clear grids
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CloseQuery ()
+ CHARACTER ColumnDataType (character) Returns the ABL data-type of the column
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# HANDLE ConnectService () Returns the handle of the AppServer partition associated with this SmartDataAdapter
Inherited from Consultingwerk.SmartComponents.Base.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.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ CreateRecord () Invoked from the SmartDataTarget to create a new row
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# CreateRowHandler (Object, CreateRowEventArgs) Handler for the CreateRow event of the ProBindingSource
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CreateRowHandler (Object, CreateRowEventArgs)
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ DeactivateSmartViewerEventHandler () Activates SmartViewer TextChanged/CheckedChanged Event Handlers after a navigation (FetchFirst/FetchNext/FetchPrev/FetchLast) */
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# LOGICAL DeleteQueryRow () This protected method can be used to remove the current row from a Query. This method calls DeleteQueryRow(FALSE).
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# 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.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ DeleteRow () Deletes the current row.
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:DeleteRow ()
+ DeregisterSmartDataTarget (ISmartDataTarget) Deregister a SmartDataTarget with the SmartDataSource. Usually done when a SmartDataTarget is deleted and the SmartDataSource is still running
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# DesignerOpenSmartDataObject ()
# DestroySmartDataObject () Destroys the SmartDataObject instance
# DisposedHandler (Object, EventArgs) Event handler for the Disposed event of this instance
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ EndInit () Invoked at the end of a Containers InitializeComponents method
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ EndUpdateState (ISmartDataTarget) The Message to for instance enable a Browser is send to all SmartDataTargets except the calling one.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# EndUpdateStateHandler (Object, DataSourceUpdateStateEventArgs) Event handler for the EndUpdateState event of the SmartDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# EndUpdateStateInDataSource (ISmartDataTarget) Invokes EndUpdateState in the SmartDataSource of this SmartDataAdapter
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ EvaluateTableIOState () This Method is enforced by the Interface ISmartDataTarget and is only required for visual DataTargets.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL FetchFirst () This Method moves to the first DataRow inside the BindingSource.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL FetchLast () This Method moves to the last DataRow inside the BindingSource. It is called by The Navigation Tools of the Toolbars. Enforced by Interface ISmartNavigationTarget.
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:FetchLast ()
+ LOGICAL FetchNext () This Method moves to the next DataRow inside the BindingSource.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL FetchPrev () This Method moves to the previous DataRow inside the BindingSource.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowser FindLinkedSmartDataBrowser () Returns the reference to the linked SmartDataBrowser, if any
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget FindLinkedUpdatingSmartDataTarget () Returns the reference to the first linked ISmartDataTarget which is also an ISmartTableIOTarget, that has a valid SmartTableIOSource assigned
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ AttributeCollection GetAttributes () Returns a collection of custom attributes for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ CHARACTER GetClassName () Returns the class name of this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ CHARACTER GetComponentName () Returns the name of this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ TypeConverter GetConverter () Returns a type converter for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ EventDescriptor GetDefaultEvent () Returns the default event for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ PropertyDescriptor GetDefaultProperty () Returns the default property for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ System.Object GetEditor (Type) Returns an editor of the specified type for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ EventDescriptorCollection GetEvents () Returns the events for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ EventDescriptorCollection GetEvents (Attribute[]) Returns the events for this instance of a component using the specified attribute array as a filter.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ CHARACTER GetFieldValues (character) Returns a CHR(1) delimited list of field values from the DataSource
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:GetFieldValues (character)
+ PropertyDescriptorCollection GetProperties () Returns the properties for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ PropertyDescriptorCollection GetProperties (Attribute[]) Returns the properties for this instance of a component using the attribute array as a filter.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ System.Object GetPropertyOwner (PropertyDescriptor) Returns an object that contains the property described by the specified property descriptor.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER GetRecordPosition () Evaluates the current record position property value
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:GetRecordPosition ()
+ GetSmartDataObjectError () Formats Error message returned from the SmartDataObject using the SmartDataObject error class Error messages are returned using the fetchMessages API
+ LOGICAL HasFields (character) Returns a logical value indicating if the SmartDataAdapter can provide the given fields
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL HasUpdatingDataTarget () Returns if the SmartDataAdapter has a SmartDataTarget that is currently modifying data
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ InitializeSmartDataObject () Initializes the SmartDataObject by running initializeObject
# InvokeParentPositionChanged (Object, EventArgs) Invokes the ParentPositionChanged event handler in all connected SmartDataAdapter instances
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL IsUpdating (logical) Returns if if this Adapter or any of it's Data-Target Adapters are updating (a Data-Target with SmartTableIOState:ModifyingData)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# LaunchSmartDataObject () Launches the SmartDataObject associated with this Data Adapter instance
# OffEndHandler (Object, OffEndEventArgs) Event handler for the OffEnd event of the ProBindingSource object
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:OffEndHandler (Object, OffEndEventArgs)
# OnAfterQueryPositionChanged (EventArgs) Raises the AfterQueryPositionChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnAfterRetrieveData (EventArgs) Raises the AfterRetrieveData event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnBeforeRetrieveData (CancelEventArgs) Raises the BeforeRetrieveData event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnBeginUpdateState (DataSourceUpdateStateEventArgs) Raises the BeginUpdateState event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnBindingSourceChanged (BindingSourceChangedEventArgs) Raises the BindingSourceChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnCurrentChanged (EventArgs) Raises the CurrentChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnEndUpdateState (DataSourceUpdateStateEventArgs) Raises the EndUpdateState event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnQueryClosed (EventArgs) Raises the QueryClosed
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnSmartDataSourceChanged (EventArgs) Publishes the SmartGroupAssignSourceChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnSmartNavigationTargetPositionChanged (SmartNavigationTargetPositionChangedEventArgs) Raises the SmartNavigationTargetPositionChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnSmartNavigationTargetStateChanged (SmartNavigationTargetStateChangedEventArgs) Raises the SmartNavigationTargetStateChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Overrides Consultingwerk.SmartComponents.Base.SmartComponent:OnVerbClicked (character)
+ LOGICAL OpenQuery () Opens the SmartDataObjects Query by calling RetrieveData
+ ParentBindingSourceChangedHandler (Object, BindingSourceChangedEventArgs) Event Handler for the BindingSourceChanged event of the SmartDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ 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.
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:ParentPositionChanged (Object, EventArgs)
+ F ParentPositionChangedBase (Object, EventArgs) Handler for the PositionChanged Event of the SmartDataSources BindingSource.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# PositionChangedHandler (Object, EventArgs) Handler for the PositionChanged event of the BindingSource attached to this SmartDataAdapter instance.
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:PositionChangedHandler (Object, EventArgs)
+ RegisterSmartDataTarget (ISmartDataTarget) Register a SmartDataTarget with the SmartDataSource. This Method is called by Classes implementing the ISmartDataTarget Interface when a new SmartDataSource is set.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL RemoveQuerySelection (character, character) Remove field expression(s) for specified column(s) and operator(s) added by assignQuerySelection from the query.
+ RemoveSmartNavigationSource (ISmartNavigationSource) Removes a SmartNavigationSource from the SmartDataAdapter instance
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ RepositionToRowid (character) Repositions to a Rowid list from a character
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ RepositionToRowid (rowid) Repositions to a single Rowid
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ RepositionToRowid (rowid[]) Repositions to a Rowid Array
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL RetrieveData () Retrieves data from the SmartDataObject and binds the RowObject temp-table to a ProBindingSource
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:RetrieveData ()
- SetDesignerProperties () Sets Properties to customize Visual Designer behavior
# SetSmartDataSource (ISmartDataSource) SetSmartDataSource sets the SmartDataSource of the current instance of the SmartDataAdapter.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ SubscribeAfterRetrieveData (IAfterRetrieveDataSubscriber) Subscribes an instance of an object to the AfterRetrieveData callback.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ UpdateRow () UpdateRow submits the changes to a buffer into the using the SmartDataObject API Called by a DataTarget when it's required to save data. * Enforced by Interface ISmartDataSource.
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:UpdateRow ()

Top Constructor Summary
Options Name Purpose
+ SmartDataObjectAdapter () Constructor for the SmartDataObjectAdapter class
+ SmartDataObjectAdapter (IContainer) Constructor for the SmartDataObjectAdapter class

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)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ AfterRetrieveData DELEGATE System.EventHandler Event fired whenever the SmartDataAdapter has opened a new query
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ BeforeRetrieveData DELEGATE System.ComponentModel.CancelEventHandler Event fired before the SmartDataAdapter is about to open a new query
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ BeginUpdateState (Object, DataSourceUpdateStateEventArgs) Event raised when a ISmartDataTarget of this SmartDataAdapter instance begins the update state
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ BindingSourceChanged (Object, BindingSourceChangedEventArgs) Event fired whenever the SmartDataAdapters BindingSource property changes
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ CurrentChanged DELEGATE System.EventHandler Raised whenever the Data Adapter is positioned on a new row.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ EndUpdateState (Object, DataSourceUpdateStateEventArgs) Event raised when a ISmartDataTarget of this SmartDataAdapter instance ends the update state
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ QueryClosed DELEGATE System.EventHandler Raised when the CloseQuery method is called
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ SmartDataSourceChanged DELEGATE System.EventHandler Event fired when the SmartDataSource Property is changed
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ SmartNavigationTargetPositionChanged (Object, SmartNavigationTargetPositionChangedEventArgs) Event fired whenever the RecordPosition properties has changed
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ SmartNavigationTargetStateChanged (Object, SmartNavigationTargetStateChangedEventArgs) Event fired whenever the SmartDataSourceState property has changed
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Top Property Summary
Options Name Purpose
+ LOGICAL AddingRecord
+ CHARACTER AddRowIdent
+ CHARACTER AppServerPartition
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL Available
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ INTEGER BatchSize
# CHARACTER BindableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ Progress.Data.BindingSource BindingSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ CHARACTER BindingSourceExcludeFields
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ CHARACTER BindingSourceIncludeFields
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# CHARACTER CategorizedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER CategoryProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ HANDLE DataHandle
+ Progress.Data.BindingSource DataSourceBindingSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# CHARACTER DescribedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DescriptionProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# LOGICAL DesignerHostLoading
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# LOGICAL DesingerHostLoading
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ CHARACTER ForeignFields
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ LOGICAL Initializing
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource LinkNavigationSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ LOGICAL OpenSmartDataObject
# INTEGER PreviousPosition
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ CHARACTER RecordPosition
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ HANDLE RowObject
+ INTEGER RowsToBatch
+ HANDLE SmartDataObjectHandle
+ LOGICAL SmartDataObjectInitialized
+ CHARACTER SmartDataObjectName
+ Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL SmartDataSourceActive
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ CHARACTER SmartDataSourceState
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ Consultingwerk.SmartComponents.Base.ListISmartDataTarget SmartDataTargets
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource SmartNavigationSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget UpdatingSmartDataTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter


Method Detail
Top

PROTECTED ActivateSmartViewerEventHandler ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Activates SmartViewer TextChanged/CheckedChanged Event Handlers
after a navigation (FetchFirst/FetchNext/FetchPrev/FetchLast)
Notes:

Top

PROTECTED AddRecordInUpdatableGrid ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC AddSmartNavigationSource (ISmartNavigationSource)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC LOGICAL AssignQuerySelection (character, character, character)
Purpose: Assigns selection criteria to the query and distributes the
column/value pairs to the corresponding buffer's where-clause.
Each buffer's expression will always be embedded in parenthesis.
Notes: Calls assignQuerySelection in the SmartDataObject
Can be called before initialization, but the alternative string
operator is not supported before the object is initialized.
(datatype is not known)
- This procedure is designed to be called several times to build up
the the query's where clause
(storing intermediate results in the QueryString property) before
it is finally used in a Query-Prepare method.
- openDataQuery takes care of the preparation of the QueryString
property.
- The QueryColumns property is used to ensure that each column and
operator only will be added once to the QueryString. The property is
also used to store the offset and length of the corresponding values.

Parameters:
pcColumns CHARACTER
Column names (Comma separated), Fieldname of a table in the query in the form of TBL.FLDNM or DB.TBL.FLDNM (only if qualified with db is specified), (RowObject.FLDNM should be used for SDO's) If the fieldname isn't qualified it checks the tables in the TABLES property and assumes the first with a match.
pcValues CHARACTER
Corresponding Values (CHR(1) separated)
pcOperators CHARACTER
Operator one for all columns, blank - defaults to EQ, Use slash to define alternative string operator EQ/BEGINS etc., comma separated for each column/value
Returns LOGICAL
Return value from ADM2 assignQuerySelection, always TRUE
Top

PUBLIC AttachBindingSource (BindingSource)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED AttachSchemaToBindingSource (BindingSource)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC BeginInit ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC BeginUpdateState (ISmartDataTarget)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED BeginUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC CancelCreateRecord ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Invoked from the SmartDataTarget to cancel the creation of a new
row
Notes:

Top

PROTECTED CancelCreateRowHandler (Object, CancelCreateRowEventArgs)
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CancelCreateRowHandler (Object, CancelCreateRowEventArgs)
Purpose: Event Handler for the CancelCreateRow event of the ProBindingSource
Notes: Comments from cancelRow in data.p:
cancelRow calls doUndoUpdate which restores the original values
of a modified row from the RowObjUpd record then deletes the
RowObjUdp record. In the case of newMode, the new
RowObject is deleted and doUndoUpdate repositions the
RowObject temp-table to what was previously the current row.

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

PUBLIC CloseQuery ()
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CloseQuery ()
Purpose: Empties the result set of this SmartDataAdapter. Used to clear grids
Notes: Empty the RowObject temp-table and reopens the query

Top

PUBLIC CHARACTER ColumnDataType (character)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED HANDLE ConnectService ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED CreateBindingSource ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC CreateRecord ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Invoked from the SmartDataTarget to create a new row
Notes:

Top

PROTECTED CreateRowHandler (Object, CreateRowEventArgs)
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CreateRowHandler (Object, CreateRowEventArgs)
Purpose: Handler for the CreateRow event of the ProBindingSource
Notes: Comments from addRow in data.p:
Creates a new RowObject temp-table record, initializes it, and
returns CHR(1) delimited list of values for the requested
columns (in pcViewColList) of the new RowObject row.
The first entry in the list is the RowObject ROWID and db RowIds
separated with commas. (The db Rowids are blank as the record
has not been created)

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

PROTECTED CreateVerbs ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PUBLIC DeactivateSmartViewerEventHandler ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Activates SmartViewer TextChanged/CheckedChanged Event Handlers
after a navigation (FetchFirst/FetchNext/FetchPrev/FetchLast)

Top

PROTECTED LOGICAL DeleteQueryRow ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED LOGICAL DeleteQueryRow (logical)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC DeleteRow ()
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:DeleteRow ()
Purpose: Deletes the current row.
Notes:

Top

PUBLIC DeregisterSmartDataTarget (ISmartDataTarget)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED DesignerOpenSmartDataObject ()
Purpose:
Notes:

Top

PROTECTED DestroySmartDataObject ()
Purpose: Destroys the SmartDataObject instance
Notes:

Top

PROTECTED DisposedHandler (Object, EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC EndInit ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC EndUpdateState (ISmartDataTarget)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED EndUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED EndUpdateStateInDataSource (ISmartDataTarget)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC EvaluateTableIOState ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: This Method is enforced by the Interface ISmartDataTarget and is
only required for visual DataTargets.
Notes: Required only for visual DataTargets (Viewer)

Top

PUBLIC LOGICAL FetchFirst ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC LOGICAL FetchLast ()
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:FetchLast ()
Purpose: This Method moves to the last DataRow inside the BindingSource.
It is called by The Navigation Tools of the Toolbars.
Enforced by Interface ISmartNavigationTarget.
Notes: Local override that allows to fetch the last batch from the SDO
before moving the BindingSource

Returns LOGICAL
Logical value, currently not used
Top

PUBLIC LOGICAL FetchNext ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC LOGICAL FetchPrev ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowser FindLinkedSmartDataBrowser ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget FindLinkedUpdatingSmartDataTarget ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC AttributeCollection GetAttributes ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns a collection of custom attributes for this instance of a
component.
Notes:

Returns AttributeCollection
The System.ComponentModel.AttributeCollection describing the types attributes
Top

PUBLIC CHARACTER GetClassName ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns the class name of this instance of a component.
Notes:

Returns CHARACTER
The class name of the Component
Top

PUBLIC CHARACTER GetComponentName ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns the name of this instance of a component.
Notes:

Returns CHARACTER
The Component Name of this instance
Top

PUBLIC TypeConverter GetConverter ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns a type converter for this instance of a component.
Notes:

Returns TypeConverter
The System.ComponentModel.TypeConverter for this instance of a component.
Top

PUBLIC EventDescriptor GetDefaultEvent ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns the default event for this instance of a component.
Notes:

Returns EventDescriptor
The System.ComponentModel.EventDescriptor for the default event of this component
Top

PUBLIC PropertyDescriptor GetDefaultProperty ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns the default property for this instance of a component.
Notes:

Returns PropertyDescriptor
The System.ComponentModel.PropertyDescriptor for the default property of the component
Top

PUBLIC System.Object GetEditor (Type)
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns an editor of the specified type for this instance of a
component.
Notes:

Parameters:
editorBaseType System.Type
A System.Type that represents the editor for this object.
Returns System.Object
The reference to the Editor of the type of the component instance
Top

PUBLIC EventDescriptorCollection GetEvents ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns the events for this instance of a component.
Notes:

Returns EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC EventDescriptorCollection GetEvents (Attribute[])
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns the events for this instance of a component using the
specified attribute array as a filter.
Notes:

Parameters:
attributes System.Attribute[]
A System.Attribute[] that is used as a filter.
Returns EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC CHARACTER GetFieldValues (character)
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:GetFieldValues (character)
Purpose: Returns a CHR(1) delimited list of field values from the
DataSource
Notes: Uses SDO function colValues

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

PUBLIC PropertyDescriptorCollection GetProperties ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns the properties for this instance of a component.
Notes:

Returns PropertyDescriptorCollection
A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.
Top

PUBLIC PropertyDescriptorCollection GetProperties (Attribute[])
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns the properties for this instance of a component using the
attribute array as a filter.
Notes:

Parameters:
attributes System.Attribute[]
A System.Attribute[] that is used as a filter.
Returns PropertyDescriptorCollection
A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.
Top

PUBLIC System.Object GetPropertyOwner (PropertyDescriptor)
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns an object that contains the property described by the
specified property descriptor.
Notes:

Parameters:
pd PropertyDescriptor
A System.ComponentModel.PropertyDescriptor that represents the property whose owner is to be found.
Returns System.Object
An System.Object that represents the owner of the specified property.
Top

PROTECTED CHARACTER GetRecordPosition ()
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:GetRecordPosition ()
Purpose: Evaluates the current record position property value
Notes: Translates QueryPosition from SDO to RecordPosition property

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

PUBLIC GetSmartDataObjectError ()
Purpose: Formats Error message returned from the SmartDataObject using
the SmartDataObject error class
Error messages are returned using the fetchMessages API
Notes: THROWS SmartDataObjectValidationError

Top

PUBLIC LOGICAL HasFields (character)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC LOGICAL HasUpdatingDataTarget ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC InitializeSmartDataObject ()
Purpose: Initializes the SmartDataObject by running initializeObject
Notes: PROTECTED method can be overridden in a child class, to add
customization

Top

PROTECTED InvokeParentPositionChanged (Object, EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC LOGICAL IsUpdating (logical)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED LaunchSmartDataObject ()
Purpose: Launches the SmartDataObject associated with this Data Adapter
instance
Notes: Original code is in constructObject in adm2/containr.p

Top

PROTECTED OffEndHandler (Object, OffEndEventArgs)
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:OffEndHandler (Object, OffEndEventArgs)
Purpose: Event handler for the OffEnd event of the ProBindingSource object
Notes: Overrides OffEndHandler in SmartDataAdapter base 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

PROTECTED OnAfterQueryPositionChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Raises the AfterQueryPositionChanged event
Notes:

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

PROTECTED OnAfterRetrieveData (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED OnBeforeRetrieveData (CancelEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Raises the BeforeRetrieveData event
Notes:

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

PROTECTED OnBeginUpdateState (DataSourceUpdateStateEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Raises the BeginUpdateState event
Notes:

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

PROTECTED OnBindingSourceChanged (BindingSourceChangedEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Raises the BindingSourceChanged event
Notes:

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

PROTECTED OnCurrentChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Raises the CurrentChanged event
Notes:

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

PROTECTED OnEndUpdateState (DataSourceUpdateStateEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Raises the EndUpdateState event
Notes:

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

PROTECTED OnQueryClosed (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Raises the QueryClosed
Notes:

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

PROTECTED OnSmartDataSourceChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Publishes the SmartGroupAssignSourceChanged event
Notes:

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

PROTECTED OnSmartNavigationTargetPositionChanged (SmartNavigationTargetPositionChangedEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Raises the SmartNavigationTargetPositionChanged event
Notes:

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

PROTECTED OnSmartNavigationTargetStateChanged (SmartNavigationTargetStateChangedEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Raises the SmartNavigationTargetStateChanged event
Notes:

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

PUBLIC OnVerbClicked (character)
Overrides Consultingwerk.SmartComponents.Base.SmartComponent:OnVerbClicked (character)
Purpose: Event Handler method for Designer Verbs
Notes: This method is intended to be overridden

Parameters:
pcVerbText CHARACTER
The text indicating the verb that was clicked
Top

PUBLIC LOGICAL OpenQuery ()
Purpose: Opens the SmartDataObjects Query by calling RetrieveData
Notes:

Returns LOGICAL
Logical value indicating the success of the method
Top

PUBLIC ParentBindingSourceChangedHandler (Object, BindingSourceChangedEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC ParentPositionChanged (Object, EventArgs)
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter: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

PUBLIC ParentPositionChangedBase (Object, EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PROTECTED PositionChangedHandler (Object, EventArgs)
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter: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

PUBLIC RegisterSmartDataTarget (ISmartDataTarget)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC LOGICAL RemoveQuerySelection (character, character)
Purpose: Remove field expression(s) for specified column(s) and operator(s)
added by assignQuerySelection from the query.
Notes: This procedure modifies the QueryString property.
openQuery will prepare the query using this property.
The removal of the actual field expression is done by the help
of the position and length stored in the QueryColumns property.

Parameters:
pcColumns CHARACTER
Column names (Comma separated)
pcOperators CHARACTER
Operator - one for all columns, blank - defaults to (EQ), Use slash to define alternative string operator, EQ/BEGINS etc.., comma separated for each column/value
Returns LOGICAL
Return value from ADM2 removeQuerySelection, always TRUE
Top

PUBLIC RemoveSmartNavigationSource (ISmartNavigationSource)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC RepositionToRowid (character)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Repositions to a Rowid list from a character
Notes:

Parameters:
pcRowids CHARACTER
A comma delimited list of ROWIDs
Top

PUBLIC RepositionToRowid (rowid)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Repositions to a single Rowid
Notes:

Parameters:
prRowid ROWID
The ROWID to reposition to
Top

PUBLIC RepositionToRowid (rowid[])
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Repositions to a Rowid Array
Notes:

Parameters:
prRowid ROWID
An Array of ROWIDs
Top

PUBLIC LOGICAL RetrieveData ()
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:RetrieveData ()
Purpose: Retrieves data from the SmartDataObject and binds the RowObject
temp-table to a ProBindingSource
Notes:

Returns LOGICAL
Logical value indicating the success of the method
Top

PRIVATE SetDesignerProperties ()
Purpose: Sets Properties to customize Visual Designer behavior
Notes:

Top

PROTECTED SetSmartDataSource (ISmartDataSource)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC SubscribeAfterRetrieveData (IAfterRetrieveDataSubscriber)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC UpdateRow ()
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:UpdateRow ()
Purpose: UpdateRow submits the changes to a buffer into the using the
SmartDataObject API
Called by a DataTarget when it's required to save data.
Enforced by Interface ISmartDataSource.
Notes: Do NOT call SUPER:UpdateRow() in the overriding method.
Parameters required for submitRow in data.p:
INPUT pcRowIdent - "key" with row to update.
The RowObject ROWID, typically derived from the visual
DataTarget's RowIdent property, which often also
has an additional list of the ROWID(s) of the db
record(s). This appended list is not used here and is thus
not required.
- ? indicates current record.
INPUT pcValueList - CHR(1) delimited list of alternating column names
and values to be assigned.



Constructor Detail
Top

PUBLIC SmartDataObjectAdapter ()
Purpose: Constructor for the SmartDataObjectAdapter class
Notes:

Top

PUBLIC SmartDataObjectAdapter (IContainer)
Purpose: Constructor for the SmartDataObjectAdapter class
Notes:

Parameters:
poContainer System.ComponentModel.IContainer
The System.ComponentModel.IContainer used as the Container for this component


Event Detail
Top

PUBLIC AfterQueryPositionChanged DELEGATE System.EventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC AfterRetrieveData DELEGATE System.EventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Event fired whenever the SmartDataAdapter has opened a new query
Notes:

Delegate: System.EventHandler
Top

PUBLIC BeforeRetrieveData DELEGATE System.ComponentModel.CancelEventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Event fired before the SmartDataAdapter is about to open a new query
Notes:

Delegate: System.ComponentModel.CancelEventHandler
Top

PUBLIC BeginUpdateState (Object, DataSourceUpdateStateEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC BindingSourceChanged (Object, BindingSourceChangedEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC CurrentChanged DELEGATE System.EventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC EndUpdateState (Object, DataSourceUpdateStateEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC QueryClosed DELEGATE System.EventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC SmartDataSourceChanged DELEGATE System.EventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
Purpose: Event fired when the SmartDataSource Property is changed
Notes:

Delegate: System.EventHandler
Top

PUBLIC SmartNavigationTargetPositionChanged (Object, SmartNavigationTargetPositionChangedEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC SmartNavigationTargetStateChanged (Object, SmartNavigationTargetStateChangedEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC LOGICAL AddingRecord

Returns LOGICAL
Top

PUBLIC CHARACTER AddRowIdent

Returns CHARACTER
Top

PUBLIC CHARACTER AppServerPartition
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns CHARACTER
Top

PUBLIC LOGICAL Available
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns LOGICAL
Top

PUBLIC INTEGER BatchSize

Returns INTEGER
Top

PROTECTED CHARACTER BindableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PUBLIC Progress.Data.BindingSource BindingSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns Progress.Data.BindingSource
Top

PUBLIC CHARACTER BindingSourceExcludeFields
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns CHARACTER
Top

PUBLIC CHARACTER BindingSourceIncludeFields
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PUBLIC HANDLE DataHandle

Returns HANDLE
Top

PUBLIC Progress.Data.BindingSource DataSourceBindingSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns Progress.Data.BindingSource
Top

PROTECTED CHARACTER DescribedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED LOGICAL DesignerHostLoading
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns LOGICAL
Top

PROTECTED CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns LOGICAL
Top

PROTECTED LOGICAL DesingerHostLoading
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns LOGICAL
Top

PUBLIC CHARACTER ForeignFields

Returns CHARACTER
Top

PROTECTED CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PUBLIC LOGICAL Initializing
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns LOGICAL
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource LinkNavigationSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource
Top

PROTECTED CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PUBLIC LOGICAL OpenSmartDataObject

Returns LOGICAL
Top

PROTECTED INTEGER PreviousPosition
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns INTEGER
Top

PUBLIC CHARACTER RecordPosition
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns CHARACTER
Top

PUBLIC HANDLE RowObject

Returns HANDLE
Top

PUBLIC INTEGER RowsToBatch

Returns INTEGER
Top

PUBLIC HANDLE SmartDataObjectHandle

Returns HANDLE
Top

PUBLIC LOGICAL SmartDataObjectInitialized

Returns LOGICAL
Top

PUBLIC CHARACTER SmartDataObjectName

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
Top

PUBLIC LOGICAL SmartDataSourceActive
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns LOGICAL
Top

PUBLIC CHARACTER SmartDataSourceState
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Base.ListISmartDataTarget SmartDataTargets
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns Consultingwerk.SmartComponents.Base.ListISmartDataTarget
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource SmartNavigationSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget UpdatingSmartDataTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:01:49