[RBASE-L] - Tip of the Day - Dynamically Passing DB Grid Filter Parameters

[A. Razzak Memon]

Thursday, April 28, 2011

Tip of the Day - Dynamically Passing DB Grid Filter Parameters
Product: R:BASE eXtreme 9.1 (32/64)
Update.: 3 (Maintenance Release)
Build..: 9.1.3.10428 or higher http://www.rupdates.com
Section: Enhanced DB Grid Filter PROPERTY/GETPROPERTY Commands
In addition to many New and Enhanced Controls and Properties in
R:BASE eXtreme 9.1, Enhanced DB Grid in Form Designer includes
the option to "Show Filter Bar".

Enabling this option will display a filter bar directly under
the titles which allows end-user to enter value to limit the
displayed grid records based on matching criteria. You may also
pre-define the Filter Pick List by selecting "Column Values",
if you wish.

Did you know that you can dynamically pass filter parameters as
"On After Start Custom EEP" or "On Demand", using the expanded
Enhanced DB Grid Filter PROPERTY commands?

Here is a comprehensive list of supported PROPERTY/GETPROPERTY
commands that are specific to Enhanced DB Grid Filter Bar.

-- Passing Filter Value for a Given Column Number
-- Syntax
   PROPERTY CompID FILTERS[NNN]->VALUE filter_value
-- Example
   PROPERTY EDBGridCust FILTERS[2]->VALUE 'CA'

-- Passing Filter Value for Given Column Name
-- Syntax
   PROPERTY CompID FILTERS->COLUMN_NAME->ColName filter_value
-- Example
   PROPERTY EDBGridCust FILTERS->COLUMN_NAME->CustState 'CA'

-- Capturing Filter Value for Given Column Number
-- Syntax
   GETPROPERTY CompID FILTERS[NNN]->VALUE VarName
-- Example:
   GETPROPERTY EDBGridCust FILTERS[2]->VALUE vStateFilter

-- Capturing Filter Value for Given Column Name
-- Syntax
   GETPROPERTY CompID FILTERS->COLUMN_NAME->ColName VarName
-- Example
   GETPROPERTY EDBGridCust FILTERS->COLUMN_NAME->CustState vValue

-- Clearing Filter Value for Given Column Number
-- Syntax
   PROPERTY CompID FILTERS[NNN]->CLEAR_ITEMS TRUE
-- Example
   PROPERTY EDBGridCust FILTERS[2]->CLEAR_ITEMS TRUE

-- Clearing Filter Value for Given Column Name
-- Syntax
   PROPERTY CompID FILTERS->COLUMN_NAME->ColName->CLEAR_ITEMS TRUE
-- Example
   PROPERTY EDBGridCust FILTERS->COLUMN_NAME->CustState->CLEAR_ITEMS TRUE

-- Dynamically Defining Single Filter Item for a Given Column Number
-- Syntax
   PROPERTY ComponentID FILTERS[NNN]->ADD_ITEMS Value
-- Example
   PROPERTY EnhDBGridCust FILTERS[2]->ADD_ITEMS 'MO'

-- Dynamically Defining Single Filter Item for a Given Column Name
-- Syntax
   PROPERTY CompID FILTERS->COLUMN_NAME->ColName->ADD_ITEM ItemValue
-- Example
   PROPERTY EDBGridCust FILTERS->COLUMN_NAME->CustState->ADD_ITEMS 'MO'

-- Dynamically Defining Multiple Filter Items for a Given Column Number
-- Syntax
   PROPERTY CompID FILTERS[NNN]->ADD_ITEMS Value
-- Example:
   PROPERTY EDBGridCust FILTERS[2]->ADD_ITEMS 'MO|HN|NY|CT'

-- Dynamically Defining Multiple Filter Items for a Given Column Name
-- Syntax
   PROPERTY CompID FILTERS->COLUMN_NAME->ColName->ADD_ITEMS Value
-- Example
   PROPERTY EDBGridCust FILTERS->COLUMN_NAME->CustState->ADD_ITEMS 
'MO|HN|NY|CT'

-- To repopulate the filter from column values for a given column number
-- Syntax
   PROPERTY CompID FILTERS[NNN]->ADD_COLUMN_VALUES TRUE
-- Example
   PROPERTY EDBGridCust FILTERS[2]->ADD_COLUMN_VALUES TRUE

-- To repopulate the filter from column values for a given column name
-- Syntax
   PROPERTY CompID FILTERS->COLUMN_NAME->ColName->ADD_COLUMN_VALUES TRUE
-- Example
   PROPERTY EDBGridCust 
FILTERS->COLUMN_NAME->CustState->ADD_COLUMN_VALUES TRUE

-- To clear all filter values at once
-- Syntax
   PROPERTY CompID CLEARFILTER TRUE
-- Example
   PROPERTY EDBGridCust CLEARFILTER TRUE

Have fun implementing these properties in your R:BASE eXtreme 9.1 applications!

Very Best R:egards,

Razzak.

P.S.
For more details, examples, and Syntax Builder, refer to R:Docs 9.1 (Update 3).
http://www.rupdates.com