WinStudio

RefreshEnabled Property

Applies To

IWSIDOCollection interface

Definition

Enables/Disables the ability to refresh a specified IDO collection, or returns a value indicating whether the collection can be refreshed.

Set Syntax

object.RefreshEnabled = Boolean

Part	Description
object	Required. A reference to a valid IDO collection object.
Boolean	Required. Determines whether the collection can be refreshed: True – The collection can be refreshed. False – The collection cannot be refreshed.

Get Syntax

object.RefreshEnabled

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

Remarks

When the Refresh option is disabled, the user cannot refresh the collection using:

The Actions menu, Refresh and Refresh current options
The Refresh and Refresh Current toolbar icons
The keyoard commands

For the get syntax, a return value of:

TRUE indicates that the Refresh options are enabled.
FALSE indicates that the Refresh options are disabled.

Examples

Sub Main()
   Dim oCache As IWSIDOCollection
   Dim sOption As String
   oCache = ThisForm.CurrentIDOCollection
   sOption = Trim(GetParameter(0))
   If sOption = "REFRESH" Then
     oCache.RefreshEnabled = True
   End If
End Sub

Sub Main()
   Dim oCache As IWSIDOCollection
   oCache = ThisForm.CurrentIDOCollection
   If oCache.RefreshEnabled Then
       oCache.RefreshEnabled = False
       Application.ShowMessage("You cannot refresh the collection at this time.")
   Else
       oCache.RefreshEnabled = True
       Application.ShowMessage("You can now refresh the collection.")
   End If
End Sub