Difference between revisions of "ISFILTERED()"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Function to test if table has an active filter expression
 
Function to test if table has an active filter expression
 
  
 
==Syntax==
 
==Syntax==
 
ISFILTERED([<workarea | alias>])
 
ISFILTERED([<workarea | alias>])
 
  
 
==See Also==
 
==See Also==
[[DBFILTER()]], [[FILTER()]], [[SET DELETED]], [[SET FILTER]], [[SET VIEW]]
+
[[DBFILTER()]], [[FILTER()]], [[SET DELETED]], [[SET FILTER]]
 
+
  
 
==Description==
 
==Description==
 
The ISFILTERED() function tests whether a table has an active filter expression.  If the optional <workarea | alias> is specified, then the function will operate on the specified <workarea | alias>.  ISFILTERED() returns .T. (True) if a filter is active in the current or specified table and .F. if there is no active filter or no active table in the current or specified workarea.
 
The ISFILTERED() function tests whether a table has an active filter expression.  If the optional <workarea | alias> is specified, then the function will operate on the specified <workarea | alias>.  ISFILTERED() returns .T. (True) if a filter is active in the current or specified table and .F. if there is no active filter or no active table in the current or specified workarea.
 
  
 
==Example==
 
==Example==
Line 23: Line 19:
 
</code>
 
</code>
  
 
==Products==
 
Recital Server, Recital
 
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Cursor Functions]]

Latest revision as of 04:52, 7 December 2012

Purpose

Function to test if table has an active filter expression

Syntax

ISFILTERED([<workarea | alias>])

See Also

DBFILTER(), FILTER(), SET DELETED, SET FILTER

Description

The ISFILTERED() function tests whether a table has an active filter expression. If the optional <workarea | alias> is specified, then the function will operate on the specified <workarea | alias>. ISFILTERED() returns .T. (True) if a filter is active in the current or specified table and .F. if there is no active filter or no active table in the current or specified workarea.

Example

use patrons
set filter to event="BALLET"
? isfiltered()
.T.