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

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

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

Navigate to: Methods | Constructors | Events | Properties



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

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

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

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerPartition Gets/Sets the name of the AppServer Partition to be used by this SmartDataAdapter instance
+ LOGICAL Available Returns if the DataSource currently has a record available
# CHARACTER BindableProperties Property that is used to mark properties (comma-delimited list) that should be Data-Bindable
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ Progress.Data.BindingSource BindingSource Get/Set the BindingSource of the current Class. The BindingSource can be set to any class derived from Progress.Data.BindingSource. This Property is set internaly if the SmartDataAdapter is attached to a Browser where a DesignTime BindingSource is attached or if the developer calls RetrieveData (). * If a valid BindingSource exists inside the SmartDataAdapter the EventHandlers get unsubscribe from that instance and it is replaced with the new one. After that the Handlers for the Events of the BindingSource are subscribed to the new instance.
+ CHARACTER BindingSourceExcludeFields Get/Set the Exclude Fields for the BindingSource created by the CreateBindingSource method.
+ CHARACTER BindingSourceIncludeFields Get/Set the Include Fields for the BindingSource created by the CreateBindingSource method.
# CHARACTER CategorizedProperties Property that is used to mark properties (comma-delimited list) that should receive a Category attribute
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER CategoryProperties Categories of the Property in the CategorizedProperty list
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ Progress.Data.BindingSource DataSourceBindingSource Returns a reference to the BindingSource of the SmartDataSource
# CHARACTER DescribedProperties Property that is used to mark properties (comma-delimited list) that should receive a Description attribute
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DescriptionProperties Description of the Property in the DescribedProperties list
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DesignerVerbs Property that is used to generate Designer Verbs (actions for the Visual Designer)
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DesignerVisibilityAttributes The CHARACTER representation of the DesignerSerializationVisibiltiy attribute (Content/Visible/Hidden), see .NET Enumeration System.ComponentModel.DesignerSerializationVisibility
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DesignerVisibilityProperties Property that is used to mark properties (comma-delimited list) that should receive a DesignerSerializationVisibility Attribute
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ LOGICAL DesignTime Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# LOGICAL DesingerHostLoading Propery returns if the component's DesignerHost is currently loading the document
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER HiddenProperties Property that is used to mark properties (comma-delimited list) that will be excluded from the .NET TypeDescriptor properties list
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ LOGICAL Initializing Indicates that the SmartDataAdapter is currrently being Initialized
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource Represents the SmartDataSource property casted to a .NET Interface
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource LinkNavigationSource Represents the SmartNavigationSource property casted to a .NET Interface
# CHARACTER NonBrowsableProperties Property that is used to mark properties (comma-delimited list) that should not show up in the Visual Designers Property Grid
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# INTEGER PreviousPosition Get/Set if the Position of this Adapters BindingSource's position prio to the last RetrieveData call.
+ CHARACTER RecordPosition Returns a Value of RecordPositionEnum representing the current position The Property is read in the Method PositionChangedHandler () of a Class implementing the Interface ISmartNavigationTarget. Enforced by Interface ISmartNavigationTarget.
+ Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource Get/Set the SmartDataSource of the current Class. The SmartDataSource can be set to any class implementing the Interface ISmartDataSource. This Property is set by the developer when initializing a Control implementing the Interface ISmartDataTarget. Enforced by Interface ISmartDataTarget.
+ LOGICAL SmartDataSourceActive Get/Set if this instance of the SmartDataAdapter is subscribed to the PositionChanged event of the SmartDataSource's BindingSource
+ CHARACTER SmartDataSourceState Get/Set the SmartDataSourceState of the current Class. This Property is set to Updating if the Method BeginUpdateState () of the SmartDataAdapter instance is called and it is set to Navigatable during initialization and if the Property SmartTableIOState of a Viewer is set to anything but ModifyingData.
+ Consultingwerk.SmartComponents.Base.ListISmartDataTarget SmartDataTargets Returns the list of SmartDataTargets as a generic list
+ Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource SmartNavigationSource Get and Set the current SmartNavigationSource of the SmartDataAdapter. Every SmartNavigationTarget is registered with handshake and kept in a collection. This Property is set by the developer when initializing a Control implementing the Interface ISmartDataSource. Enforced by Interface ISmartDataSource.
+ Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget UpdatingSmartDataTarget Returns a reference to the SmartDataTarget which is currently in update mode


Method Detail
Top

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

Top

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

Top

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

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

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

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

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

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

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

Top

PUBLIC 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)
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 ()
Purpose: Invoked from the SmartDataTarget to cancel the creation of a new
row
Notes:

Top

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

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

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

Top

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

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

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

Top

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

Top

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

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

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

Top

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

Top

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

Returns LOGICAL
Logical value indicating if the method was successful
Top

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

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

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

Top

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

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

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

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

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

Top

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

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

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

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

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

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

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

Top

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

Returns LOGICAL
Logical value, currently not used
Top

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

Returns LOGICAL
Logical value, currently not used
Top

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

Returns LOGICAL
Logical value, currently not used
Top

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

Returns LOGICAL
Logical value, currently not used
Top

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

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

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

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

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

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

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

Returns CHARACTER
The class name of the Component
Top

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

Returns CHARACTER
The Component Name of this instance
Top

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 ()
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 HasFields (character)
Purpose: Returns a logical value indicating if the SmartDataAdapter can provide
the given fields
Notes: Useful to validate if the GetFieldValues methos can return vslues 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PROTECTED OnQueryClosed (EventArgs)
Purpose: Raises the QueryClosed
Notes:

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

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

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

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

Parameters:
e Consultingwerk.SmartComponents.Base.SmartNavigationTargetStateChangedEventArgs
The SmartNavigationTargetStateChangedEventArgs 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)
Purpose: Event Handler for the BindingSourceChanged event of the
SmartDataSoruce
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)
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)
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)
Purpose: Handler for the PositionChanged event of the BindingSource attached
to this SmartDataAdapter instance.
Notes: The current RecordPosition is passed to the SmartNavigationSource.

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

PUBLIC RegisterSmartDataTarget (ISmartDataTarget)
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 RemoveSmartNavigationSource (ISmartNavigationSource)
Purpose: Removes a SmartNavigationSource from the SmartDataAdapter
instance
Notes: Enabled multiple SmartNavigationSources to the SmartDataAdapter.

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

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

Parameters:
pcRowids CHARACTER
A comma delimited list of ROWIDs
Top

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

Parameters:
prRowid ROWID
The ROWID to reposition to
Top

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

Parameters:
prRowid ROWID
An Array of ROWIDs
Top

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

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

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

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

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

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

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



Constructor Detail
Top

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

Top

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

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


Event Detail
Top

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

Delegate: System.EventHandler
Top

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

Delegate: System.EventHandler
Top

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

Delegate: System.ComponentModel.CancelEventHandler
Top

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

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

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

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

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

Delegate: System.EventHandler
Top

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

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

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

Delegate: System.EventHandler
Top

PUBLIC SmartNavigationTargetPositionChanged (Object, SmartNavigationTargetPositionChangedEventArgs)
Purpose: Event fired whenever the RecordPositon 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)
Purpose: Event fired whenever the SmartDataSourceState property has changed
Notes:

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


Property Detail
Top

PUBLIC CHARACTER AppServerPartition
Purpose: Gets/Sets the name of the AppServer Partition to be used
by this SmartDataAdapter instance
Notes: The property is defined in the abstract SmartDataAdapter base
class - even when some implementations may not require an AppServer
connection

Returns CHARACTER
Top

PUBLIC LOGICAL Available
Purpose: Returns if the DataSource currently has a record available
Notes:

Returns LOGICAL
Top

PROTECTED CHARACTER BindableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Property that is used to mark properties (comma-delimited list) that
should be Data-Bindable
Notes: C# Annotation: [Bindable(true)]

Returns CHARACTER
Top

PUBLIC Progress.Data.BindingSource BindingSource
Purpose: Get/Set the BindingSource of the current Class. The BindingSource
can be set to any class derived from Progress.Data.BindingSource.
This Property is set internaly if the SmartDataAdapter is attached
to a Browser where a DesignTime BindingSource is attached or if
the developer calls RetrieveData ().
If a valid BindingSource exists inside the SmartDataAdapter the
EventHandlers get unsubscribe from that instance and it is replaced
with the new one. After that the Handlers for the Events of the
BindingSource are subscribed to the new instance.
Notes: Enforced by Interface ISmartDataSource.

Returns Progress.Data.BindingSource
Top

PUBLIC CHARACTER BindingSourceExcludeFields
Purpose: Get/Set the Exclude Fields for the BindingSource created by the
CreateBindingSource method.
Notes: As optional parameters, the constructors of the BindingSource can accept
comma-separated lists of data object fields, in display order, to make
available to or exclude from the UI. If you want to make only a few fields
available, list them in the included field list. If you want to make most
fields available, set the available fields to be all fields and list
the remaining fields in the excluded field list. When the included field
list is an asterisk (*), all fields in the data object are made available
to any bound UI control.
The excluded field list is only meaningful when the included field list is
an asterisk (*). If the included field list contains specific fields,
the excluded field list is ignored. However, when you are not specifying
any excluded fields, you still must specify a blank value ("") to match the
constructor's signature.

Returns CHARACTER
Top

PUBLIC CHARACTER BindingSourceIncludeFields
Purpose: Get/Set the Include Fields for the BindingSource created by the
CreateBindingSource method.
Notes: See BindingSourceExcludeFields for further comments

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a Category attribute
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Categories of the Property in the CategorizedProperty list
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PUBLIC Progress.Data.BindingSource DataSourceBindingSource
Purpose: Returns a reference to the BindingSource of the SmartDataSource
Notes:

Returns Progress.Data.BindingSource
Top

PROTECTED CHARACTER DescribedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a Description attribute
Notes: C# Annotation: [Description("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Description of the Property in the DescribedProperties list
Notes: C# Annotation: [Description("...")]
This is a CHR(1) delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Property that is used to generate Designer Verbs (actions for the
Visual Designer)
Notes:

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: The CHARACTER representation of the DesignerSerializationVisibiltiy
attribute (Content/Visible/Hidden), see .NET Enumeration
System.ComponentModel.DesignerSerializationVisibility
Notes: C# Annotation: [DesignerSerializationVisibility(...)]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a DesignerSerializationVisibility Attribute
Notes: C# Annotation: [DesignerSerializationVisibility(...)]
This is a comma delimited list

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Propery flags if the current instance of the SmartBindingSource
is running at design time or runtime.
Notes: Set during constructor using a check at the
System.ComponentModel.LicenseManager

Returns LOGICAL
Top

PROTECTED LOGICAL DesingerHostLoading
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Propery returns if the component's DesignerHost is currently
loading the document
Notes:

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Property that is used to mark properties (comma-delimited list) that
will be excluded from the .NET TypeDescriptor properties list
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL Initializing
Purpose: Indicates that the SmartDataAdapter is currrently being
Initialized
Notes:

Returns LOGICAL
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
Purpose: Represents the SmartDataSource property casted to a .NET Interface
Notes: Implementation of Interface in Consultingwerk.SmartComponents.dll
SCL-725 - code moved from LinkDataSource.i directly into class file

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource LinkNavigationSource
Purpose: Represents the SmartNavigationSource property casted to a .NET Interface
Notes: Implementation of Interface in Consultingwerk.SmartComponents.dll
SCL-725 - code moved from LinkNavigationSource.i directly into class file

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource
Top

PROTECTED CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Property that is used to mark properties (comma-delimited list) that
should not show up in the Visual Designers Property Grid
Notes:

Returns CHARACTER
Top

PROTECTED INTEGER PreviousPosition
Purpose: Get/Set if the Position of this Adapters BindingSource's position
prio to the last RetrieveData call.
Notes: The value of this property is used to invoke the ParentPosition
Changed event of Child-DataAdapters after this DataAdapter
has refetched data

Returns INTEGER
Top

PUBLIC CHARACTER RecordPosition
Purpose: Returns a Value of RecordPositionEnum representing the current position
The Property is read in the Method PositionChangedHandler () of a
Class implementing the Interface ISmartNavigationTarget.
Enforced by Interface ISmartNavigationTarget.
Notes: Possible Values (RecordPositionEnum):
NoRecordAvailable, OnlyRecord, FirstRecord, LastRecord, NotFirstOrLast

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
Purpose: Get/Set the SmartDataSource of the current Class. The SmartDataSource
can be set to any class implementing the Interface ISmartDataSource.
This Property is set by the developer when initializing a Control
implementing the Interface ISmartDataTarget.
Enforced by Interface ISmartDataTarget.
Notes:

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
Top

PUBLIC LOGICAL SmartDataSourceActive
Purpose: Get/Set if this instance of the SmartDataAdapter is subscribed
to the PositionChanged event of the SmartDataSource's BindingSource
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER SmartDataSourceState
Purpose: Get/Set the SmartDataSourceState of the current Class.
This Property is set to Updating if the Method BeginUpdateState () of the
SmartDataAdapter instance is called and it is set to Navigatable
during initialization and if the Property SmartTableIOState of a
Viewer is set to anything but ModifyingData.
Notes: Possible Values (DataSourceStateEnum) are Navigatable, Updating

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Base.ListISmartDataTarget SmartDataTargets
Purpose: Returns the list of SmartDataTargets as a generic list
Notes:

Returns Consultingwerk.SmartComponents.Base.ListISmartDataTarget
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource SmartNavigationSource
Purpose: Get and Set the current SmartNavigationSource of the SmartDataAdapter.
Every SmartNavigationTarget is registered with handshake and kept in a
collection.
This Property is set by the developer when initializing a Control
implementing the Interface ISmartDataSource.
Enforced by Interface ISmartDataSource.
Notes:

Returns Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget UpdatingSmartDataTarget
Purpose: Returns a reference to the SmartDataTarget which is currently in
update mode
Notes: This might be a SmartDataTarget actually linked to a different
SmartDataAdapter. This SmartDataTarget is supposed to end the
UpdateState before this SmartDataAdapter becomes navigatable again

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:30:58