Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartBusinessEntityBindingSource Copy to Clipboard
Parent classes:
Progress.Data.BindingSource
Consultingwerk.SmartComponents.Implementation.SmartBindingSource
Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityBindingSource

Inherits: Consultingwerk.SmartComponents.Implementation.SmartBindingSource
Implements: ICustomTypeDescriptor, IHasDesignerVerbs

File:SmartBusinessEntityBindingSource
Purpose:Provides Design Time support for OERA Business Entities
Description:Similar OERA support with SmartBusinessEntityAdapter
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Tue Apr 07 09:36:41 CEST 2009
Notes:Inherits Progress.Data.BindingSource, enhancements only
for development, at runtime identical behaviour with
Progress.Data.BindingSource, aka ProBindingSource

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



Top Method Summary
Options Name Purpose
# AddControlsForChosenFields (TableDesc, logical, character) Add controls (Label and DataControl) for each choosen field of the currently processed table to the design canvas.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# INTEGER CalculateControlWidth (ColumnPropDesc) Calculates the width for the control representing the column
Overrides Consultingwerk.SmartComponents.Implementation.SmartBindingSource:CalculateControlWidth (ColumnPropDesc)
# System.Windows.Forms.Control CreateControlForField (DataType, character, character, character) Create a Control for a field from the Design time binding source
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# System.Windows.Forms.Control CreateLabelForField (DataType, character, character, character) Create a Control for the label of a field from the Design time binding source
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# DesignerAddFields () Add the selected Fields from the current schema of the SmartBindingSource to the design canvas.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# DesignerClearSchema () Clear the currently present Schema of the SmartBindingSource. This Method is called when the Property ClearSchema is set to TRUE.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# DesignerImportSchema () Import the schema of a BusinessEntity defined by the Properties EntityName, EntityTable, EntityView and EntityJoin. This Method is called when the Property ImportSchema is set to TRUE.
Overrides Consultingwerk.SmartComponents.Implementation.SmartBindingSource:DesignerImportSchema ()
+ DesignerImportSchema (logical) Import the schema of a BusinessEntity defined by the Properties EntityName, EntityTable, EntityView and EntityJoin. This Method is called when the Property ImportSchema is set to TRUE.
+ DesignerImportSchema (logical, character) Import the schema of a BusinessEntity defined by the Properties EntityName, EntityTable, EntityView and EntityJoin. This Method is called when the Property ImportSchema is set to TRUE.
+ AttributeCollection GetAttributes () Returns a collection of custom attributes for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ CHARACTER GetClassName () Returns the class name of this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ CHARACTER GetComponentName () Returns the name of this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ TypeConverter GetConverter () Returns a type converter for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ EventDescriptor GetDefaultEvent () Returns the default event for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ PropertyDescriptor GetDefaultProperty () Returns the default property for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# Consultingwerk.SmartComponents.Support.BindingSourceDataHandles GetDesignTimeDataHandle (character, character, character, character, character) Returns a DataHandle to a DesignTime Dataset. This Dataset is then analysed and the Schema is set as the new TableSchema.
+ System.Object GetEditor (Type) Returns an editor of the specified type for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ EventDescriptorCollection GetEvents () Returns the events for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ EventDescriptorCollection GetEvents (Attribute[]) Returns the events for this instance of a component using the specified attribute array as a filter.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ PropertyDescriptorCollection GetProperties () Returns the properties for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ PropertyDescriptorCollection GetProperties (Attribute[]) Returns the properties for this instance of a component using the attribute array as a filter.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ System.Object GetPropertyOwner (PropertyDescriptor) Returns an object that contains the property described by the specified property descriptor.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ InitializeFromAdapter (SmartDatasetAdapter) Initializes the EntityTable, EntityName, EntityView and EntityJoin properties from a SmartBusinessEntityAdapter or SmartDatasetChildAdapter
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Overrides Consultingwerk.SmartComponents.Implementation.SmartBindingSource:OnVerbClicked (character)
# Progress.Data.TableDesc RecurseDatasetRelations (handle, handle) Analyse the Dataset recursively and add all Tables and Fields together to a WorkTable representing the new TableSchema.
- SetDesignerProperties () Sets properties for the Visual Designer customization
# ShowBusinessEntityPickerDialog () Shows a dialog to select a Business Entity
# ShowTablePickerDialog () Invokes the Table Picker Dialog and sets properties of the SmartBusinessEntityAdapter during Design Time

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

Top Property Summary
Options Name Purpose
+ LOGICAL AddFields
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# CHARACTER BindableProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ CHARACTER BindTo
# CHARACTER CategorizedProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# CHARACTER CategoryProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ LOGICAL ClearSchema
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# System.Collections.Generic.Dictionary <System.String> CustomControlTypes
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# CHARACTER DescribedProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# CHARACTER DescriptionProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ CHARACTER EntityJoin
+ CHARACTER EntityName
+ CHARACTER EntityTable
+ CHARACTER EntityView
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
+ LOGICAL ImportSchema
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource


Method Detail
Top

PROTECTED AddControlsForChosenFields (TableDesc, logical, character)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
Purpose: Add controls (Label and DataControl) for each choosen field of the
currently processed table to the design canvas.
Notes: This Method is called by RecurseAddControls ().
First the name of the new Controls is build from the column name
and the SmartBindingSource Instance Name. Possibly the Name
occures more than once so it gets iterated from the second time on.
After this an UltraLabel and a Datatype specific EditorControl is
added to the Design Canvas.

Parameters:
oTable Progress.Data.TableDesc
The TableDesc to be processed
plPrefixWithTable LOGICAL
Shall ControlNames be prefixed with the TableName
cChoosenColumns CHARACTER
List of ColumnNames selected in the AddFields Dialog
Top

PROTECTED INTEGER CalculateControlWidth (ColumnPropDesc)
Overrides Consultingwerk.SmartComponents.Implementation.SmartBindingSource:CalculateControlWidth (ColumnPropDesc)
Purpose: Calculates the width for the control representing the column
Notes: This variant returns 150 as a constant. A derived type should return a width based on the column Format

Parameters:
poColumn Progress.Data.ColumnPropDesc
The ColumnPropDesc representing the current column
Returns INTEGER
The width for the control
Top

PROTECTED System.Windows.Forms.Control CreateControlForField (DataType, character, character, character)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
Purpose: Create a Control for a field from the Design time binding source
Notes: Uses IDesignerHost:CreateComponent

Parameters:
poType Progress.Data.DataType
The DataType of the field
pcControlName CHARACTER
The name of the Control
pcColumnName CHARACTER
The name of the Column
pcColumnLabel CHARACTER
The label of the Column
Returns System.Windows.Forms.Control
The reference to the Control that was created
Top

PROTECTED System.Windows.Forms.Control CreateLabelForField (DataType, character, character, character)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
Purpose: Create a Control for the label of a field from the Design time
binding source
Notes: Uses IDesignerHost:CreateComponent

Parameters:
poType Progress.Data.DataType
The DataType of the Control
pcControlName CHARACTER
The name of the Control
pcColumnName CHARACTER
The name of the Column
pcColumnLabel CHARACTER
The label of the Column
Returns System.Windows.Forms.Control
The reference to the Control that was created
Top

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

Top

PROTECTED DesignerAddFields ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
Purpose: Add the selected Fields from the current schema of the
SmartBindingSource to the design canvas.
Notes: A Dialog is shown to select fields and if fields are selected
the Controls are added recursively.

Top

PROTECTED DesignerClearSchema ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
Purpose: Clear the currently present Schema of the SmartBindingSource.
This Method is called when the Property ClearSchema is set to
TRUE.
Notes:

Top

PROTECTED DesignerImportSchema ()
Overrides Consultingwerk.SmartComponents.Implementation.SmartBindingSource:DesignerImportSchema ()
Purpose: Import the schema of a BusinessEntity defined by the Properties
EntityName, EntityTable, EntityView and EntityJoin.
This Method is called when the Property ImportSchema is set to
TRUE.
Notes: The current TableSchema of the SmartBusinessEntityBindingSource
is cleared out and the new Schema out of the BusinessEntity is
set.

Top

PUBLIC DesignerImportSchema (logical)
Purpose: Import the schema of a BusinessEntity defined by the Properties
EntityName, EntityTable, EntityView and EntityJoin.
This Method is called when the Property ImportSchema is set to
TRUE.
Notes: The current TableSchema of the SmartBusinessEntityBindingSource
is cleared out and the new Schema out of the BusinessEntity is
set.

Parameters:
plSilent LOGICAL
When True don't show message on completion
Top

PUBLIC DesignerImportSchema (logical, character)
Purpose: Import the schema of a BusinessEntity defined by the Properties
EntityName, EntityTable, EntityView and EntityJoin.
This Method is called when the Property ImportSchema is set to
TRUE.
Notes: The current TableSchema of the SmartBusinessEntityBindingSource
is cleared out and the new Schema out of the BusinessEntity is
set.

Parameters:
plSilent LOGICAL
When True don't show message on completion
pcExcludeFields CHARACTER
Comma delimited list of columns to exclude from the binding source schema
Top

PUBLIC AttributeCollection GetAttributes ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
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.Implementation.SmartBindingSource
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.Implementation.SmartBindingSource
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.Implementation.SmartBindingSource
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.Implementation.SmartBindingSource
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.Implementation.SmartBindingSource
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 Consultingwerk.SmartComponents.Support.BindingSourceDataHandles GetDesignTimeDataHandle (character, character, character, character, character)
Purpose: Returns a DataHandle to a DesignTime Dataset. This Dataset is then
analysed and the Schema is set as the new TableSchema.
Notes: This Method is called by DesignerImportSchema ()

Parameters:
pcEntityName CHARACTER
The name of the BusinessEntity
pcEntityTable CHARACTER
The RootTable for this Instance of the BusinessEntity
pcEntityView CHARACTER
List of Tables to read with the EntityTable
pcEntityJoin CHARACTER
List in the same oder as pcEntityView which defines Join YES or NO for each Table of pcEntityView
pcQueryOrDataset CHARACTER
Working on a Query or the ProDataset
Returns Consultingwerk.SmartComponents.Support.BindingSourceDataHandles
The handle of the design time dataset
Top

PUBLIC System.Object GetEditor (Type)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
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.Implementation.SmartBindingSource
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.Implementation.SmartBindingSource
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 PropertyDescriptorCollection GetProperties ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource
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.Implementation.SmartBindingSource
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.Implementation.SmartBindingSource
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

PUBLIC InitializeFromAdapter (SmartDatasetAdapter)
Purpose: Initializes the EntityTable, EntityName, EntityView and EntityJoin
properties from a SmartBusinessEntityAdapter or SmartDatasetChildAdapter
Notes:

Parameters:
poAdapter Consultingwerk.SmartComponents.Base.SmartDatasetAdapter
The reference to the SmartBusinessEntityAdapter or SmartDatasetChildAdapter to copy settings form
Top

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

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

PROTECTED Progress.Data.TableDesc RecurseDatasetRelations (handle, handle)
Purpose: Analyse the Dataset recursively and add all Tables and Fields
together to a WorkTable representing the new TableSchema.
Notes: This Method is called by DesignerImportSchema ().

Parameters:
phDataHandle HANDLE
The Handle of the Dataset which is processed
phBuffer HANDLE
The TopBuffer of the Dataset
Returns Progress.Data.TableDesc
The TableDesc with the selected schema
Top

PRIVATE SetDesignerProperties ()
Purpose: Sets properties for the Visual Designer customization
Notes:

Top

PROTECTED ShowBusinessEntityPickerDialog ()
Purpose: Shows a dialog to select a Business Entity
Notes: Invoked by the "Select BusinessEntity" Designer Verb, only intended
for DesignTime

Top

PROTECTED ShowTablePickerDialog ()
Purpose: Invokes the Table Picker Dialog and sets properties of the
SmartBusinessEntityAdapter during Design Time
Notes: Invoked by the "Select Tables" Designer Verb. Only intended for
DesignTime



Constructor Detail
Top

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

Top

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

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


Property Detail
Top

PUBLIC LOGICAL AddFields
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns LOGICAL
Top

PROTECTED CHARACTER BindableProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns CHARACTER
Top

PUBLIC CHARACTER BindTo

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns CHARACTER
Top

PUBLIC LOGICAL ClearSchema
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns LOGICAL
Top

PROTECTED System.Collections.Generic.Dictionary <System.String> CustomControlTypes
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns System.Collections.Generic.Dictionary <System.String>
Top

PROTECTED CHARACTER DescribedProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns CHARACTER
Top

PROTECTED LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns LOGICAL
Top

PUBLIC CHARACTER EntityJoin

Returns CHARACTER
Top

PUBLIC CHARACTER EntityName

Returns CHARACTER
Top

PUBLIC CHARACTER EntityTable

Returns CHARACTER
Top

PUBLIC CHARACTER EntityView

Returns CHARACTER
Top

PROTECTED CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns CHARACTER
Top

PUBLIC LOGICAL ImportSchema
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns LOGICAL
Top

PROTECTED CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartBindingSource

Returns CHARACTER


©2006-2019 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.08.2019 23:32:32