Namespace: Consultingwerk.SmartComponents.Support
Class 
SmartBusinessEntityLookupDialog Copy to Clipboard
Parent classes:
Progress.Windows.Form
Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialogDesigner
Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialog

Inherits: Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialogDesigner
Implements: Consultingwerk.SmartComponents.Interfaces.IDefaultActionSubscriber, Consultingwerk.SmartComponents.Interfaces.ISmartBusinessEntityLookupDialog

File:SmartBusinessEntityLookupDialog
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Tue Apr 07 08:34:51 CEST 2009

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
# ApplyFilter () Applys the filter to the query
- BrowserInitializeLayout (Object, InitializeLayoutEventArgs) Event handler for the InitializeLayout event of the Lookup Grid Control
+ CHARACTER GetLookupFieldValue (character) Returns a Field Value from the Business Entity Adapter
+ InitializeDataAdapter () Initializes the DataAdapter used by the SmartBusinessEntityLookupDialog
- InitializeDataBinding () Initializes the Data Binding
# InitializeExceptFields () Initializes the ExceptField Lists of the Data Adapter
# InitialRetrieveData () Retrieves the initial data in the Lookup Dialog
# OnAfterInitializeBusinessEntityAdapter (AfterInitializeBusinessEntityAdapterEventArgs) Raises the AfterInitializeBusinessEntityAdapter event
# OnLoad (EventArgs) Raises the Load event
Overrides Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialogDesigner:OnLoad (EventArgs)
# OnPaintBackground (PaintEventArgs) Raises the PaintBackground event
Inherited from Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialogDesigner
# OnShown (EventArgs) Raises the Shown event
# ResetFilter () Resets the filter of the query
- RestoreLookupSettings () Restores the stored settings for this lookup
# SetGlassRegion () Defines the transparent region
Inherited from Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialogDesigner
+ SetText (character) Sets the Title of the Lookup Dialog
+ SmartDataBrowserDefaultActionHandler (SmartDataBrowser, EventArgs) Method to be executed inside the class which implements the Interface IDefaultActionSubscriber.
- StoreLookupSettings (Object, EventArgs) Event handler for the Closed event of the Lookup Dialog
# tbSearchField_EditorButtonClick (Object, EditorButtonEventArgs) Event handler for the EditorButtonClick event of the tbSearchField
# tbSearchField_KeyDown (Object, KeyEventArgs) Event handler for the KeyDown event of the tbSearchField

Top Constructor Summary
Options Name Purpose
+ SmartBusinessEntityLookupDialog () Constructor for the SmartBusinessEntityLookupDialog class
+ SmartBusinessEntityLookupDialog (character) Constructor for the SmartBusinessEntityLookupDialog class
+ SmartBusinessEntityLookupDialog (SmartLookup) Constructor for the SmartBusinessEntityLookupDialog class

Top Event Summary
Options Name Purpose
+ AfterInitializeBusinessEntityAdapter (Object, AfterInitializeBusinessEntityAdapterEventArgs) Event raised when the lookups SmartBusinessEntityAdapter is initialized

Top Property Summary
Options Name Purpose
+ CHARACTER AdapterType Name of the Type of SmartBusinessEntityAdapter used to lookup values from the backend.
+ CHARACTER AppServerPartition Gets/Sets the name of the AppServer Partition to be used by this SmartDataAdapter instance
+ Infragistics.Win.UltraWinGrid.UltraGrid LookupBrowser Returns the reference to the Lookup Browser
+ CHARACTER LookupBrowserExcludeFields Fields not to be shown in the SmartDataBrowser
+ CHARACTER LookupBrowserFields Fields to be shown in the SmartDataBrowser
+ CHARACTER LookupDialogFilterFields Fields that allow to Filter on the Lookup Browser Dialog
+ CHARACTER LookupDialogFilterOperators Operators for the LookupDialogFilterFields
+ LOGICAL LookupDialogOpenQuery Option to open the Lookup Dialog Query when the dialog is opened
+ CHARACTER LookupDialogQuerySort QuerySort used when opening the Lookup Browser Dialog
+ CHARACTER LookupDialogQueryString QueryString used when opening the Lookup Browser Dialog
+ CHARACTER LookupEntityName Gets and sets the Lookup Entity Name
+ CHARACTER LookupEntityTable Gets and sets the Lookup Entity Table
+ CHARACTER LookupEntityView Gets and sets the Lookup Entity View
+ CHARACTER LookupKeyField Field that is returned by the SmartLookup
+ Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter LookupSmartBusinessEntityAdapter Sets and sets a reference to the SmartBusinessEntityAdapter instance used by the SmartBusinessEntityAdapter
+ LOGICAL SearchPromptInSearchField Returns if the Search Field still contains the Search Prompt
Inherited from Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialogDesigner


Method Detail
Top

PROTECTED ApplyFilter ()
Purpose: Applys the filter to the query
Notes:

Top

PRIVATE BrowserInitializeLayout (Object, InitializeLayoutEventArgs)
Purpose: Event handler for the InitializeLayout event of the Lookup Grid Control
Notes: Make sure that only the given list of LookupBrowserFields and none
of the fields in LookupBrowserExcludeFields are visible.
If LookupBrowserFields is an empty string all columns will be shown

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

PUBLIC CHARACTER GetLookupFieldValue (character)
Purpose: Returns a Field Value from the Business Entity Adapter
Notes:

Parameters:
pcFieldName CHARACTER
The name of the Field to return
Returns CHARACTER
The value of the field
Top

PUBLIC InitializeDataAdapter ()
Purpose: Initializes the DataAdapter used by the SmartBusinessEntityLookupDialog
Notes:

Top

PRIVATE InitializeDataBinding ()
Purpose: Initializes the Data Binding
Notes:

Top

PROTECTED InitializeExceptFields ()
Purpose: Initializes the ExceptField Lists of the Data Adapter
Notes:

Top

PROTECTED InitialRetrieveData ()
Purpose: Retrieves the initial data in the Lookup Dialog
Notes: Performs a FindRowWhere call instead of RetrieveData when the lookup
control contains a value. This is to avoid an extra backend call
(SCL-960)

Top

PROTECTED OnAfterInitializeBusinessEntityAdapter (AfterInitializeBusinessEntityAdapterEventArgs)
Purpose: Raises the AfterInitializeBusinessEntityAdapter event
Notes:

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

PROTECTED OnLoad (EventArgs)
Overrides Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialogDesigner:OnLoad (EventArgs)
Purpose: Raises the Load event
Notes:

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

PROTECTED OnPaintBackground (PaintEventArgs)
Inherited from Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialogDesigner
Purpose: Raises the PaintBackground event
Notes:

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

PROTECTED OnShown (EventArgs)
Purpose: Raises the Shown event
Notes:

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

PROTECTED ResetFilter ()
Purpose: Resets the filter of the query
Notes:

Top

PRIVATE RestoreLookupSettings ()
Purpose: Restores the stored settings for this lookup
Notes:

Top

PROTECTED SetGlassRegion ()
Inherited from Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialogDesigner
Purpose: Defines the transparent region
Notes:

Top

PUBLIC SetText (character)
Purpose: Sets the Title of the Lookup Dialog
Notes:

Parameters:
pcText CHARACTER
The Text to be used as the Forms Title
Top

PUBLIC SmartDataBrowserDefaultActionHandler (SmartDataBrowser, EventArgs)
Purpose: Method to be executed inside the class which implements the Interface
IDefaultActionSubscriber.
Notes: Invoked by the SmartDataBrowser Instance if the DefaultActionHandler
Method is executed.

Parameters:
sender Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
The reference to the Instance of the SmartDataBrowser which has invoked the Method
e System.EventArgs
The System.EventArgs with the data for this event
Top

PRIVATE StoreLookupSettings (Object, EventArgs)
Purpose: Event handler for the Closed event of the Lookup Dialog
Notes: Stores the Lookup Settings in the Settings Service

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 tbSearchField_EditorButtonClick (Object, EditorButtonEventArgs)
Purpose: Event handler for the EditorButtonClick event of the tbSearchField
Notes:

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

PROTECTED tbSearchField_KeyDown (Object, KeyEventArgs)
Purpose: Event handler for the KeyDown event of the tbSearchField
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.KeyEventArgs
The KeyEventArgs with the data for this event


Constructor Detail
Top

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

Top

PUBLIC SmartBusinessEntityLookupDialog (character)
Purpose: Constructor for the SmartBusinessEntityLookupDialog class
Notes:

Parameters:
pcLookupRegistryKey CHARACTER
The settings key to use for the Lookup Dialog to store grid and dialog settings
Top

PUBLIC SmartBusinessEntityLookupDialog (SmartLookup)
Purpose: Constructor for the SmartBusinessEntityLookupDialog class
Notes: This constructor calls back into the Lookup Control to receive the
Lookup Dialog Settings Registrykey

Parameters:
poSmartLookup Consultingwerk.SmartComponents.Base.SmartLookup
The reference to the SmartLookup instance for this LookupDialog


Event Detail
Top

PUBLIC AfterInitializeBusinessEntityAdapter (Object, AfterInitializeBusinessEntityAdapterEventArgs)
Purpose: Event raised when the lookups SmartBusinessEntityAdapter is initialized
Notes:

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


Property Detail
Top

PUBLIC CHARACTER AdapterType
Purpose: Name of the Type of SmartBusinessEntityAdapter used to lookup
values from the backend.
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER AppServerPartition
Purpose: Gets/Sets the name of the AppServer Partition to be used
by this SmartDataAdapter instance
Notes:

Returns CHARACTER
Top

PUBLIC Infragistics.Win.UltraWinGrid.UltraGrid LookupBrowser
Purpose: Returns the reference to the Lookup Browser
Notes:

Returns Infragistics.Win.UltraWinGrid.UltraGrid
Top

PUBLIC CHARACTER LookupBrowserExcludeFields
Purpose: Fields not to be shown in the SmartDataBrowser
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LookupBrowserFields
Purpose: Fields to be shown in the SmartDataBrowser
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LookupDialogFilterFields
Purpose: Fields that allow to Filter on the Lookup Browser Dialog
Notes: Comma-Delimited, first entry is default

Returns CHARACTER
Top

PUBLIC CHARACTER LookupDialogFilterOperators
Purpose: Operators for the LookupDialogFilterFields
Notes: Comma-Delimited, first entry is default

Returns CHARACTER
Top

PUBLIC LOGICAL LookupDialogOpenQuery
Purpose: Option to open the Lookup Dialog Query when the dialog is opened
Notes: SCL-673

Returns LOGICAL
Top

PUBLIC CHARACTER LookupDialogQuerySort
Purpose: QuerySort used when opening the Lookup Browser Dialog
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LookupDialogQueryString
Purpose: QueryString used when opening the Lookup Browser Dialog
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LookupEntityName
Purpose: Gets and sets the Lookup Entity Name
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LookupEntityTable
Purpose: Gets and sets the Lookup Entity Table
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LookupEntityView
Purpose: Gets and sets the Lookup Entity View
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LookupKeyField
Purpose: Field that is returned by the SmartLookup
Notes:

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter LookupSmartBusinessEntityAdapter
Purpose: Sets and sets a reference to the SmartBusinessEntityAdapter instance
used by the SmartBusinessEntityAdapter
Notes: Not currently used in this class. Allows custom ISmartBusinessEntityLookupDialog
implementations to access the BusinessEntityAdapter of the Lookup
control itself

Returns Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter
Top

PUBLIC LOGICAL SearchPromptInSearchField
Inherited from Consultingwerk.SmartComponents.Support.SmartBusinessEntityLookupDialogDesigner
Purpose: Returns if the Search Field still contains the Search Prompt
Notes:

Returns LOGICAL


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