NotesEnabled property (WinStudio scripts)

Applies To

IWSIDOCollection interface

Definition

Enables/Disables the ability to create and view notes for a specified IDO collection, or returns a value indicating whether notes are enabled for the collection.

Set Syntax

object.NotesEnabled = Boolean

  Part   Description
object Required. A reference to a valid IDO collection object.
Boolean Required. Determines whether notes capabiities are enabled for the collection:
  • True: Enables notes.
  • False: Disables notes.

Get Syntax

object.NotesEnabled

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

Remarks

When notes are enabled for a collection, users can create and view notes of all types for that collection. When notes are disabled, the Actions menu Notes for All and Notes for Current options do not appear, and the Notes toolbar button is disabled.

For the get syntax, a return value of:

  • TRUE indicates that notes are enabled.
  • FALSE indicates that notes are disabled.

Examples

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

Sub Main()
   Dim oCache As IWSIDOCollection
   oCache = ThisForm.CurrentIDOCollection
   If oCache.NotesEnabled Then
      oCache.NotesEnabled = False
      Application.ShowMessage("You cannot create notes for this collection.")
   Else
      oCache.NotesEnabled = True
      Application.ShowMessage("Notes are now enabled for this collection.")
   End If
End Sub