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

Inherits: Consultingwerk.SmartComponents.Base.SmartDataAdapter
Implements: Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource, Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget, ICustomTypeDescriptor, Consultingwerk.SmartComponents.Implementation.IDatasetControllerConsumer, Consultingwerk.SmartComponents.Interfaces.Design.IDesignGroupCreateSource, IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.IProvidesRecordKey, Consultingwerk.SmartComponents.Implementation.ISmartBusinessEntityAdapterEvents, Consultingwerk.SmartComponents.Interfaces.ISmartDataSource, Consultingwerk.SmartComponents.Interfaces.ISmartDataSourceWithDataset, Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget, Consultingwerk.SmartComponents.Interfaces.ISmartFilterTarget, Consultingwerk.SmartComponents.Interfaces.ISmartGroupCreateSource, Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget, Consultingwerk.SmartComponents.Interfaces.ISortableDataSource, Consultingwerk.SmartComponents.Interfaces.IStoresCopiedFrom, Consultingwerk.SmartComponents.Interfaces.ISupportsReposition, Consultingwerk.SmartComponents.Interfaces.ISupportsSubmitChanges, System.ComponentModel.ISupportInitialize
Inherited by: Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.SmartBusinessEntityAdapterTester Consultingwerk.SmartComponents.Implementation.SmartDatasetChildAdapter
ABSTRACT

File:SmartDatasetAdapter
Purpose:Shared base class of the SmartBusinessEntityAdapter and
the SmartDatasetChildAdapter
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Dec 28 20:41:59 CET 2010
Notes:Contains common code from SmartBusinessEntityAdapter and
SmartDatasetChildAdapter as of change # 16369

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
+ 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
# A AttachQueryToBindingSource () Attaches the Query/ProDataset to the BindingSource
# AttachSchemaToBindingSource (BindingSource) Attaches the schema to the BindingSource
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:AttachSchemaToBindingSource (BindingSource)
+ BeginInit () Invoked at the beginning of a Containers InitializeComponents method
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ A BeginTransactionState () Begins a transaction when starting update
+ BeginUpdateState (ISmartDataTarget) The Message to for instance Disable a Browser is send to all SmartDataTargets except the calling one
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:BeginUpdateState (ISmartDataTarget)
# 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
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CancelCreateRecord ()
# CancelCreateRowHandler (Object, CancelCreateRowEventArgs) Handler for the CancelCreateRow event of the ProBindingSource. A Row that has been created using CreateRowHandler gets reverted.
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CancelCreateRowHandler (Object, CancelCreateRowEventArgs)
+ CancelInDataTargets () Recursively invokes CancelUpdate in all DataTargets that are currently updating
+ ClearPreviousQueryString (logical) Clears the PreviousQueryString information to ensure that the ParentPositionChanged event handler does reopen the query regardless of identical key values
+ 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
+ CreateParentRecord (character) Creates a parent record when needed for creating a record in a SmartGroupCreateTarget
+ CreateRecord () Creates a new record
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CreateRecord ()
# CreateRowHandler (Object, CreateRowEventArgs) Event 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 record from the EntityTable
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
+ DeregisterSmartGroupCreateTarget (ISmartGroupCreateTarget) Deregister a SmartGroupCreateTarget with the SmartGroupCreateSource *
# 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
# CHARACTER EvaluateParentQuery () Evaluates the QueryString based on the Parent Filter Fields
# CHARACTER EvaluateParentQuery (logical) Evaluates the QueryString based on the Parent Filter Fields
# A CHARACTER EvaluateParentQueryAfterUpdate () Evaluates the QueryString based on the Parent Filter Fields after UpdateRow
+ 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.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ 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
+ LOGICAL FindLastRowWhere (character) Finds the last a row in the EntityTable and locates the BindingSource to that row
+ Consultingwerk.SmartComponents.Base.SmartDatasetAdapter FindLinkedDatasetAdapterForEntityTable (character) Searches for a linked SmartDatasetAdapter with the given entity table
+ 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
+ LOGICAL FindRowWhere (character) Finds a row in the EntityTable and locates the BindingSource to that row
+ 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
+ CHARACTER GetCurrentRecordKey () Returns a key identifying the current record
# ROWID GetCurrentRowid () Returns the Current Rowids
+ 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
# CHARACTER GetDesignTimeDataSourceClassName () Returns the Class Name used for creating SmartBusinessEntityBindingSource (or derived) components at design time (SCL-1000), using the "Create BindingSource" designer verb
+ 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)
# Consultingwerk.ListQueryExpressionByTable GetNewFilterValues () Builds an empty ListQueryExpressionByTable instance and raises the CollectFilterValues event
+ 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
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL HasCopiedFromField () Returns if the first table of the Adapter provides a field SmartCopiedFrom
+ 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
+ A InitializeAdapter () Initializes the SmartBusinessEntityAdapter
+ A InitializeAdapter (logical) Initializes the SmartBusinessEntityAdapter
+ A Progress.Lang.Object InvokeMethod (character, dataset-handle, ISerializable) Invokes a method in the backend OERA business entity
+ A Progress.Lang.Object InvokeMethod2 (character, dataset-handle, Object) Invokes a method in the backend OERA business entity
# InvokeParentPositionChanged (Object, EventArgs) Invokes the ParentPositionChanged event handler in all connected SmartDataAdapter instances
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL IsRowUncommittedAdd () Returns if the current record of the EntityTable is an uncommitted Add (that is ROW-STATE = ROW-CREATED)
+ 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
# CHARACTER MergeQueryStrings (character, ListQueryExpressionByTable) Merges two Query Strings
# OffEndHandler (Object, OffEndEventArgs) Event handler for the OffEnd event of the ProBindingSource object
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnAfterAssignRecord (AfterAssignRecordEventArgs) Raises the AfterAssignRecord event
# OnAfterCancelCreateRecord (AfterCancelCreateRecordEventArgs) Raises the AfterCancelCreateRecord event
# OnAfterCreateRecord (AfterCreateRecordEventArgs) Raises the AfterCreateRecord event
# OnAfterDeleteRecord (AfterDeleteRecordEventArgs) Raises the AfterDeleteRecord event
# OnAfterQueryPositionChanged (EventArgs) Raises the AfterQueryPositionChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnAfterRetrieveData (EventArgs) Raises the AfterRetrieveData event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnAfterUpdateRecord (AfterUpdateRecordEventArgs) Raises the AfterUpdateRecord event
# OnAssignForeignFields (AssignForeignFieldsEventArgs) Raises the AssignForeignFields
# OnAssignKeyFieldError (AssignKeyFieldErrorEventArgs) Raises the AssignKeyFieldError
# OnAssignKeyFields (AssignKeyFieldsEventArgs) Raises the AssignKeyFields event
# OnBeforeAssignRecord (BeforeAssignRecordEventArgs) Raise the BeforeAssignRecord event
# OnBeforeCancelCreateRecord (BeforeCancelCreateRecordEventArgs) Raises the BeforeCancelCreateRecord event
# OnBeforeCreateRecord (BeforeCreateRecordEventArgs) Raises the BeforeCreateRecord event
# OnBeforeCreatingRecord (CancelableEventArgs) Raises the BeforeCreatingRecord
# OnBeforeDeleteRecord (BeforeDeleteRecordEventArgs) Raises the BeforeDeleteRecord event
# OnBeforeRetrieveData (CancelEventArgs) Raises the BeforeRetrieveData event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnBeforeUpdateRecord (BeforeUpdateRecordEventArgs) Raises the BeforeUpdateRecord event
# OnBeginUpdateState (DataSourceUpdateStateEventArgs) Raises the BeginUpdateState event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnBindingSourceChanged (BindingSourceChangedEventArgs) Raises the BindingSourceChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnCollectFilterValues (CollectFilterValuesEventArgs) Raises the CollectFilterValues event
# OnCurrentChanged (EventArgs) Raises the CurrentChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnDatasetControllerChanged (EventArgs) Raises the DatasetControllerChanged event
# OnEndUpdateState (DataSourceUpdateStateEventArgs) Raises the EndUpdateState event
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnNonUpdatableColumnsChanged (EventArgs) Raises the NonUpdatableColumnsChanged event
# OnQueryClosed (EventArgs) Raises the QueryClosed
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# OnRepositionAfterUpdateRow (RepositionAfterUpdateRowEventArgs) Raises the RepositionAfterUpdateRow
# 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
# OnUnableToRepositionAfterUpdateRow (UnableToRepositionAfterUpdateRowEventArgs) Raises the UnableToRepositionAfterUpdateRow
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ 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) Event handler for the PositionChanged event of the BindingSource object
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:PositionChangedHandler (Object, EventArgs)
# A PrepareDataBinding () Abstract method used to prepare the BindingSource:Handle object (either a QUERY or a ProDataset).
# RaiseUnableToCommitError (ISmartTableIOTarget) Raises the error when the transaction connect be committed
# RaiseUnableToRejectError (ISmartTableIOTarget) Raises the error when the transaction connect be rejected
+ RefetchCurrentRow () Refetches the current row from the backend and merges it with the frontend dataset
+ A RefetchCurrentRow (character) Refetches the current row from the backend and merges it with the frontend dataset
+ Refresh (logical) Refreshes the SmartDatasetAdapter
+ RefreshAfterRejectTransaction (rowid[]) Reopens the query and refreshes the BindingSource after a transaction has been rejected
+ RefreshAfterRejectTranscation (rowid[]) Deprecated - use method RefreshAfterRejectTransaction instead
+ 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
+ RegisterSmartGroupCreateTarget (ISmartGroupCreateTarget) Register a SmartGroupCreateTarget with the SmartGroupCreateSource This Method is executed every time a new SmartGroupCreateSource is registered to the corresponding Property of a Class implementing the Interface ISmartGroupCreateSource.
+ RemoveSmartNavigationSource (ISmartNavigationSource) Removes a SmartNavigationSource from the SmartDataAdapter instance
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# RepositionAfterUpdateRow (rowid, logical) Repositions to the updated record after update
# RepositionCurrentRow () Repositions the Adapters Query to the current row
+ 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
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:RepositionToRowid (rowid[])
# ResetCurrentRowid () Allows to reset the stored current ROWID's
+ 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.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL RetrieveData (character) Retrieves Data from the Backend or opens the query and sets
+ SaveFromGroupCreateTarget (ISmartGroupCreateTarget) Saves the data in this ISmartGroupCreateSource related updating ISmartDataTarget so that before saving a new child record, that parent record is created
+ SaveInDataTargets () Recursively invokes SaveChanges in all DataTargets that are currently updating
# A SetQuerySort (character) Overridable Setter for QuerySort property
+ A SetSavingData (logical) Assigns if the SmartDatasetAdapter is currently saving data
# SetSmartDataSource (ISmartDataSource) SetSmartDataSource sets the SmartDataSource of the current instance of the SmartDataAdapter.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# SetTrackingChanges (logical) Sets the tracking changes property of all temp-tables
+ StoreCopiedFrom (character) Stores the source record key information with the new record (copy)
+ SubmitChanges () Saves the Dataset changes to the backend using the parent SmartDataAdapter
+ SubscribeAfterRetrieveData (IAfterRetrieveDataSubscriber) Subscribes an instance of an object to the AfterRetrieveData callback.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ CHARACTER ToString () Returns a String representation of this object instance
+ UpdateRow () UpdateRow submits the changes to a buffer into the Database. Called by SmartViewerControl * Enforced by Interface ISmartDataSource.
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:UpdateRow ()
+ UpdateRow (logical) UpdateRow submits the changes to a buffer into the Database. Called by SmartViewerControl, SmartUpdatableBrowser Data is updated into the Dataset from the BindingSource. After this the Datasets changes are submitted to the OERA Backend, merged into the Dataset and the BindingSource gets refreshed.
# ValidateForeignFields () Validates the value of the ForeignFields property when during the first ParentPositionChanged event

Top Constructor Summary
Options Name Purpose
+ SmartDatasetAdapter () Constructor for the SmartDatasetAdapter component
+ SmartDatasetAdapter (IContainer) Constructor for the SmartDatasetAdapter component

Top Event Summary
Options Name Purpose
+ AfterAssignRecord (Object, AfterAssignRecordEventArgs) Event raised after a record has been assigned
+ AfterCancelCreateRecord (Object, AfterCancelCreateRecordEventArgs) Event fired after the creation of a record has been cancelled
+ AfterCreateRecord (Object, AfterCreateRecordEventArgs) Event fired after a record has been created
+ AfterDeleteRecord (Object, AfterDeleteRecordEventArgs) Event raised after a record has been deleted
+ 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
+ AfterUpdateRecord (Object, AfterUpdateRecordEventArgs) Event raised after a record has been updated
+ AssignForeignFields (Object, AssignForeignFieldsEventArgs) Raised while creating a new record in a child SmartDatasetAdapter
+ AssignKeyFieldError (Object, AssignKeyFieldErrorEventArgs) Raised when the SmartDatasetAdapter catches an error while assigning the fields from the BindingSource
+ AssignKeyFields (Object, AssignKeyFieldsEventArgs) Event raised when a ISmartGroupCreateSource needs to create a record to allow creation of a child record in a ISmartGroupCreateTarget instance.
+ BeforeAssignRecord (Object, BeforeAssignRecordEventArgs) Event raised before assigning to a record
+ BeforeCancelCreateRecord (Object, BeforeCancelCreateRecordEventArgs) Raised before the creation of the record will be cancelled
+ BeforeCreateRecord (Object, BeforeCreateRecordEventArgs) Raised before the a record is created
+ BeforeCreatingRecord (Object, CancelableEventArgs) Raised before the SmartDatasetAdapter is about to create a new record in the CreateRecord method
+ BeforeDeleteRecord (Object, BeforeDeleteRecordEventArgs) Raised before the a record is deleted
+ BeforeRetrieveData DELEGATE System.ComponentModel.CancelEventHandler Event fired before the SmartDataAdapter is about to open a new query
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ BeforeUpdateRecord (Object, BeforeUpdateRecordEventArgs) Raised before the a record is updated
+ 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
+ CollectFilterValues (Object, CollectFilterValuesEventArgs) Event raised to collect Filter Values from Filter Sources
+ CurrentChanged DELEGATE System.EventHandler Raised whenever the Data Adapter is positioned on a new row.
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ DatasetControllerChanged DELEGATE System.EventHandler Raised when the DatasetController property is changed
+ EndUpdateState (Object, DataSourceUpdateStateEventArgs) Event raised when a ISmartDataTarget of this SmartDataAdapter instance ends the update state
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ NonUpdatableColumnsChanged DELEGATE System.EventHandler Raised when the NonUpdatableColumns property is changed
+ QueryClosed DELEGATE System.EventHandler Raised when the CloseQuery method is called
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ RepositionAfterUpdateRow (Object, RepositionAfterUpdateRowEventArgs) Raised before the SmartDatasetAdapter is attempting to reposition to the updated row. Allows customized handling of repositioning to the updated row (e.g. open the query with different arguments), allows to prevent the error on repositioning when e.g. the query needs to be opened with a different query string to match the new row
+ 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
+ UnableToRepositionAfterUpdateRow (Object, UnableToRepositionAfterUpdateRowEventArgs) Raised when the SmartDatasetAdapter is unable to reposition to the updated row after update (typically the key values of the record have changed so that it does no longer match the query criteria)

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerPartition
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL Available
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# 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
+ A CHARACTER BindTo
+ HANDLE BufferHandle
+ LOGICAL CancellingCreateRecord
# CHARACTER CategorizedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER CategoryProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ LOGICAL CloseQueryOnParentCreate
+ LOGICAL CloseQueryOnParentCreateDefault
+ A LOGICAL CreateDistinctBuffer
+ LOGICAL CreatingRecord
+ A HANDLE DataSet
+ A Consultingwerk.SmartComponents.Interfaces.IDatasetController DatasetController
+ 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
# A CHARACTER EntityJoin
+ A CHARACTER EntityName
+ A CHARACTER EntityTable
+ A CHARACTER EntityView
+ Consultingwerk.ListQueryExpressionByTable FetchFilterValues
# CHARACTER FetchQueryString
# LOGICAL FirstTime
+ CHARACTER ForeignFields
+ LOGICAL GetInitialValues
# 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.IDesignFilterSource LinkFilterSource
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource LinkNavigationSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ CHARACTER NonUpdatableColumns
+ LOGICAL NullifyAllUniqueIndexFieldsOnCreate
# INTEGER PreviousPosition
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ HANDLE QueryHandle
+ CHARACTER QuerySort
+ A CHARACTER QueryString
+ CHARACTER RecordPosition
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL SelectTables
+ 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.ISmartFilterSource SmartFilterSource
+ Consultingwerk.SmartComponents.Base.ListISmartGroupCreateTarget SmartGroupCreateTargets
+ Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource SmartNavigationSource
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL ThrowErrorsFromRetrieveData
+ Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget UpdatingSmartDataTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
+ LOGICAL ValidateForeignFields


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 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 AttachQueryToBindingSource ()
Purpose: Attaches the Query/ProDataset to the BindingSource
Notes:

Top

PROTECTED AttachSchemaToBindingSource (BindingSource)
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:AttachSchemaToBindingSource (BindingSource)
Purpose: Attaches the schema to the BindingSource
Notes:

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 BeginTransactionState ()
Purpose: Begins a transaction when starting update
Notes: Allows SmartDatasetChildAdapter to initiate TransactionState in a
parent SmartBusinessEntityAdapter

Top

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

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 ()
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CancelCreateRecord ()
Purpose: Invoked from the SmartDataTarget to cancel the creation of a new
row
Notes: Creation of rows and cancellation of rows in the
SmartBusinessEntityAdapter now no longer handled using the AddNew()
method of the BindingSource. We are now creating rows and removing
them on cancel. (Bug 1836)
For ISmartGroupCreateSource instances this event notifies the
associated ISmartGroupCreateTargets to also cancel the creation of
a new record

Top

PROTECTED CancelCreateRowHandler (Object, CancelCreateRowEventArgs)
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CancelCreateRowHandler (Object, CancelCreateRowEventArgs)
Purpose: Handler for the CancelCreateRow event of the ProBindingSource.
A Row that has been created using CreateRowHandler gets reverted.
Notes:

Parameters:
sender System.Object
The object that raised the CancelCreateRow event (ProBindingSource)
args Progress.Data.CancelCreateRowEventArgs
The CancelCreateRowEventArgs instance of the event
Top

PUBLIC CancelInDataTargets ()
Purpose: Recursively invokes CancelUpdate in all DataTargets that are currently
updating
Notes: Throws an Exception, when of the DataTargets remains updating
Used during RejectChanges

Top

PUBLIC ClearPreviousQueryString (logical)
Purpose: Clears the PreviousQueryString information to ensure that the
ParentPositionChanged event handler does reopen the query regardless
of identical key values
Notes: SCL-402

Parameters:
plIncludeCurrent LOGICAL
Clear cPreviousQueryString also for the current instance or only for Data Targets
Top

PUBLIC CloseQuery ()
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CloseQuery ()
Purpose: Empties the result set of this SmartDataAdapter. Used to clear grids
Notes: Override to CloseQuery in SmartDataAdapter that resets the variable
cPreviousFetchQueryString to avoid issues of not reopening the
Query in the ParentPositionChanged handler when the same parent record
as before becomes available after closing the query in between

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 CreateParentRecord (character)
Purpose: Creates a parent record when needed for creating a record in a
SmartGroupCreateTarget
Notes: Creates a record and attempts to assign the primary key values

Parameters:
pcKeyFields CHARACTER
The Key Fields to assign
Top

PUBLIC CreateRecord ()
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CreateRecord ()
Purpose: Creates a new record
Notes: Creation of rows and cancellation of rows in the
SmartBusinessEntityAdapter now no longer handled using the AddNew()
method of the BindingSource. We are now creating rows and removing
them on cancel. (Bug 1836)
The OnBeforeCreateRecord event handler are NOT allowed to contain
MESSAGE statements. This will cause the hBuffer of to no longer
point to the right record!

Top

PROTECTED CreateRowHandler (Object, CreateRowEventArgs)
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:CreateRowHandler (Object, CreateRowEventArgs)
Purpose: Event handler for the CreateRow event of the ProBindingSource.
Notes: A new Row gets created.
TRACKING-CHANGES is switched on and a new Buffer is created. Inside
the Query a new Result-List-Entry is created.

Parameters:
sender System.Object
The reference to the object that raised the event
args Progress.Data.CreateRowEventArgs
The CreateRowEventArgs 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 record from the EntityTable
Notes: Method enforced by ISmartDataSource

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

PUBLIC DeregisterSmartGroupCreateTarget (ISmartGroupCreateTarget)
Purpose: Deregister a SmartGroupCreateTarget with the SmartGroupCreateSource
Notes: Enforced by Interface ISmartGroupCreateSource.

Parameters:
poSmartGroupCreateTarget Consultingwerk.SmartComponents.Interfaces.ISmartGroupCreateTarget
The ISmartGroupCreateTarget to deregister
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

PROTECTED CHARACTER EvaluateParentQuery ()
Purpose: Evaluates the QueryString based on the Parent Filter Fields
Notes: Used during the ParentPositionChanged event handler but also at
the end of the UpdateRow method to handle situations in a
GroupCreate link when the parent record has been created and the
final primary key values in the parent table are changed during
saving the record to the database

Returns CHARACTER
The parent filter query string
Top

PROTECTED CHARACTER EvaluateParentQuery (logical)
Purpose: Evaluates the QueryString based on the Parent Filter Fields
Notes: Used during the ParentPositionChanged event handler but also at
the end of the UpdateRow method to handle situations in a
GroupCreate link when the parent record has been created and the
final primary key values in the parent table are changed during
saving the record to the database

Parameters:
plAfterUpdate LOGICAL
Logical value indicating if the method is called from UpdateRow()
Returns CHARACTER
The parent filter query string
Top

PROTECTED CHARACTER EvaluateParentQueryAfterUpdate ()
Purpose: Evaluates the QueryString based on the Parent Filter Fields after
UpdateRow
Notes: The SmartDatasetChildAdapter and the SmartBusinessEntityAdapter
require a different implementation here

Returns CHARACTER
The parent filter query string
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 ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

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 LOGICAL FindLastRowWhere (character)
Purpose: Finds the last a row in the EntityTable and locates the BindingSource
to that row
Notes: The record is actually located using a dynamic query instead of a
FIND so that sorting is also supported (typically sorting should
be passed in with the same value as the QuerySort property of
this SmartBusinessEntityAdapter instance
Returns the LAST record that matches the criteria

Parameters:
pcFindString CHARACTER
The find criteria, should not contain a BY phrase, as the Sort order of the Adapter will be used.
Returns LOGICAL
Logical value indicating if a record was found
Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartDatasetAdapter FindLinkedDatasetAdapterForEntityTable (character)
Purpose: Searches for a linked SmartDatasetAdapter with the given entity table
Notes: Also returns THIS-OBJECT, when THIS-OBJECT is using the given EntityTable

Parameters:
pcEntityTable CHARACTER
The Entity Table to locate
Returns Consultingwerk.SmartComponents.Base.SmartDatasetAdapter
The reference to the lined SmartDatasetAdapter for the given entity table
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 LOGICAL FindRowWhere (character)
Purpose: Finds a row in the EntityTable and locates the BindingSource
to that row
Notes: The record is actually located using a dynamic query instead of a
FIND so that sorting is also supported (typically sorting should
be passed in with the same value as the QuerySort property of
this SmartBusinessEntityAdapter instance
Returns the FIRST record that matches the criteria

Parameters:
pcFindString CHARACTER
The find criteria, should not contain a BY phrase, as the Sort order of the Adapter will be used.
Returns LOGICAL
Logical value indicating if a record was found
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 CHARACTER GetCurrentRecordKey ()
Purpose: Returns a key identifying the current record
Notes: Returns either the SmartRecordKey value if populated or the result of the
BufferHelper:UniqueFindPredicate UniqueFindPredicate function

Returns CHARACTER
The single character key that represents the current record
Top

PROTECTED ROWID GetCurrentRowid ()
Purpose: Returns the Current Rowids
Notes: Needs to be a Method instead of a Property Get to return an
indeterminate Array

Returns ROWID
The Array of the current query ROWID's
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

PROTECTED CHARACTER GetDesignTimeDataSourceClassName ()
Purpose: Returns the Class Name used for creating SmartBusinessEntityBindingSource
(or derived) components at design time (SCL-1000), using the
"Create BindingSource" designer verb
Notes:

Returns CHARACTER
The Class Name used for creating SmartBusinessEntityBindingSource components at design time
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: 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)
Override to GetFieldValues method. Make sure the Query is properly
positioned before calling SUPER method

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

PROTECTED Consultingwerk.ListQueryExpressionByTable GetNewFilterValues ()
Purpose: Builds an empty ListQueryExpressionByTable instance and raises the
CollectFilterValues event
Notes: Will return ? when the event was cancelled by a subscriber

Returns Consultingwerk.ListQueryExpressionByTable
The ListQueryExpressionByTable with the filters per table
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 ()
Inherited from Consultingwerk.SmartComponents.Base.SmartDataAdapter
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

PUBLIC LOGICAL HasCopiedFromField ()
Purpose: Returns if the first table of the Adapter provides a field
SmartCopiedFrom
Notes: Used by the SmartViewerControl and SmartUpdatableBrowser during copy

Returns LOGICAL
Logical value indicating if the first table of the Adapter provides a field SmartCopiedFrom
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 InitializeAdapter ()
Purpose: Initializes the SmartBusinessEntityAdapter
Notes: Useful to initialize the BindingSource and Query before calling
RetrieveData. Defaults to InitializeAdapter(TRUE) to empty the
dataset
It's not recommended to call this method prior to the Form's OnLoad
or OnShown event as teh ProBindingSource seems to reset the Handle
Property (Query or Dataset) that was assigned to early during
initialization

Top

PUBLIC InitializeAdapter (logical)
Purpose: Initializes the SmartBusinessEntityAdapter
Notes: Useful to initialize the BindingSource and Query before calling
RetrieveData. When the dataset requires to be emptied, we need need
to turn off tracking-changes.
It's not recommended to call this method prior to the Form's OnLoad
or OnShown event as teh ProBindingSource seems to reset the Handle
Property (Query or Dataset) that was assigned to early during
initialization

Parameters:
plEmptyDataset LOGICAL
Logical flag to indicate if the dataset should be emptied or not.
Top

PUBLIC Progress.Lang.Object InvokeMethod (character, dataset-handle, ISerializable)
Purpose: Invokes a method in the backend OERA business entity
Notes:

Parameters:
pcMethodName CHARACTER
The method to be invoked in the Business Entity
phDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the dataset to be passed to the Business Entity method
poParameter Consultingwerk.ISerializable
The ISerializable parameter object to be passed to the Business Entity method
Returns Progress.Lang.Object
The instance of the parameter object
Top

PUBLIC Progress.Lang.Object InvokeMethod2 (character, dataset-handle, Object)
Purpose: Invokes a method in the backend OERA business entity
Notes: This variant of InvokeMethod2 uses the native ABL-SERIALIZABLE method
for exchanging the parameter object with the backend. It does however
return a different instance of the parameter object, so the unlike in
InvokeMethod() the instance passed in as the poParameter reference is
not updated with data from the backend. Thus we're introducing the
return value to return the updated parameter object from the backend.

Parameters:
pcMethodName CHARACTER
The method to be invoked in the Business Entity
phDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the dataset to be passed to the Business Entity method
poParameter Progress.Lang.Object
The ISerializable parameter object to be passed to the Business Entity method
Returns Progress.Lang.Object
The instance of the parameter object
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 IsRowUncommittedAdd ()
Purpose: Returns if the current record of the EntityTable is an uncommitted
Add (that is ROW-STATE = ROW-CREATED)
Notes: SCL-1340, used to distinguish between Update and edit of previously
added row before committing to the backend

Returns LOGICAL
Logical value indicating if the current record is an uncommitted add
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 CHARACTER MergeQueryStrings (character, ListQueryExpressionByTable)
Purpose: Merges two Query Strings
Notes:

Parameters:
pcFetchQueryString CHARACTER
The first QueryString
poQueryExpressions Consultingwerk.ListQueryExpressionByTable
The List of QueryExpressions by Table to be merged with the first QueryString
Returns CHARACTER
The resulting Query String
Top

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

PROTECTED OnAfterAssignRecord (AfterAssignRecordEventArgs)
Purpose: Raises the AfterAssignRecord event
Notes:

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

PROTECTED OnAfterCancelCreateRecord (AfterCancelCreateRecordEventArgs)
Purpose: Raises the AfterCancelCreateRecord event
Notes:

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

PROTECTED OnAfterCreateRecord (AfterCreateRecordEventArgs)
Purpose: Raises the AfterCreateRecord event
Notes:

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

PROTECTED OnAfterDeleteRecord (AfterDeleteRecordEventArgs)
Purpose: Raises the AfterDeleteRecord event
Notes:

Parameters:
e Consultingwerk.SmartComponents.Implementation.AfterDeleteRecordEventArgs
The AfterDeleteRecordEventArgs with the data for this 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 OnAfterUpdateRecord (AfterUpdateRecordEventArgs)
Purpose: Raises the AfterUpdateRecord event
Notes:

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

PROTECTED OnAssignForeignFields (AssignForeignFieldsEventArgs)
Purpose: Raises the AssignForeignFields
Notes:

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

PROTECTED OnAssignKeyFieldError (AssignKeyFieldErrorEventArgs)
Purpose: Raises the AssignKeyFieldError
Notes:

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

PROTECTED OnAssignKeyFields (AssignKeyFieldsEventArgs)
Purpose: Raises the AssignKeyFields event
Notes:

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

PROTECTED OnBeforeAssignRecord (BeforeAssignRecordEventArgs)
Purpose: Raise the BeforeAssignRecord event
Notes:

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

PROTECTED OnBeforeCancelCreateRecord (BeforeCancelCreateRecordEventArgs)
Purpose: Raises the BeforeCancelCreateRecord event
Notes:

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

PROTECTED OnBeforeCreateRecord (BeforeCreateRecordEventArgs)
Purpose: Raises the BeforeCreateRecord event
Notes:

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

PROTECTED OnBeforeCreatingRecord (CancelableEventArgs)
Purpose: Raises the BeforeCreatingRecord
Notes:

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

PROTECTED OnBeforeDeleteRecord (BeforeDeleteRecordEventArgs)
Purpose: Raises the BeforeDeleteRecord event
Notes:

Parameters:
e Consultingwerk.SmartComponents.Implementation.BeforeDeleteRecordEventArgs
The BeforeDeleteRecordEventArgs with the data for this 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 OnBeforeUpdateRecord (BeforeUpdateRecordEventArgs)
Purpose: Raises the BeforeUpdateRecord event
Notes:

Parameters:
e Consultingwerk.SmartComponents.Implementation.BeforeUpdateRecordEventArgs
The BeforeUpdateRecordEventArgs with the data for this 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 OnCollectFilterValues (CollectFilterValuesEventArgs)
Purpose: Raises the CollectFilterValues event
Notes:

Parameters:
e Consultingwerk.SmartComponents.Implementation.CollectFilterValuesEventArgs
The CollectFilterValuesEventArgs with the data for this 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 OnDatasetControllerChanged (EventArgs)
Purpose: Raises the DatasetControllerChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this 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 OnNonUpdatableColumnsChanged (EventArgs)
Purpose: Raises the NonUpdatableColumnsChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this 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 OnRepositionAfterUpdateRow (RepositionAfterUpdateRowEventArgs)
Purpose: Raises the RepositionAfterUpdateRow
Notes:

Parameters:
e Consultingwerk.SmartComponents.Base.RepositionAfterUpdateRowEventArgs
The RepositionAfterUpdateRowEventArgs 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

PROTECTED OnUnableToRepositionAfterUpdateRow (UnableToRepositionAfterUpdateRowEventArgs)
Purpose: Raises the UnableToRepositionAfterUpdateRow
Notes:

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

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

Parameters:
pcVerbText CHARACTER
The label of the verb the developer clicked on in the Visual Designer
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: Event handler for the PositionChanged event of the BindingSource
object
Notes:

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 PrepareDataBinding ()
Purpose: Abstract method used to prepare the BindingSource:Handle object
(either a QUERY or a ProDataset).
Notes: Implemented in the SmartBusinessEntityAdapter and SmartDatasetChildAdapter
Called from RetrieveData or CreateRecord (when called before RetrieveData)

Top

PROTECTED RaiseUnableToCommitError (ISmartTableIOTarget)
Purpose: Raises the error when the transaction connect be committed
Notes:

Parameters:
poTarget Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
The ISmartTableIOTarget instance that caused the error
Top

PROTECTED RaiseUnableToRejectError (ISmartTableIOTarget)
Purpose: Raises the error when the transaction connect be rejected
Notes:

Parameters:
poTarget Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
The ISmartTableIOTarget instance that caused the error
Top

PUBLIC RefetchCurrentRow ()
Purpose: Refetches the current row from the backend and merges it with the
frontend dataset
Notes:

Top

PUBLIC RefetchCurrentRow (character)
Purpose: Refetches the current row from the backend and merges it with the
frontend dataset
Notes: The pcViewTables parameter is evaluated as the Tables parameter of
the FetchDataRequest class

Parameters:
pcViewTables CHARACTER
The comma delimited list of tables to refetch in addition to the EntityTable
Top

PUBLIC Refresh (logical)
Purpose: Refreshes the SmartDatasetAdapter
Notes: Reopens the client side query (does not retrieve data from the backend)
and optionally repositions to the record that is current before
the refresh

Parameters:
plRepositionToCurrent LOGICAL
Logical value indicating if we the method should reposition to the row that was current before re-opening the query after the query has been reopened
Top

PUBLIC RefreshAfterRejectTransaction (rowid[])
Purpose: Reopens the query and refreshes the BindingSource after a transaction
has been rejected
Notes:

Parameters:
proDatasetRowids ROWID
The ROWID[] with all ROWID's of the ProDataset to reposition to
Top

PUBLIC RefreshAfterRejectTranscation (rowid[])
Purpose: Deprecated - use method RefreshAfterRejectTransaction instead
Notes:

Parameters:
proDatasetRowids ROWID
The ROWID[] with all ROWID's of the ProDataset to reposition to
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 RegisterSmartGroupCreateTarget (ISmartGroupCreateTarget)
Purpose: Register a SmartGroupCreateTarget with the SmartGroupCreateSource
This Method is executed every time a new SmartGroupCreateSource is
registered to the corresponding Property of a Class implementing the
Interface ISmartGroupCreateSource.
Notes: Enforced by Interface ISmartGroupCreateSource.

Parameters:
poSmartGroupCreateTarget Consultingwerk.SmartComponents.Interfaces.ISmartGroupCreateTarget
The ISmartGroupCreateTarget to register
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

PROTECTED RepositionAfterUpdateRow (rowid, logical)
Purpose: Repositions to the updated record after update
Notes:

Parameters:
proRowid ROWID
The rowid of the record to position to
plCreated LOGICAL
Logical value indicating if the current record was created
Top

PROTECTED RepositionCurrentRow ()
Purpose: Repositions the Adapters Query to the current row
Notes: Based on a previously stored row as some ProDataset methods invalidate
the current record buffers

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[])
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:RepositionToRowid (rowid[])
Purpose: Repositions to a Rowid Array
Notes:

Parameters:
prRowid ROWID
The Array of ROWID's to reposition to
Top

PROTECTED ResetCurrentRowid ()
Purpose: Allows to reset the stored current ROWID's
Notes:

Top

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

PUBLIC LOGICAL RetrieveData (character)
Purpose: Retrieves Data from the Backend or opens the query and sets
Notes: a new QueryString

Parameters:
pcQueryString CHARACTER
The new value for the query string property
Returns LOGICAL
Logical value indicating the success of the method, not always used
Top

PUBLIC SaveFromGroupCreateTarget (ISmartGroupCreateTarget)
Purpose: Saves the data in this ISmartGroupCreateSource related updating
ISmartDataTarget so that before saving a new child record, that
parent record is created
Notes:

Parameters:
poSmartGroupCreateTarget Consultingwerk.SmartComponents.Interfaces.ISmartGroupCreateTarget
The ISmartGroupCreateTarget that invoked this Save operation
Top

PUBLIC SaveInDataTargets ()
Purpose: Recursively invokes SaveChanges in all DataTargets that are currently
updating
Notes: Throws an Exception, when of the DataTargets remains updating
Used during CommitChanges

Top

PROTECTED SetQuerySort (character)
Purpose: Overridable Setter for QuerySort property
Notes:

Parameters:
arg CHARACTER
The new value for the QuerySort property
Top

PUBLIC SetSavingData (logical)
Purpose: Assigns if the SmartDatasetAdapter is currently saving data
Notes:

Parameters:
plSaving LOGICAL
Logical value indicating if the SmartDatasetAdapter is currently saving data
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

PROTECTED SetTrackingChanges (logical)
Purpose: Sets the tracking changes property of all temp-tables
Notes: Tables without a valid BEFORE-BUFFER will not be handled. For static
temp-tables this is typically understood as read-only temp-tables
(and the attempt to enable TRACKING-CHANGES would cause a runtime
error). Dynamic temp-tables that have never been set to
TRACKING-CHANGES = TRUE will never have a valid BEFORE-BUFFER. As
such it's expected that dynamic temp-tables that should be updatable
will be set to TRACKING-CHANGES briefly in their factory method.

Parameters:
plTrackingChanges LOGICAL
LOGICAL value indicating if tracking changes should be turned on or off
Top

PUBLIC StoreCopiedFrom (character)
Purpose: Stores the source record key information with the new record (copy)
Notes:

Parameters:
pcSourceRecordKey CHARACTER
The record key of the source record to store with the copied record
Top

PUBLIC SubmitChanges ()
Purpose: Saves the Dataset changes to the backend using the parent
SmartDataAdapter
Notes:

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 CHARACTER ToString ()
Purpose: Returns a String representation of this object instance
Notes: Useful for logging purposes, contains class name, entity name and entity table

Returns CHARACTER
The String representation of the object instance
Top

PUBLIC UpdateRow ()
Overrides Consultingwerk.SmartComponents.Base.SmartDataAdapter:UpdateRow ()
Purpose: UpdateRow submits the changes to a buffer into the Database.
Called by SmartViewerControl
Enforced by Interface ISmartDataSource.
Notes: Calls UpdateRow (plAssignFromBindingSource = TRUE) .

Top

PUBLIC UpdateRow (logical)
Purpose: UpdateRow submits the changes to a buffer into the Database.
Called by SmartViewerControl, SmartUpdatableBrowser
Data is updated into the Dataset from the BindingSource. After this
the Datasets changes are submitted to the OERA Backend, merged into
the Dataset and the BindingSource gets refreshed.
Notes: Do NOT call SUPER:UpdateRow() in the overriding method.

Parameters:
plAssignFromBindingSource LOGICAL
Logical flag indicating of the value from the attached BindingSource should be assigned to the current record
Top

PROTECTED ValidateForeignFields ()
Purpose: Validates the value of the ForeignFields property when during the
first ParentPositionChanged event
Notes:



Constructor Detail
Top

PUBLIC SmartDatasetAdapter ()
Purpose: Constructor for the SmartDatasetAdapter component
Notes:

Top

PUBLIC SmartDatasetAdapter (IContainer)
Purpose: Constructor for the SmartDatasetAdapter component
Notes:

Parameters:
poContainer System.ComponentModel.IContainer
An System.ComponentModel.IContainer that represents the container for the component.


Event Detail
Top

PUBLIC AfterAssignRecord (Object, AfterAssignRecordEventArgs)
Purpose: Event raised after a record has been assigned
Notes:

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

PUBLIC AfterCancelCreateRecord (Object, AfterCancelCreateRecordEventArgs)
Purpose: Event fired after the creation of a record has been cancelled
Notes:

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

PUBLIC AfterCreateRecord (Object, AfterCreateRecordEventArgs)
Purpose: Event fired after a record has been created
Notes:

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

PUBLIC AfterDeleteRecord (Object, AfterDeleteRecordEventArgs)
Purpose: Event raised after a record has been deleted
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Implementation.AfterDeleteRecordEventArgs
The AfterDeleteRecordEventArgs with the data for this event
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 AfterUpdateRecord (Object, AfterUpdateRecordEventArgs)
Purpose: Event raised after a record has been updated
Notes:

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

PUBLIC AssignForeignFields (Object, AssignForeignFieldsEventArgs)
Purpose: Raised while creating a new record in a child SmartDatasetAdapter
Notes: The event is raised just before the foreign field values are assigned.
Setting the Handled property of the event argument to TRUE will prevent
the Adapter for assigning the foreign field values as it is assumed
that an event subscribed has done so already.

Parameters:
sender Progress.Lang.Object
The object that raised the AssignForeignFields event
e Consultingwerk.SmartComponents.Base.AssignForeignFieldsEventArgs
The AssignForeignFieldsEventArgs with the data for the event
Top

PUBLIC AssignKeyFieldError (Object, AssignKeyFieldErrorEventArgs)
Purpose: Raised when the SmartDatasetAdapter catches an error while assigning
the fields from the BindingSource
Notes: This event allows the UI to review the error and provide more appropriate
error handling than just showing the Progress Error message. From this
event you may actually throw an error message which is more informational
to the end user

Parameters:
sender Progress.Lang.Object
The object that raised the AssignKeyFieldError event
e Consultingwerk.SmartComponents.Base.AssignKeyFieldErrorEventArgs
The AssignKeyFieldErrorEventArgs with the data for the event
Top

PUBLIC AssignKeyFields (Object, AssignKeyFieldsEventArgs)
Purpose: Event raised when a ISmartGroupCreateSource needs to create a
record to allow creation of a child record in a ISmartGroupCreateTarget
instance.
Notes: The purpose of this event is that an event handler can create
meaningful key values. When done an event handler is supposed to
ASSIGN e:Assigned = TRUE .

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

PUBLIC BeforeAssignRecord (Object, BeforeAssignRecordEventArgs)
Purpose: Event raised before assigning to a record
Notes:

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

PUBLIC BeforeCancelCreateRecord (Object, BeforeCancelCreateRecordEventArgs)
Purpose: Raised before the creation of the record will be cancelled
Notes:

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

PUBLIC BeforeCreateRecord (Object, BeforeCreateRecordEventArgs)
Purpose: Raised before the a record is created
Notes: The BeforeCreateRecord event handler are NOT allowed to contain
MESSAGE statements. This will cause the Buffer to no longer
point to the (right) record!

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

PUBLIC BeforeCreatingRecord (Object, CancelableEventArgs)
Purpose: Raised before the SmartDatasetAdapter is about to create a new record
in the CreateRecord method
Notes: Unlike the BeforeCreateRecord (which allows to assign new values
to the newly created record), this event is raised before any new
record is created

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

PUBLIC BeforeDeleteRecord (Object, BeforeDeleteRecordEventArgs)
Purpose: Raised before the a record is deleted
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Implementation.BeforeDeleteRecordEventArgs
The BeforeDeleteRecordEventArgs with the data for this event
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 BeforeUpdateRecord (Object, BeforeUpdateRecordEventArgs)
Purpose: Raised before the a record is updated
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Implementation.BeforeUpdateRecordEventArgs
The BeforeUpdateRecordEventArgs with the data for this event
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 CollectFilterValues (Object, CollectFilterValuesEventArgs)
Purpose: Event raised to collect Filter Values from Filter Sources
Notes: Required by IFilterTarget

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Implementation.CollectFilterValuesEventArgs
The CollectFilterValuesEventArgs 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 DatasetControllerChanged DELEGATE System.EventHandler
Purpose: Raised when the DatasetController property is changed
Notes:

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 NonUpdatableColumnsChanged DELEGATE System.EventHandler
Purpose: Raised when the NonUpdatableColumns property is changed
Notes:

Delegate: System.EventHandler
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 RepositionAfterUpdateRow (Object, RepositionAfterUpdateRowEventArgs)
Purpose: Raised before the SmartDatasetAdapter is attempting to reposition
to the updated row. Allows customized handling of repositioning to
the updated row (e.g. open the query with different arguments), allows
to prevent the error on repositioning when e.g. the query needs to
be opened with a different query string to match the new row
Notes: For sample event handler code, see SCL-500

Parameters:
sender Progress.Lang.Object
The object that raised the UnableToRepositionAfterUpdateRow event
e Consultingwerk.SmartComponents.Base.RepositionAfterUpdateRowEventArgs
The UnableToRepositionAfterUpdateRowEventArgs with the data for the event
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
Top

PUBLIC UnableToRepositionAfterUpdateRow (Object, UnableToRepositionAfterUpdateRowEventArgs)
Purpose: Raised when the SmartDatasetAdapter is unable to reposition to the
updated row after update (typically the key values of the record
have changed so that it does no longer match the query criteria)
Notes: For sample event handler code, see SCL-500

Parameters:
sender Progress.Lang.Object
The object that raised the UnableToRepositionAfterUpdateRow event
e Consultingwerk.SmartComponents.Base.UnableToRepositionAfterUpdateRowEventArgs
The UnableToRepositionAfterUpdateRowEventArgs with the data for the event


Property Detail
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

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

PUBLIC CHARACTER BindTo

Returns CHARACTER
Top

PUBLIC HANDLE BufferHandle

Returns HANDLE
Top

PUBLIC LOGICAL CancellingCreateRecord

Returns LOGICAL
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 LOGICAL CloseQueryOnParentCreate

Returns LOGICAL
Top

PUBLIC LOGICAL CloseQueryOnParentCreateDefault

Returns LOGICAL
Top

PUBLIC LOGICAL CreateDistinctBuffer

Returns LOGICAL
Top

PUBLIC LOGICAL CreatingRecord

Returns LOGICAL
Top

PUBLIC HANDLE DataSet

Returns HANDLE
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.IDatasetController DatasetController

Returns Consultingwerk.SmartComponents.Interfaces.IDatasetController
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

PROTECTED CHARACTER EntityJoin

Returns CHARACTER
Top

PUBLIC CHARACTER EntityName

Returns CHARACTER
Top

PUBLIC CHARACTER EntityTable

Returns CHARACTER
Top

PUBLIC CHARACTER EntityView

Returns CHARACTER
Top

PUBLIC Consultingwerk.ListQueryExpressionByTable FetchFilterValues

Returns Consultingwerk.ListQueryExpressionByTable
Top

PROTECTED CHARACTER FetchQueryString

Returns CHARACTER
Top

PROTECTED LOGICAL FirstTime

Returns LOGICAL
Top

PUBLIC CHARACTER ForeignFields

Returns CHARACTER
Top

PUBLIC LOGICAL GetInitialValues

Returns LOGICAL
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.IDesignFilterSource LinkFilterSource

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignFilterSource
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 CHARACTER NonUpdatableColumns

Returns CHARACTER
Top

PUBLIC LOGICAL NullifyAllUniqueIndexFieldsOnCreate

Returns LOGICAL
Top

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

Returns INTEGER
Top

PUBLIC HANDLE QueryHandle

Returns HANDLE
Top

PUBLIC CHARACTER QuerySort

Returns CHARACTER
Top

PUBLIC CHARACTER QueryString

Returns CHARACTER
Top

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

Returns CHARACTER
Top

PUBLIC LOGICAL SelectTables

Returns LOGICAL
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.ISmartFilterSource SmartFilterSource

Returns Consultingwerk.SmartComponents.Interfaces.ISmartFilterSource
Top

PUBLIC Consultingwerk.SmartComponents.Base.ListISmartGroupCreateTarget SmartGroupCreateTargets

Returns Consultingwerk.SmartComponents.Base.ListISmartGroupCreateTarget
Top

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

Returns Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource
Top

PUBLIC LOGICAL ThrowErrorsFromRetrieveData

Returns LOGICAL
Top

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

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
Top

PUBLIC LOGICAL ValidateForeignFields

Returns LOGICAL


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