NavigateEnabled property (WinStudio scripts)

Applies To

IWSIDOCollection interface

Definition

Enables/Disables navigation for a specified IDO collection, or returns a Boolean value indicating whether navigation is enabled for the collection.

Set Syntax

object.NavigateEnabled = Boolean

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

Get Syntax

object.NavigateEnabled

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

Remarks

The navigation operation allows end users to move to the first, last, next, and previous objects in the current collection using toolbar icons, [Actions] menu items, or keyboard commands. When navigation is disabled, these icons are disabled on the toolbar, no navigation options appear on the [Actions] menu, and none of the navigation key commands work.

For the get syntax, a return value of:

  • TRUE indicates that navigation is enabled for the collection.
  • FALSE indicates that navigation is disabled for the collection.

Examples

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

Sub Main()
   Dim oCache As IWSIDOCollection
   oCache = ThisForm.CurrentIDOCollection
   If oCache.NavigateEnabled Then
      oCache.NavigateEnabled = False
      Application.ShowMessage("Navigation is disabled for this collection.")
   Else
      oCache.NavigateEnabled = True
      Application.ShowMessage("Navigation is now enabled.")
   End If
End Sub