RoleTag

public Class

This interface provides access to the association Role Tagged Values. Each connector end has a RoleTag collection that can be accessed to add, delete and access the RoleTags.

In code you create something that resembles the following (where con is a Connector Object):

Code fragment for accessing a RoleTag in VB.NET:

 

       client = con.ClientEnd

       client.Role = "m_client"

       client.Update()

       tag = client.TaggedValues.AddNew("tag", "value")

       tag.Update()

       tag = client.TaggedValues.AddNew("tag2", "value2")

       tag.Update()

       client.TaggedValues.Refresh()

       For idx = 0 To client.TaggedValues.Count - 1

           tag = client.TaggedValues.GetAt(idx)

           Console.WriteLine(tag.Tag)

           client.TaggedValues.DeleteAt(idx, False)

       Next

       tag = Nothing

RoleTag Attributes

Attribute

Type

Notes

BaseClass

String

Read/Write. Indicates the role end; set to ASSOCIATION_SOURCE or ASSOCIATION_TARGET.

ElementGUID

String

Read/Write. GUID of the connector with which this role tag is associated.

ObjectType

ObjectType

Read only. Distinguishes objects referenced through a Dispatch interface.

PropertyGUID

String

Read/Write. A system generated GUID to identify the Tagged Value.

Tag

String

Read/Write. The actual tag name.

Value

String

Read/Write. The value associated with this tag.

RoleTag Methods

Method

Type

Notes

GetLastError ()

String

Returns a string value describing the most recent error that occurred in relation to this object.

This function is rarely used as an exception is thrown when an error occurs.

Update ()

Boolean

Update the RoleTag after changes or on initial creation. If false is returned, check the GetLastError function for more information.