GetDisplayedObjectName method (WinStudio scripts)

Applies To

IWSIDOCollection interface

Definition

Returns the collection name, which is displayed as the Actions menu name in the WinStudio menu bar.

Syntax

object.GetDisplayedObjectName

Part	Description
`object`	Required. The name of a valid IDO collection object.

Remarks

The return value is a string containing the collection name of the IDO collection object. A collection name is assigned by the developer as part of the collection specification.

If a collection name is not specified for a primary collection, the return value is primary collection. Similarly, the default return value for a subcollection is subcollection for <IDO name> and for a secondary collection, secondary collection n, where n is the number of the collection.

Example

Sub Main()
   ' Display name associated with the primary IDO collection.
   Application.ShowMessage(ThisForm.PrimaryIDOCollection.GetDisplayedObjectName())
   ' Display name associated with a secondary collection IDO collection.
   ThisForm.SetFocus("grid1")
   Application.ShowMessage(ThisForm.CurrentIDOCollection.GetDisplayedObjectName())
End Sub