Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartComboEditor Copy to Clipboard
Parent classes:
Inherits: Infragistics.Win.UltraWinEditors.UltraComboEditor
Implements: System.ComponentModel.ICustomTypeDescriptor, Consultingwerk.SmartComponents.IHasDesignerVerbs, System.ComponentModel.ISupportInitialize

File:SmartComboEditor
Purpose:Extension to the Infragistics UltraComboEditor
Description:Combo-Box that can populate itself with a ValueList based
on data retrieved from a Business Entity Table
As the Infragistics UltraComboEditor does not provide
editor-support this class uses the UltraComboEditorWithDesigner
as a base class
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Mar 01 13:49:20 CET 2013
Notes:Leverages the ValueListHelper class to build a value list
Accesses the backend directly through the ServiceAdapter
as no binding source and no navigation facilities are
required (both would be features that would justify using
a SmartBusinessEntityAdapter like the Lookup does.
The FlagValue and FlagText are only supported, when the
ImageField (BLOB) is not set



Top Method Summary
Options Name Purpose
+ BeginInit () Invoked at the beginning of a Containers InitializeComponents method
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
+ EndInit () Invoked at the end of a Containers InitializeComponents method
+ System.ComponentModel.AttributeCollection GetAttributes () Returns a collection of custom attributes for this instance of a component.
+ CHARACTER GetClassName () Returns the class name of this instance of a component.
+ CHARACTER GetComponentName () Returns the name of this instance of a component.
+ System.ComponentModel.TypeConverter GetConverter () Returns a type converter for this instance of a component.
+ System.ComponentModel.EventDescriptor GetDefaultEvent () Returns the default event for this instance of a component.
+ System.ComponentModel.PropertyDescriptor GetDefaultProperty () Returns the default property for this instance of a component.
+ System.Object GetEditor (Type) Returns an editor of the specified type for this instance of a component.
+ System.ComponentModel.EventDescriptorCollection GetEvents () Returns the events for this instance of a component.
+ System.ComponentModel.EventDescriptorCollection GetEvents (Attribute[]) Returns the events for this instance of a component using the specified attribute array as a filter.
+ System.ComponentModel.PropertyDescriptorCollection GetProperties () Returns the properties for this instance of a component.
+ System.ComponentModel.PropertyDescriptorCollection GetProperties (Attribute[]) Returns the properties for this instance of a component using the attribute array as a filter.
+ System.Object GetPropertyOwner (PropertyDescriptor) Returns an object that contains the property described by the specified property descriptor.
+ OnVerbClicked (character) Event Handler method for Designer Verbs
+ RetrieveData () Retrieves data from the Backend and populates the ValueList
- SetDesignerProperties () Initializes design time properties
# ShowBusinessEntityPickerDialog () Shows a dialog to select a Business Entity
# ShowTablePickerDialog () Invokes the Table Picker Dialog and sets properties of the SmartBusinessEntityLookup during Design Time

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

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerPartition Gets/Sets the name of the AppServer Partition to be used by this SmartComboEditor instance
# CHARACTER BindableProperties Property that is used to mark properties (comma-delimited list) that should be Data-Bindable
# CHARACTER CategorizedProperties Property that is used to mark properties (comma-delimited list) that should receive a Category attribute
# CHARACTER CategoryProperties Categories of the Property in the CategorizedProperty list
# CHARACTER DescribedProperties Property that is used to mark properties (comma-delimited list) that should receive a Description attribute
# CHARACTER DescriptionProperties Description of the Property in the DescribedProperties list
# CHARACTER DesignerVerbs Property that is used to generate Designer Verbs (actions for the Visual Designer)
# CHARACTER DesignerVisibilityAttributes The CHARACTER representation of the DesignerSerializationVisibiltiy attribute (Content/Visible/Hidden), see .NET Enumeration System.ComponentModel.DesignerSerializationVisibility
# CHARACTER DesignerVisibilityProperties Property that is used to mark properties (comma-delimited list) that should receive a DesignerSerializationVisibility Attribute
# LOGICAL DesignTime Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.
+ CHARACTER DisplayFields Gets and sets the comma-delimited list of field named that should be used for the display text of the value list
+ CHARACTER DisplaySubstitute Gets and sets the substitute expression (e.g. &1/&2) to be used for the display text of the value list
+ CHARACTER EntityName Gets and sets the Name of the BusinessEntity that is the data source for this Control
+ CHARACTER EntityTable Gets and sets the Name of the Temp-Table that is the data source for this Control
+ CHARACTER FlagText Gets and sets the Display Text for the flag value
+ CHARACTER FlagValue Gets and sets the CHARACTER value used for a Flag value (e.g. all or none)
+ CHARACTER ImageField Gets and sets the name of the field (BLOB) that contains the Image data for the ValueList
+ CHARACTER ImageKeyField Gets and sets the name of the field that contains the image key to be used
+ CHARACTER ImageKeyFieldSubstitute Gets and sets the SUBSTITUTE pattern to be used to build the actual image key to be used
+ CHARACTER KeyField Gets and sets the name of the field from the temp-table that should be used as the Value
# CHARACTER NonBrowsableProperties Property that is used to mark properties (comma-delimited list) that should not show up in the Visual Designers Property Grid
+ CHARACTER QuerySort Gets and sets the QuerySort that is used when populating the ValueList
+ CHARACTER QueryString Gets and sets the QueryString that is used when fetching data from the Business Entity
+ LOGICAL RetrieveDataOnInit Gets and sets if the SmartComboEditor should retrieve data during the EndInit method
+ Consultingwerk.OERA.IServiceAdapter ServiceAdapter Gets and sets the reference to the ServiceAdapter that is used by this Control


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

PROTECTED CreateVerbs ()

Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

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 System.ComponentModel.AttributeCollection GetAttributes ()

Purpose: Returns a collection of custom attributes for this instance of a
component.
Notes:

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

PUBLIC CHARACTER GetClassName ()

Purpose: Returns the class name of this instance of a component.
Notes:

Returns CHARACTER
The class name of the Component
Top

PUBLIC CHARACTER GetComponentName ()

Purpose: Returns the name of this instance of a component.
Notes:

Returns CHARACTER
The Component Name of this instance
Top

PUBLIC System.ComponentModel.TypeConverter GetConverter ()

Purpose: Returns a type converter for this instance of a component.
Notes:

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

PUBLIC System.ComponentModel.EventDescriptor GetDefaultEvent ()

Purpose: Returns the default event for this instance of a component.
Notes:

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

PUBLIC System.ComponentModel.PropertyDescriptor GetDefaultProperty ()

Purpose: Returns the default property for this instance of a component.
Notes:

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

PUBLIC System.Object GetEditor (Type)

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 System.ComponentModel.EventDescriptorCollection GetEvents ()

Purpose: Returns the events for this instance of a component.
Notes:

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

PUBLIC System.ComponentModel.EventDescriptorCollection GetEvents (Attribute[])

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 System.ComponentModel.EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC System.ComponentModel.PropertyDescriptorCollection GetProperties ()

Purpose: Returns the properties for this instance of a component.
Notes:

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

PUBLIC System.ComponentModel.PropertyDescriptorCollection GetProperties (Attribute[])

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 System.ComponentModel.PropertyDescriptorCollection
A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.
Top

PUBLIC System.Object GetPropertyOwner (PropertyDescriptor)

Purpose: Returns an object that contains the property described by the
specified property descriptor.
Notes:

Parameters:
pd System.ComponentModel.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 OnVerbClicked (character)

Purpose: Event Handler method for Designer Verbs
Notes: This method is intended to be overridden

Parameters:
pcVerbText CHARACTER
The name (Label) of the Designer Verb that was invoked
Top

PUBLIC RetrieveData ()

Purpose: Retrieves data from the Backend and populates the ValueList
Notes:

Top

PRIVATE SetDesignerProperties ()

Purpose: Initializes design time properties
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
SmartBusinessEntityLookup during Design Time
Notes: Invoked by the "Select Tables" Designer Verb. Only intended for
DesignTime



Constructor Detail
Top

PUBLIC SmartComboEditor ()

Purpose: Constructor for the SmartComboEditor class
Notes:



Property Detail
Top

PUBLIC CHARACTER AppServerPartition

Purpose: Gets/Sets the name of the AppServer Partition to be used
by this SmartComboEditor instance
Notes:

Returns CHARACTER
Top

PROTECTED CHARACTER BindableProperties

Purpose: Property that is used to mark properties (comma-delimited list) that
should be Data-Bindable
Notes: C# Annotation: [Bindable(true)]

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties

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

Purpose: Categories of the Property in the CategorizedProperty list
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DescribedProperties

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

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

Purpose: Property that is used to generate Designer Verbs (actions for the
Visual Designer)
Notes:

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes

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

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

PROTECTED LOGICAL DesignTime

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

PUBLIC CHARACTER DisplayFields

Purpose: Gets and sets the comma-delimited list of field named that should be
used for the display text of the value list
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER DisplaySubstitute

Purpose: Gets and sets the substitute expression (e.g. &1/&2) to be used for
the display text of the value list
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER EntityName

Purpose: Gets and sets the Name of the BusinessEntity that is the data source
for this Control
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER EntityTable

Purpose: Gets and sets the Name of the Temp-Table that is the data source
for this Control
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER FlagText

Purpose: Gets and sets the Display Text for the flag value
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER FlagValue

Purpose: Gets and sets the CHARACTER value used for a Flag value (e.g. all
or none)
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER ImageField

Purpose: Gets and sets the name of the field (BLOB) that contains the Image
data for the ValueList
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER ImageKeyField

Purpose: Gets and sets the name of the field that contains the image key to be used
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER ImageKeyFieldSubstitute

Purpose: Gets and sets the SUBSTITUTE pattern to be used to build the actual image key to be used
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER KeyField

Purpose: Gets and sets the name of the field from the temp-table that should
be used as the Value
Notes:

Returns CHARACTER
Top

PROTECTED CHARACTER NonBrowsableProperties

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

PUBLIC CHARACTER QuerySort

Purpose: Gets and sets the QuerySort that is used when populating the ValueList
Notes: BY eCustomer.City

Returns CHARACTER
Top

PUBLIC CHARACTER QueryString

Purpose: Gets and sets the QueryString that is used when fetching data from
the Business Entity
Notes: Leave empty to return all rows from the backend

Returns CHARACTER
Top

PUBLIC LOGICAL RetrieveDataOnInit

Purpose: Gets and sets if the SmartComboEditor should retrieve data during
the EndInit method
Notes:

Returns LOGICAL
Top

PUBLIC Consultingwerk.OERA.IServiceAdapter ServiceAdapter

Purpose: Gets and sets the reference to the ServiceAdapter that is used
by this Control
Notes: Defaults to Consultingwerk.Framework.FrameworkSettings:ServiceAdapter

Returns Consultingwerk.OERA.IServiceAdapter


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