ApplySavedFilter method (WinStudio scripts)

Applies To

IWSForm interface

Definition

Applies a saved query filter to a specified form and returns a Boolean value indicating whether the filter was successfully applied.

Syntax

object.ApplySavedFilter( string )

  Part   Description
object Required. Reference to a valid form object.
string Required. The name of a saved filter.

Remarks

Query filters must have been previously saved in the context of a query form for this method to work.

A return value of:

  • TRUE indicates that the saved filter was successfully applied.
  • FALSE indicates that the saved filter was not successfully applied.

Example

Sub Main()
   Dim Successful As Boolean
   Successful = ThisForm.ApplySavedFilter("myFilter")
   Application.ShowMessage(Successful.ToString)
End Sub