Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartDataFieldForeignFieldsHandler Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:SmartDataFieldForeignFieldsHandler
Purpose:Provides support for handling Foreign Fields for SmartComboEditor
and SmartBusinessEntityLookup controls
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Mar 27 06:05:05 CET 2020



Top Method Summary
Options Name Purpose
# System.Windows.Forms.Control FindForeignField (character) Locates the Foreign Field
+ CHARACTER ForeignFieldValue (character) Returns the current value for a foreign field
+ InitializeForeignFields (ISmartDataFieldForeignFieldsClient, SmartViewerControl, character) Initializes the SmartDataFieldForeignFieldsHandler instance
+ CHARACTER ResolveForeignFields (character) Resolves the ForeignFields in the Query String
# SubscribeEvents () Subscribes to the events of the foreign fields
# ValueChangedHandler (Object, EventArgs) Event handler for the value changed event (or similar) of the controls
# ViewerSmartDataSourceChangedHandler (Object, EventArgs) Event handler for the SmartDataSource

Top Property Summary
Options Name Purpose
+ Consultingwerk.SmartComponents.Implementation.ISmartDataFieldForeignFieldsClient Client
+ CHARACTER ForeignFields
+ Consultingwerk.SmartComponents.Base.SmartViewerControl Viewer


Method Detail
Top

PROTECTED System.Windows.Forms.Control FindForeignField (character)

Purpose: Locates the Foreign Field
Notes: Returns ? for fields not on the viewer, but only in the Data Source

Parameters:
pcForeignFieldName CHARACTER
The name of the foreign field to locate
Returns System.Windows.Forms.Control
The reference to the control
Top

PUBLIC CHARACTER ForeignFieldValue (character)

Purpose: Returns the current value for a foreign field
Notes:

Parameters:
pcForeignFieldName CHARACTER
The name of the foreign field to locate
Returns CHARACTER
The character value
Top

PUBLIC InitializeForeignFields (ISmartDataFieldForeignFieldsClient, SmartViewerControl, character)

Purpose: Initializes the SmartDataFieldForeignFieldsHandler instance
Notes:

Parameters:
poClient Consultingwerk.SmartComponents.Implementation.ISmartDataFieldForeignFieldsClient
The reference to the ISmartDataFieldForeignFieldsClient (SmartComboEditor or SmartBusinessEntityLookup)
poViewer Consultingwerk.SmartComponents.Base.SmartViewerControl
The reference to the SmartViewerControl
pcForeignFields CHARACTER
The comma-delimited list of Foreign Fields
Top

PUBLIC CHARACTER ResolveForeignFields (character)

Purpose: Resolves the ForeignFields in the Query String
Notes:

Parameters:
pcQueryString CHARACTER
The Query String
Returns CHARACTER
The Query String with te foreign fields resolved
Top

PROTECTED SubscribeEvents ()

Purpose: Subscribes to the events of the foreign fields
Notes: For fields on the viewer we subscribe to their ValueChanged or TextChanged
events, for fields in the DataSource we subscribe to the CurrentChanged event
of the DataSource

Top

PROTECTED ValueChangedHandler (Object, EventArgs)

Purpose: Event handler for the value changed event (or similar) of the controls
Notes:

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

PROTECTED ViewerSmartDataSourceChangedHandler (Object, EventArgs)

Purpose: Event handler for the SmartDataSource
Notes:

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


Property Detail
Top

PUBLIC Consultingwerk.SmartComponents.Implementation.ISmartDataFieldForeignFieldsClient Client


Returns Consultingwerk.SmartComponents.Implementation.ISmartDataFieldForeignFieldsClient
Top

PUBLIC CHARACTER ForeignFields


Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartViewerControl Viewer


Returns Consultingwerk.SmartComponents.Base.SmartViewerControl


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       27.03.2024 00:30:16