Namespace: Consultingwerk.Windows.Util
Class 
UltraGridFilterRowHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Windows.Util.UltraGridFilterRowHelper

Inherits: Progress.Lang.Object

File:UltraGridFilterRowHelper
Purpose:Supports building a QueryExpression from the values of the
UltraGrid's FilterRow
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Oct 11 02:36:04 CEST 2012

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ BuildQueryExpression (UltraGrid, ListQueryExpressionByTable) Returns an Array of IQueryExpression objects
+ BuildQueryExpression (UltraGrid, ListQueryExpressionByTable, logical) Returns an Array of IQueryExpression objects
+ BuildQueryExpression (UltraGrid, ListQueryExpressionByTable, logical, logical) Returns an Array of IQueryExpression objects
# Consultingwerk.QueryExpression BuildQueryExpressionForField (UltraGrid, character, character, Object, ListQueryExpressionByTable, OperatorEnum) Builds a QueryExpression for a single grid filter field
+ InitializeSupportedFilterOperators (UltraGrid) Initializes the supported fielter operators
+ Consultingwerk.OperatorEnum OperatorFromUltraGrid (FilterComparisionOperator) Returns the OperatorEnum matching the UltraGridFilterCell FilterOperator

Top Constructor Summary
Options Name Purpose
- UltraGridFilterRowHelper () Disallow instance creation


Method Detail
Top

PUBLIC BuildQueryExpression (UltraGrid, ListQueryExpressionByTable)
Purpose: Returns an Array of IQueryExpression objects
Notes: Defaults to BuildQueryExpression (poGrid, poListQueryExpressions, FALSE, FALSE)

Parameters:
poGrid Infragistics.Win.UltraWinGrid.UltraGrid
The source grid
poListQueryExpressions Consultingwerk.ListQueryExpressionByTable
The list of query operators per tables the expression will be added to
Top

PUBLIC BuildQueryExpression (UltraGrid, ListQueryExpressionByTable, logical)
Purpose: Returns an Array of IQueryExpression objects
Notes: MATCHES uses a flexible combination with BEGINS based on entered text
or BEGINS for character fields
Defaults to BuildQueryExpression (poGrid, poListQueryExpressions, plUseMatches, FALSE)

Parameters:
poGrid Infragistics.Win.UltraWinGrid.UltraGrid
The source grid
poListQueryExpressions Consultingwerk.ListQueryExpressionByTable
The list of query operators per tables the expression will be added to
plUseMatches LOGICAL
Logical value indicating if MATCHES should be used for Character fields
Top

PUBLIC BuildQueryExpression (UltraGrid, ListQueryExpressionByTable, logical, logical)
Purpose: Returns an Array of IQueryExpression objects
Notes: MATCHES uses a flexible combination with BEGINS based on entered text
or BEGINS for character fields
Supported UltraGrid FilterOperators per data type (plUseOperators = TRUE):
LOGICAL: Equals, NotEquals
DATE, DATETIME, DATETIME-TZ, Equals, NotEquals, GreaterThan, GreaterThanOrEqualTo,
DECIMAL, INTEGER, INT64: LessThan, LessThanOrEqualTo
CHARACTER, LONGCHAR: Equals, NotEquals, StartsWith, Like, EndsWith,
GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo

Parameters:
poGrid Infragistics.Win.UltraWinGrid.UltraGrid
The source grid
poListQueryExpressions Consultingwerk.ListQueryExpressionByTable
The list of query operators per tables the expression will be added to
plUseMatches LOGICAL
Logical value indicating if MATCHES should be used for Character fields
plUseOperators LOGICAL
Logical value indicating if the actual filter operator of the filter cell shall be used or a default operator (BEGINS, GE) shall be assumed
Top

PROTECTED Consultingwerk.QueryExpression BuildQueryExpressionForField (UltraGrid, character, character, Object, ListQueryExpressionByTable, OperatorEnum)
Purpose: Builds a QueryExpression for a single grid filter field
Notes:

Parameters:
poGrid Infragistics.Win.UltraWinGrid.UltraGrid
The source grid
pcKey CHARACTER
The key of the current column
pcHolderType CHARACTER
The type of the holder class for the field
poValue System.Object
The filter column value
poListQueryExpressions Consultingwerk.ListQueryExpressionByTable
The list of query operators per tables the expression will be added to
poOperator Consultingwerk.OperatorEnum
The operator to use
Returns Consultingwerk.QueryExpression
The Consultingwerk.QueryExpression for the specified filter field
Top

PUBLIC InitializeSupportedFilterOperators (UltraGrid)
Purpose: Initializes the supported fielter operators
Notes: Values depend on the Column's data types

Parameters:
poGrid Infragistics.Win.UltraWinGrid.UltraGrid
The source grid
Top

PUBLIC Consultingwerk.OperatorEnum OperatorFromUltraGrid (FilterComparisionOperator)
Purpose: Returns the OperatorEnum matching the UltraGridFilterCell FilterOperator
Notes: Supported UltraGrid FilterOperators per data type (plUseOperators = TRUE):
LOGICAL: Equals, NotEquals
DATE, DATETIME, DATETIME-TZ, Equals, NotEquals, GreaterThan, GreaterThanOrEqualTo,
DECIMAL, INTEGER, INT64: LessThan, LessThanOrEqualTo
CHARACTER, LONGCHAR: Equals, NotEquals, StartsWith, Like, EndsWith,
GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo
This method returns MATCHES for EndsWith. The BuildQueryExpression method
is required to convert the filter pattern from "abc" to "*abc"

Parameters:
poFilter Infragistics.Win.UltraWinGrid.FilterComparisionOperator
The FilterOperator of the UltraGridFilterCell
Returns Consultingwerk.OperatorEnum
The resulting OperatorEnum value


Constructor Detail
Top

PRIVATE UltraGridFilterRowHelper ()
Purpose: Disallow instance creation
Notes:



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