FilterEnabled property (WinStudio scripts)

Applies To

IWSIDOCollection interface

Definition

Enables/Disables the Filter option on the Actions menu for the specified IDO collection object, or returns a Boolean value indicating whether filtering is enabled for the collection.

Set Syntax

object.FilterEnabled = Boolean

  Part   Description
object Required. A reference a valid IDO collection object.
Boolean Required. Determines whether the Filter option is enabled:
  • True: Enables the Filter option.
  • False: Disables the Filter option.

    In this case, the Filter option does not appear on the Actions menu.

Get Syntax

object.FilterEnabled

  Part   Description
object Required. A reference to a valid IDO collection object.

Remarks

In the get syntax, a return value of:

  • TRUE indicates that the “Filter” option is enabled on the “Actions” menu.
  • FALSE indicates that the “Filter” option is disabled and does not appear on the “Actions” menu.

Examples

Sub Main()
   If Not ThisForm.CurrentIDOCollection.FilterEnabled Then
      Application.ShowMessage("Filtering is not enabled for this collection.")
   Else
      Application.ShowMessage("Click the Query button to filter criteria.")
   End If
End Sub

Sub Main()
   If Not ThisForm.CurrentIDOCollection.FilterEnabled Then
      ThisForm.CurrentIDOCollection.FilterEnabled = True
   End If
End Sub