Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartGenericLookup Copy to Clipboard
Parent classes:
Infragistics.Win.UltraWinEditors.UltraTextEditor
Consultingwerk.SmartComponents.Base.SmartLookup
Consultingwerk.SmartComponents.Implementation.SmartGenericLookup

Inherits: Consultingwerk.SmartComponents.Base.SmartLookup
Implements: ICustomTypeDescriptor, Consultingwerk.SmartComponents.Interfaces.IEmbeddedSmartEditor, IHasDesignerVerbs

File:SmartGenericLookup
Purpose:A generic Lookup implementation useful for any allowing
lookups on any ISmartDataSource implementation
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Tue Apr 07 08:29:30 CEST 2009
Notes:This Lookup does not provide the ability to perform
lookups on partial entered keys in the lookup field.
However, this might be implemented in a derived type
with knowledge of a specific data adapter class and
filter syntax

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ AddLookupEditorButton () This Method is used to add a LookupButton to the Control and sets Key and Text Properties.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# AssignValueToCell (UltraGridCell, character) Assigns a Character Value to a Cell
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# DisposedHandler (Object, EventArgs) Event handler for the Disposed event of the SmartLookup instance
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ AttributeCollection GetAttributes () Returns a collection of custom attributes for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ CHARACTER GetClassName () Returns the class name of this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ CHARACTER GetComponentName () Returns the name of this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ TypeConverter GetConverter () Returns a type converter for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ EventDescriptor GetDefaultEvent () Returns the default event for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ PropertyDescriptor GetDefaultProperty () Returns the default property for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ System.Object GetEditor (Type) Returns an editor of the specified type for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ EventDescriptorCollection GetEvents () Returns the events for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ 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.SmartLookup
+ CHARACTER GetLookupRegistryKey () This Method returns a Registry Key where the Lookup size and position is stored for each Lookup.
Overrides Consultingwerk.SmartComponents.Base.SmartLookup:GetLookupRegistryKey ()
+ PropertyDescriptorCollection GetProperties () Returns the properties for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ PropertyDescriptorCollection GetProperties (Attribute[]) Returns the properties for this instance of a component using the attribute array as a filter.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ System.Object GetPropertyOwner (PropertyDescriptor) Returns an object that contains the property described by the specified property descriptor.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# HandleKeyDown (KeyEventArgs) Handles F3 key to invoke ShowLookupDialog method. This Method is executed when the KeyDown Event of the base class is fired.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# InitializeTimer () Initializes the Timer Component
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# LookupBrowserInitializeLayoutHandler (Object, InitializeLayoutEventArgs) Handles the InitializeLayout event of the Lookup Browser
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# LookupTimerTick (Object, EventArgs) Event Handler for the Tick event of the Lookup Timer Component
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnAfterPerformLookup (EventArgs) Raises the OnAfterPerformLookup event
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnBeforePerformLookup (CancelEventArgs) Raises the BeforePerformLookup event
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnEditorButtonClick (EditorButtonEventArgs) Raises the Invokes the EditorButtonClick event
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnEnabledChanged (EventArgs) Raises the EnabledChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnInitializeLookupBrowserLayout (InitializeLookupBrowserLayoutEventArgs) Raises the InitializeLookupBrowserLayout event
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnKeyDown (KeyEventArgs) Handles F3 key to invoke ShowLookupDialog method. This Method is executed when the KeyDown Event of the base class is fired.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnKeyPress (KeyPressEventArgs) Raises the KeyPress event
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnLeave (EventArgs) Raises the Leave event
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnLookupCompleted (EventArgs) Raises the LookupCompleted event
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnShowLookupDialog (CancelEventArgs) Raises the ShowLookupDialog event
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# OnValueChanged (EventArgs) Raises the Value changed event
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ PerformKeyDown (KeyEventArgs) Performs the KeyDown event for an embedded SmartLookup
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ PerformKeyPress (KeyPressEventArgs) Performs the KeyPress event for an embedded SmartLookup
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ PerformLeave (CancelEventArgs) Performs the Leave (BeforeCellDeactivate) event for an embedded SmartLookup
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ PerformLookup () Performs the lookup functioanlity, performs a call to the data source to retrieve the record based on the field value the user entered in the lookup control
Overrides Consultingwerk.SmartComponents.Base.SmartLookup:PerformLookup ()
# PerformLookup (logical) PerformLookup is not supported by the SmartGenericLookup
Overrides Consultingwerk.SmartComponents.Base.SmartLookup:PerformLookup (logical)
+ PerformLookupIfActive () Calls PerformLookup only if the LookupTimer is currently enabled
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# ShowLookupDialog () A LookupDialog is shown which contains Data from a given SmartDataSource.
Overrides Consultingwerk.SmartComponents.Base.SmartLookup:ShowLookupDialog ()
# StartTimer () Activates the Lookup Timer Component
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ StopTimer () Deactivates the Lookup Timer Component
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# UpdateCellsWithEmbeddedEditors () Updates cells in a Grid with values from embedded editors in case the lookup is owned by a grid
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup

Top Constructor Summary
Options Name Purpose
+ SmartGenericLookup () Creates a new Instance of SmartGenericLookup and subscribes Handlers to Events.

Top Event Summary
Options Name Purpose
+ AfterPerformLookup DELEGATE System.EventHandler Event raised after the lookup has performed a search
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ BeforePerformLookup DELEGATE System.ComponentModel.CancelEventHandler Event raised before the lookup performs a search
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ InitializeLookupBrowserLayout (Object, InitializeLookupBrowserLayoutEventArgs) Event raised when the Lookup Dialog's browser is performing it's layout
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ LookupComplete DELEGATE System.EventHandler Event raised when the Lookup has returned a record
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ ShowLookupDialog DELEGATE System.ComponentModel.CancelEventHandler Event raised before the Lookup Dialog is shown
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup

Top Property Summary
Options Name Purpose
+ LOGICAL AddLookupButton This Property is used to perform the Action to add a LookupButton to the Control. The Value of this Property is not changed but the Button is added to the Control when temporarily set to TRUE.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# CHARACTER BindableProperties Property that is used to mark properties (comma-delimited list) that should be Data-Bindable
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# CHARACTER CategorizedProperties Property that is used to mark properties (comma-delimited list) that should receive a Category attribute
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# CHARACTER CategoryProperties Categories of the Property in the CategorizedProperty list
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# CHARACTER DescribedProperties Property that is used to mark properties (comma-delimited list) that should receive a Description attribute
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# CHARACTER DescriptionProperties Description of the Property in the DescribedProperties list
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# CHARACTER DesignerVerbs Property that is used to generate Designer Verbs (actions for the Visual Designer)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# CHARACTER DesignerVisibilityAttributes The CHARACTER representation of the DesignerSerializationVisibiltiy attribute (Content/Visible/Hidden), see .NET Enumeration System.ComponentModel.DesignerSerializationVisibility
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# CHARACTER DesignerVisibilityProperties Property that is used to mark properties (comma-delimited list) that should receive a DesignerSerializationVisibility Attribute
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# LOGICAL DesignTime Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# 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.SmartLookup
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource Represents the SmartDataSource property casted to a .NET Interface
+ CHARACTER LookupBrowserExcludeFields Columns (comma delimited list of Column Names) not to be shown in the LookupBrowser.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ CHARACTER LookupBrowserFields Columns (comma delimited list of Column Names) to be shown in the LookupBrowser.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# LOGICAL LookupClearPending Controls if a clear is pending - that is if a previous PerformLookup did not return a record - but did not clear the key value. In that case the key value needs to be cleared on LostFocus
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ CHARACTER LookupControls A comma seperated list of Control names. The value of the corresponding Columns gets filled into those Controls. The value of this Property is defined during DesignTime.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ CHARACTER LookupDialogTitle Dialog title for the LookupDialogForm. The value of this Property is defined during DesignTime.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ CHARACTER LookupFields A comma seperated list of Column names. The value of those fields gets filled into the corresponding Controls of the Property LookupControls. The value of this Property is defined during DesignTime.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ CHARACTER LookupKeyField The value of the field which is returned by the SmartLookup. The value of this Property is defined during DesignTime.
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ System.Windows.Forms.Timer LookupTimer The instance of the System.Windows.Forms.Timer component used by this lookup to implement the delayed search
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ INTEGER LookupTimerDelay The number of msecs after a key has been pressed in a SmartLookup until the entered value is looked up. This allows the user to enter multiple keys before the value is looked up (in a data source).
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ LOGICAL LookupTimerDisabled Allows to completely disable the lookup timer functioanlity
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
# 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.SmartLookup
+ UltraGrid OwningGrid Gets and sets the reference to the grid that owns this SmartLookup as an Embedded Editor Control for a cell
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
+ Consultingwerk.SmartComponents.Base.SmartDataAdapter 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.


Method Detail
Top

PUBLIC AddLookupEditorButton ()
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: This Method is used to add a LookupButton to the Control and sets
Key and Text Properties.
Notes: Invoked by the Property setter of AddLookupButton or the Designer Verb

Top

PROTECTED AssignValueToCell (UltraGridCell, character)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Assigns a Character Value to a Cell
Notes:

Parameters:
poCell UltraGridCell
The UltraGridCell to assign the value to
pcValue CHARACTER
The value to assign to the cell
Top

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

Top

PROTECTED DisposedHandler (Object, EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Event handler for the Disposed event of the SmartLookup instance
Notes: Not subscribed during development, stops the Lookup Timer if it
should still be active

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

PUBLIC AttributeCollection GetAttributes ()
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
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.SmartLookup
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.SmartLookup
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.SmartLookup
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.SmartLookup
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.SmartLookup
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.SmartLookup
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.SmartLookup
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.SmartLookup
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 GetLookupRegistryKey ()
Overrides Consultingwerk.SmartComponents.Base.SmartLookup:GetLookupRegistryKey ()
Purpose: This Method returns a Registry Key where the Lookup size and position
is stored for each Lookup.
Notes: The Name of the Key is individual buildable.

Returns CHARACTER
The registry key where the lookup size and position is stored
Top

PUBLIC PropertyDescriptorCollection GetProperties ()
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
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.SmartLookup
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.SmartLookup
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 HandleKeyDown (KeyEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Handles F3 key to invoke ShowLookupDialog method.
This Method is executed when the KeyDown Event of the base class is
fired.
Notes:

Parameters:
e KeyEventArgs
System.Windows.Forms.KeyEventArgs
Top

PROTECTED InitializeTimer ()
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Initializes the Timer Component
Notes:

Top

PROTECTED LookupBrowserInitializeLayoutHandler (Object, InitializeLayoutEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Handles the InitializeLayout event of the Lookup Browser
Notes:

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

PROTECTED LookupTimerTick (Object, EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Event Handler for the Tick event of the Lookup Timer Component
Notes:

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

PROTECTED OnAfterPerformLookup (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Raises the OnAfterPerformLookup event
Notes: Invoked after the Lookup has fetched data

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

PROTECTED OnBeforePerformLookup (CancelEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Raises the BeforePerformLookup event
Notes: Cancellable event, raised when the user leaves the Lookup field or
after changing the Text in the Lookup Control and waiting for the
LookupTimer to fire

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

PROTECTED OnEditorButtonClick (EditorButtonEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Raises the Invokes the EditorButtonClick event
Notes:

Parameters:
e Infragistics.Win.UltraWinEditors.EditorButtonEventArgs
The EditorButtonEventArgs with the data for this event
Top

PROTECTED OnEnabledChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Raises the EnabledChanged event
Notes: Stops the Lookup timer when the Control get's disabled

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

PROTECTED OnInitializeLookupBrowserLayout (InitializeLookupBrowserLayoutEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Raises the InitializeLookupBrowserLayout event
Notes:

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

PROTECTED OnKeyDown (KeyEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Handles F3 key to invoke ShowLookupDialog method.
This Method is executed when the KeyDown Event of the base class is
fired.
Notes:

Parameters:
e KeyEventArgs
System.Windows.Forms.KeyEventArgs
Top

PROTECTED OnKeyPress (KeyPressEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Raises the KeyPress event
Notes: Starts the Lookup Timer when the Control has Focus

Parameters:
e System.Windows.Forms.KeyPressEventArgs
The KeyPressEventArgs with the data for this event
Top

PROTECTED OnLeave (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Raises the Leave event
Notes: When the Control Leave event ocurs the TimerTick event is
simulated, so that the lookup will be performed

Parameters:
e System.EventArgs
Default .NET System.EventArgs (empty event argument)
Top

PROTECTED OnLookupCompleted (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Raises the LookupCompleted event
Notes: Invokes the LookupCompleted call back in the SmartViewerControl
(when ILookupCompleteCallback is implemented).
Thid Method is called by ShowLookupDialog in a SmartLookup derived
class to perform the callback to the container.

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

PROTECTED OnShowLookupDialog (CancelEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Raises the ShowLookupDialog event
Notes: Cancellable event

Parameters:
e System.ComponentModel.CancelEventArgs
Default .NET CancelEventArgs (cancellable event argument)
Top

PROTECTED OnValueChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Raises the Value changed event
Notes: Sets the Lookup pending property when not using the Lookup timer

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

PUBLIC OnVerbClicked (character)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
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 PerformKeyDown (KeyEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Performs the KeyDown event for an embedded SmartLookup
Notes: Only supported when the lookup is used as an embedded editor

Parameters:
e KeyEventArgs
The KeyEventArgs of the original UltraGrid event
Top

PUBLIC PerformKeyPress (KeyPressEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Performs the KeyPress event for an embedded SmartLookup
Notes: Only supported when the lookup is used as an embedded editor

Parameters:
e KeyPressEventArgs
The KeyPressEventArgs of the original UltraGrid event
Top

PUBLIC PerformLeave (CancelEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Performs the Leave (BeforeCellDeactivate) event for an embedded SmartLookup
Notes: Only supported when the lookup is used as an embedded editor

Parameters:
e CancelEventArgs
The CancelEventArgs of the original UltraGrid event
Top

PUBLIC PerformLookup ()
Overrides Consultingwerk.SmartComponents.Base.SmartLookup:PerformLookup ()
Purpose: Performs the lookup functioanlity, performs a call to the data source
to retrieve the record based on the field value the user entered
in the lookup control
Notes: Abstract method that needs to be overidden in a more specialized
Lookup class, public method, that always assumes that the lookup has
no longer focus. Calls into PerformLookup (TRUE).

Top

PROTECTED PerformLookup (logical)
Overrides Consultingwerk.SmartComponents.Base.SmartLookup:PerformLookup (logical)
Purpose: PerformLookup is not supported by the SmartGenericLookup
Notes: The SmartGenericLookup is not able to fetch data after the user
enters a (partial) key value

Parameters:
plLostFocus LOGICAL
Not used
Top

PUBLIC PerformLookupIfActive ()
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Calls PerformLookup only if the LookupTimer is currently enabled
Notes: Called by the SmartViewerControl at the begin of a Save operations

Top

PROTECTED ShowLookupDialog ()
Overrides Consultingwerk.SmartComponents.Base.SmartLookup:ShowLookupDialog ()
Purpose: A LookupDialog is shown which contains Data from a given
SmartDataSource.
Notes: This Method is called from the Base Class if a user presses the
LookupEditorButton in RunTime.
A LookupDialog is set up with a Title and Data from a
SmartDataSource. The shown Columns of the resultset can be limited
by providing a comma delimeted list to the Property
LookupBrowserFields. The LookupKeyField is the field used to find
the correct Data Row when comming back from the Dialog. When the
OK Button was selected the related fields are recursively updated.

Top

PROTECTED StartTimer ()
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Activates the Lookup Timer Component
Notes:

Top

PUBLIC StopTimer ()
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Deactivates the Lookup Timer Component
Notes:

Top

PROTECTED UpdateCellsWithEmbeddedEditors ()
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Updates cells in a Grid with values from embedded editors in case
the lookup is owned by a grid
Notes: This method requires that the embedded editors are data bound to binding
source columns



Constructor Detail
Top

PUBLIC SmartGenericLookup ()
Purpose: Creates a new Instance of SmartGenericLookup and subscribes Handlers
to Events.
Notes:



Event Detail
Top

PUBLIC AfterPerformLookup DELEGATE System.EventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Event raised after the lookup has performed a search
Notes:

Delegate: System.EventHandler
Top

PUBLIC BeforePerformLookup DELEGATE System.ComponentModel.CancelEventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Event raised before the lookup performs a search
Notes: The cancellable event is raised before the Lookup action is performed.
The event still allows to modify properties relevant to the Lookup
(such as modifying the LookupQueryString)

Delegate: System.ComponentModel.CancelEventHandler
Top

PUBLIC InitializeLookupBrowserLayout (Object, InitializeLookupBrowserLayoutEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Event raised when the Lookup Dialog's browser is performing it's
layout
Notes:

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

PUBLIC LookupComplete DELEGATE System.EventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Event raised when the Lookup has returned a record
Notes:

Delegate: System.EventHandler
Top

PUBLIC ShowLookupDialog DELEGATE System.ComponentModel.CancelEventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Event raised before the Lookup Dialog is shown
Notes: The cancelable event is raised before the Lookup Dialog is
instantiated and shown. This event still allows to modify properties
relevant for the Lookup Dialog.

Delegate: System.ComponentModel.CancelEventHandler


Property Detail
Top

PUBLIC LOGICAL AddLookupButton
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: This Property is used to perform the Action to add a LookupButton to
the Control.
The Value of this Property is not changed but the Button is added to
the Control when temporarily set to TRUE.
Notes: Workaround to be able perform actions from Propertygrid.

Returns LOGICAL
Top

PROTECTED CHARACTER BindableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
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
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
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.SmartLookup
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
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
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.SmartLookup
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.SmartLookup
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.SmartLookup
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.SmartLookup
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
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
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 CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
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 Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
Purpose: Represents the SmartDataSource property casted to a .NET Interface
Notes: Implementation of Interface in Consultingwerk.SmartComponents.dll

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

PUBLIC CHARACTER LookupBrowserExcludeFields
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Columns (comma delimited list of Column Names) not to be shown in the
LookupBrowser.
Notes: The value of this Property is defined during DesignTime.

Returns CHARACTER
Top

PUBLIC CHARACTER LookupBrowserFields
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Columns (comma delimited list of Column Names) to be shown in the
LookupBrowser.
Notes: The value of this Property is defined during DesignTime.

Returns CHARACTER
Top

PROTECTED LOGICAL LookupClearPending
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Controls if a clear is pending - that is if a previous PerformLookup
did not return a record - but did not clear the key value. In that
case the key value needs to be cleared on LostFocus
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER LookupControls
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: A comma seperated list of Control names. The value of the corresponding
Columns gets filled into those Controls.
The value of this Property is defined during DesignTime.
Notes: Corresponding to the LookupFields

Returns CHARACTER
Top

PUBLIC CHARACTER LookupDialogTitle
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Dialog title for the LookupDialogForm.
The value of this Property is defined during DesignTime.
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LookupFields
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: A comma seperated list of Column names. The value of those fields
gets filled into the corresponding Controls of the Property
LookupControls.
The value of this Property is defined during DesignTime.
Notes: Corresponding to the LookupControls

Returns CHARACTER
Top

PUBLIC CHARACTER LookupKeyField
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: The value of the field which is returned by the SmartLookup.
The value of this Property is defined during DesignTime.
Notes:

Returns CHARACTER
Top

PUBLIC System.Windows.Forms.Timer LookupTimer
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: The instance of the System.Windows.Forms.Timer component used by
this lookup to implement the delayed search
Notes:

Returns System.Windows.Forms.Timer
Top

PUBLIC INTEGER LookupTimerDelay
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: The number of msecs after a key has been pressed in a SmartLookup
until the entered value is looked up. This allows the user to enter
multiple keys before the value is looked up (in a data source).
Notes: The value of this Property is defined during DesignTime.

Returns INTEGER
Top

PUBLIC LOGICAL LookupTimerDisabled
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Allows to completely disable the lookup timer functioanlity
Notes: When this is set to true, the LookupTimerDelay is ignored

Returns LOGICAL
Top

PROTECTED CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
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 UltraGrid OwningGrid
Inherited from Consultingwerk.SmartComponents.Base.SmartLookup
Purpose: Gets and sets the reference to the grid that owns this SmartLookup
as an Embedded Editor Control for a cell
Notes:

Returns UltraGrid
Top

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


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