CreateLinkObjectEnum Method

  • Article

The CreateLinkObjectEnum method creates an enumeration for IGrooveFormsToolLinkObject objects.

Syntax

object.CreateLinkObjectEnum () As IGrooveFormsToolLinkObjectEnum

Return Value

The return value is an IGrooveFormsToolLinkObjectEnum object.

Remarks

The object created by this method implements both the IGrooveFormsToolLinkObjectEnumand IGrooveUnknownEnumCreate interfaces. The IGrooveFormToolLinkObjectEnum provides methods for iterating through the objects. The IGrooveUnknownEnumCreate interface provides the Add method to add Link Objects to the enumeration. To access the Add method, you must explicitly specify the interface name.

Example

In the following JavaScript excerpt, the IGrooveUnknownEnumCreate interface is explicitly specified first to access the Add method and then again in the SendInstantMessageWithLinks method. Note that you can access the IGrooveFormsToolLinkObjectEnum methods, such as HasMore, directly from the object.

var linkObject = app.CreateLinkObject(
  "Item requiring attention",
  GrooveFormsToolLinkType_Record,
  recordID);
var linkObjectEnum = app.CreateLinkObjectEnum();
linkObjectEnum.IGrooveUnknownEnumCreate.Add(linkObject);
app.SendInstantMessageWithLinks(URLEnum,
  "Please check status of following:",
  linkObjectEnum.IGrooveUnknownEnum);

See Also

Reference

IGrooveFormsToolLinkObject Interface
IGrooveUnknownEnumCreate Interface
IGrooveFormsToolUIDelegate Interface
SendInstantMessageWithLinks Method