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

File:SmartDynamicFilterControl
Purpose:Dynamic SmartFilter implementation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jan 05 14:43:55 CET 2019



Top Method Summary
Options Name Purpose
# AddDesignTimeLabel () Adds a label to the Control
# CollectCharacterFilterValues (ListQueryExpressionByTable, character, UltraTextEditor, UltraTextEditor, character) Collectes Filter values for a character column
# CollectDateTimeFilterValues (ListQueryExpressionByTable, character, UltraDateTimeEditor, UltraDateTimeEditor, character) Collectes Filter values for a datetime column
# CollectFilterValuesHandler (CollectFilterValuesEventArgs) Collects the Filter values
Overrides Consultingwerk.SmartComponents.Base.SmartFilterControl:CollectFilterValuesHandler (CollectFilterValuesEventArgs)
# CollectLogicalFilterValues (ListQueryExpressionByTable, character, UltraComboEditor, character) Collectes Filter values for a logical column
# CollectNumericFilterValues (ListQueryExpressionByTable, character, UltraNumericEditor, UltraNumericEditor, character) Collectes Filter values for a numerical column
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# System.Windows.Forms.Control FilterControlForDataType (character) Factory method for filter controls based on the data type
# FilterControlKeyDownHandler (Object, KeyEventArgs) Event handler for the KeyDown event of the Filter Controls
# FilterControlTextChangedHandler (Object, EventArgs) Raised when a filter control changes it's value
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER GetTranslatedString (character, character) Returns the translation for a string
- InitializeComponent () /* NOTE: The following method is automatically generated. We strongly suggest that the contents of this method only be modified using the Visual Designer to avoid any incompatible modifications. Modifying the contents of this method using a code editor will invalidate any support for this file. */
# KeyPressHandler (Object, KeyPressEventArgs) Event handler for the KeyPress event of the Filter fields
# OnFilterColumnDownKey (EventArgs) Raises the FilterColumnDownKey event
# OnFilterColumnValueChanged (FilterColumnValueChangedEventArgs) Raises the FilterColumnValueChanged event
# OnGetFilterDefaultOperator (GetFilterDefaultOperatorEventArgs) Raises the GetFilterDefaultOperator event
# OnLoad (EventArgs) Raises the Load Event
Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:OnLoad (EventArgs)
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# OperatorComboValueChangedHandler (Object, EventArgs) Event handler for the ValueChanged event of the OperatorCombo
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# PopulateOptionalFields () Populates the List View with the optional filter fields
+ RegisterSmartFilterTarget (ISmartFilterTarget) Registers the SmartFilterTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartFilterControl
# RemoveFilterField (ColumnPropDesc) Removes a Filter Field
# System.Windows.Forms.Control RenderFilterField (ColumnPropDesc) Renderd a Filter Field
# RenderInitialFields () Renders the initial filter fields
# RetrieveData () Calls RetrieveData method of the FilterTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartFilterControl
+ SetComboboxOperatorList (UltraComboEditor, character) Populates the Combobox with the filter operators
+ 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
- ultraButton1_Click (Object, EventArgs) Event handler for the Click Event of the ultraButton1
- ultraListView1_ItemCheckStateChanged (Object, ItemCheckStateChangedEventArgs) Event handler for the ItemCheckStateChanged event of the ultraListView1

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

Top Event Summary
Options Name Purpose
+ FilterColumnDownKey DELEGATE System.EventHandler Raised when the cursor down key was pressed
+ FilterColumnValueChanged (Object, FilterColumnValueChangedEventArgs) Raised when a filter field changes it's value
+ GetFilterDefaultOperator (Object, GetFilterDefaultOperatorEventArgs) Raised when the Filter renders a filter field

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


Method Detail
Top

PROTECTED AddDesignTimeLabel ()

Purpose: Adds a label to the Control
Notes:

Top

PROTECTED CollectCharacterFilterValues (ListQueryExpressionByTable, character, UltraTextEditor, UltraTextEditor, character)

Purpose: Collectes Filter values for a character column
Notes:

Parameters:
poQueryExpressions Consultingwerk.ListQueryExpressionByTable
The list of Query Expressions per Table
pcColumn CHARACTER
The name of the Dataset field
poFrom Infragistics.Win.UltraWinEditors.UltraTextEditor
The reference to the editor with the "From" value
poTo Infragistics.Win.UltraWinEditors.UltraTextEditor
The reference to the editor with the "To" value
pcOperator CHARACTER
The filter operator
Top

PROTECTED CollectDateTimeFilterValues (ListQueryExpressionByTable, character, UltraDateTimeEditor, UltraDateTimeEditor, character)

Purpose: Collectes Filter values for a datetime column
Notes:

Parameters:
poQueryExpressions Consultingwerk.ListQueryExpressionByTable
The list of Query Expressions per Table
pcColumn CHARACTER
The name of the Dataset field
poFrom Infragistics.Win.UltraWinEditors.UltraDateTimeEditor
The reference to the editor with the "From" value
poTo Infragistics.Win.UltraWinEditors.UltraDateTimeEditor
The reference to the editor with the "To" value
pcOperator CHARACTER
The filter operator
Top

PROTECTED CollectFilterValuesHandler (CollectFilterValuesEventArgs)

Overrides Consultingwerk.SmartComponents.Base.SmartFilterControl:CollectFilterValuesHandler (CollectFilterValuesEventArgs)
Purpose: Collects the Filter values
Notes:

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

PROTECTED CollectLogicalFilterValues (ListQueryExpressionByTable, character, UltraComboEditor, character)

Purpose: Collectes Filter values for a logical column
Notes:

Parameters:
poQueryExpressions Consultingwerk.ListQueryExpressionByTable
The list of Query Expressions per Table
pcColumn CHARACTER
The name of the Dataset field
poFrom Infragistics.Win.UltraWinEditors.UltraComboEditor
The reference to the editor with the "From" value
pcOperator CHARACTER
The filter operator
Top

PROTECTED CollectNumericFilterValues (ListQueryExpressionByTable, character, UltraNumericEditor, UltraNumericEditor, character)

Purpose: Collectes Filter values for a numerical column
Notes:

Parameters:
poQueryExpressions Consultingwerk.ListQueryExpressionByTable
The list of Query Expressions per Table
pcColumn CHARACTER
The name of the Dataset field
poFrom Infragistics.Win.UltraWinEditors.UltraNumericEditor
The reference to the editor with the "From" value
poTo Infragistics.Win.UltraWinEditors.UltraNumericEditor
The reference to the editor with the "To" value
pcOperator CHARACTER
The filter operator
Top

PROTECTED CreateVerbs ()

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

Top

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

Purpose: Factory method for filter controls based on the data type
Notes:

Parameters:
pcDataType CHARACTER
Returns System.Windows.Forms.Control
Top

PROTECTED FilterControlKeyDownHandler (Object, KeyEventArgs)

Purpose: Event handler for the KeyDown event of the Filter Controls
Notes:

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

PROTECTED FilterControlTextChangedHandler (Object, EventArgs)

Purpose: Raised when a filter control changes it's value
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 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 CHARACTER GetTranslatedString (character, character)

Purpose: Returns the translation for a string
Notes:

Parameters:
pcKey CHARACTER
The translation key
pcDefaultText CHARACTER
The default text (in case translation is not available)
Returns CHARACTER
Top

PRIVATE InitializeComponent ()

/* NOTE: The following method is automatically generated.
We strongly suggest that the contents of this method only be modified using the
Visual Designer to avoid any incompatible modifications.
Modifying the contents of this method using a code editor will invalidate any support for this file.

Top

PROTECTED KeyPressHandler (Object, KeyPressEventArgs)

Purpose: Event handler for the KeyPress event of the Filter fields
Notes:

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

PROTECTED OnFilterColumnDownKey (EventArgs)

Purpose: Raises the FilterColumnDownKey event
Notes:

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

PROTECTED OnFilterColumnValueChanged (FilterColumnValueChangedEventArgs)

Purpose: Raises the FilterColumnValueChanged event
Notes:

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

PROTECTED OnGetFilterDefaultOperator (GetFilterDefaultOperatorEventArgs)

Purpose: Raises the GetFilterDefaultOperator event
Notes:

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

PROTECTED OnLoad (EventArgs)

Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:OnLoad (EventArgs)
Purpose: Raises the Load Event
Notes:

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 OperatorComboValueChangedHandler (Object, EventArgs)

Purpose: Event handler for the ValueChanged event of the OperatorCombo
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 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

PROTECTED PopulateOptionalFields ()

Purpose: Populates the List View with the optional filter fields
Notes:

Top

PUBLIC RegisterSmartFilterTarget (ISmartFilterTarget)

Inherited from Consultingwerk.SmartComponents.Base.SmartFilterControl
Purpose: Registers the SmartFilterTarget
Notes:

Parameters:
poTarget ISmartFilterTarget
The ISmartFilterTarget to register
Top

PROTECTED RemoveFilterField (ColumnPropDesc)

Purpose: Removes a Filter Field
Notes:

Parameters:
poColumn Progress.Data.ColumnPropDesc
The reference to the ColumnPropDesc
Top

PROTECTED System.Windows.Forms.Control RenderFilterField (ColumnPropDesc)

Purpose: Renderd a Filter Field
Notes: This method returns the reference to the created control,
so that in an override-method developers can manipulate
the properties of the control

Parameters:
poColumn Progress.Data.ColumnPropDesc
The reference to the ColumnPropDesc
Returns System.Windows.Forms.Control
The reference to the created control
Top

PROTECTED RenderInitialFields ()

Purpose: Renders the initial filter fields
Notes:

Top

PROTECTED RetrieveData ()

Inherited from Consultingwerk.SmartComponents.Base.SmartFilterControl
Purpose: Calls RetrieveData method of the FilterTarget
Notes:

Top

PUBLIC SetComboboxOperatorList (UltraComboEditor, character)

Purpose: Populates the Combobox with the filter operators
Notes:

Parameters:
poCombo Infragistics.Win.UltraWinEditors.UltraComboEditor
The reference to the UltraComboEditor
pcDataType CHARACTER
The ABL Data Type of the field
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

Top

PRIVATE ultraButton1_Click (Object, EventArgs)

Purpose: Event handler for the Click Event of the ultraButton1
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

PRIVATE ultraListView1_ItemCheckStateChanged (Object, ItemCheckStateChangedEventArgs)

Purpose: Event handler for the ItemCheckStateChanged event of the ultraListView1
Notes:

Parameters:
sender System.Object
The reference to the Control that raised the event
e Infragistics.Win.UltraWinListView.ItemCheckStateChangedEventArgs
The ItemCheckStateChangedEventArgs with the data for this event


Constructor Detail
Top

PUBLIC SmartDynamicFilterControl ()

Purpose: Constructor for the SmartDynamicFilterControl class
Notes:



Event Detail
Top

PUBLIC FilterColumnDownKey DELEGATE System.EventHandler

Purpose: Raised when the cursor down key was pressed
Notes:

Delegate: System.EventHandler
Top

PUBLIC FilterColumnValueChanged (Object, FilterColumnValueChangedEventArgs)

Purpose: Raised when a filter field changes it's value
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the FilterColumnValueChanged event
e Consultingwerk.SmartComponents.Implementation.FilterColumnValueChangedEventArgs
The FilterColumnValueChangedEventArgs with the data for the event
Top

PUBLIC GetFilterDefaultOperator (Object, GetFilterDefaultOperatorEventArgs)

Purpose: Raised when the Filter renders a filter field
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the GetFilterDefaultOperator event
e Consultingwerk.SmartComponents.Implementation.GetFilterDefaultOperatorEventArgs
The GetFilterDefaultOperatorEventArgs with the data for the event


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

PUBLIC CHARACTER FilterFieldsInitial


Returns CHARACTER
Top

PUBLIC CHARACTER FilterFieldsOptional


Returns CHARACTER
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

PUBLIC INTEGER NumFilterFields


Returns INTEGER
Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PUBLIC ISmartFilterTarget SmartFilterTarget

Inherited from Consultingwerk.SmartComponents.Base.SmartFilterControl

Returns ISmartFilterTarget
Top

PROTECTED LOGICAL UserControlEventsSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       14.08.2022 21:32:24