Namespace: Consultingwerk.SmartComponents.Base
Class 
SmartFilterControl Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: Consultingwerk.SmartComponents.Interfaces.Design.IDesignFilterSource, IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.ISmartFilterSource
Inherited by: Consultingwerk.SmartComponents.Implementation.SmartDynamicFilterControl

File:SmartFilterControl
Purpose:(Abstract) base class for Filter Controls
Description:This class is intended to be used as a base class for
filter controls. Filter controls are supposed to override
the method CollectFilterValuesHandler. A fully dynamic
implementation is the SmartDynamicFilterControl
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jan 05 14:29:53 CET 2019
Purpose: Returns the SmartFilterTarget
Notes:



Top Method Summary
Options Name Purpose
# CollectFilterValuesHandler (CollectFilterValuesEventArgs) This method is intended to be overridden by Filter Controls
- CollectFilterValuesHandler (Object, CollectFilterValuesEventArgs) Event handler of the CollectFilterValues evet of the SmartFilterTarget
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# OnLoad (EventArgs) Raises the Load event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ RegisterSmartFilterTarget (ISmartFilterTarget) Registers the SmartFilterTarget
# RetrieveData () Calls RetrieveData method of the FilterTarget
+ SubscribeParentFormDestroyed () Subscribes the ParentFormDestroyed event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# SubscribeUserControlEvents () Allows for custom event subscriptions during OnLoad()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Top Property Summary
Options Name Purpose
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ Consultingwerk.SmartComponents.Interfaces.ISmartFilterTarget SmartFilterTarget
# LOGICAL UserControlEventsSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl


Method Detail
Top

PROTECTED CollectFilterValuesHandler (CollectFilterValuesEventArgs)

Purpose: This method is intended to be overridden by Filter Controls
Notes:

Parameters:
poParameter Consultingwerk.SmartComponents.Implementation.CollectFilterValuesEventArgs
The CollectFilterValuesEventArgs with the data for this call
Top

PRIVATE CollectFilterValuesHandler (Object, CollectFilterValuesEventArgs)

Purpose: Event handler of the CollectFilterValues evet of the SmartFilterTarget
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the component that raised this event
e Consultingwerk.SmartComponents.Implementation.CollectFilterValuesEventArgs
The CollectFilterValuesEventArgs with the data for this event
Top

PROTECTED CreateVerbs ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PUBLIC System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Returns a List of all Components in the Form
Notes: Supported on OpenEdge 11 only, due to dependency to the ComponentsCollection
list not available on 10.2B

Returns System.Collections.Generic.List <System.ComponentModel.Component>
The List of Components in the Form
Top

PROTECTED OnLoad (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Raises the Load event
Notes: Subscribes the FormDestroyed event from the ParentForm

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

PUBLIC OnVerbClicked (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event Handler method for Designer Verbs
Notes: This method is intended to be overridden

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

PROTECTED ParentFormDestroyedHandler (Object, EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event handler for the FormDestroyed event of the owning Form
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

PUBLIC RegisterSmartFilterTarget (ISmartFilterTarget)

Purpose: Registers the SmartFilterTarget
Notes:

Parameters:
poTarget Consultingwerk.SmartComponents.Interfaces.ISmartFilterTarget
The ISmartFilterTarget to register
Top

PROTECTED RetrieveData ()

Purpose: Calls RetrieveData method of the FilterTarget
Notes:

Top

PUBLIC SubscribeParentFormDestroyed ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Subscribes the ParentFormDestroyed event
Notes:

Top

PROTECTED SubscribeUserControlEvents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Allows for custom event subscriptions during OnLoad()
Notes: Intended to be overridden in the inheriting user control



Property Detail
Top

PROTECTED CHARACTER DesignerVerbs

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PROTECTED CHARACTER NonBrowsableProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartFilterTarget SmartFilterTarget


Returns Consultingwerk.SmartComponents.Interfaces.ISmartFilterTarget
Top

PROTECTED LOGICAL UserControlEventsSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       27.09.2022 23:48:29