RoleTag Class

The RoleTag interface provides access to an Association's Role Tagged Values. Each connector end has a RoleTag collection that can be accessed to add, delete and access the RoleTags.

You might use this in creating code that resembles this fragment for accessing a RoleTag in VB.NET (where con is a Connector Object):

       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

 

Associated table in .EAP file     t_taggedvalue

RoleTag Attributes

Attribute

Type

Notes

See also

BaseClass

String

Read/Write

Indicates the role end; set to ASSOCIATION_SOURCE or ASSOCIATION_TARGET.

 

 

ElementGUID

String

Read/Write

The GUID of the connector with which this role tag is associated.

 

 

FQName

String

Read only

The fully qualified name of the tag.

 

 

ObjectType

ObjectType

Read only

Distinguishes objects referenced through a Dispatch interface.

 

ObjectType

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

GetAttribute (
string propName)

 

String

Returns the text of a single named property within a Structured Tagged Value.

 

GetLastError ()

String

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

 

HasAttributes ()

Boolean

Returns true if the Tagged Value is a Structured Tagged Value with one or more properties.

 

SetAttribute (
string propName, string propValue)

 

Boolean

Sets the text of a single named property within a Structured Tagged Value.

 

Update ()

Boolean

Update the RoleTag after changes or on initial creation.

If false is returned, check the GetLastError function for more information.