Please note : This help page is for an older version of Enteprise Archtiect. The latest help can be found here.

Topic
Prev Next

TaggedValue Class

A TaggedValue is a named property and value associated with an element. Tagged Values can be accessed through the TaggedValues collection.

Associated table in .EAP file

t_objectproperties

TaggedValue Attributes

Attribute

Description

See also

ElementID

Long

Notes: Read/Write

The local ID of the associated element.

FQName

String

Notes: Read only

The fully-qualified name of the tag.

Name

String

Notes: Read/Write

The name of the tag.

Notes

String

Notes: Read/Write

Further descriptive notes about this tag.

If 'Value' is set to '<memo>', then 'Notes' should contain the actual Tagged Value content.

ObjectType

ObjectType

Notes: Read only

Distinguishes objects referenced through a Dispatch interface.

ObjectType

PropertyGUID

String

Notes: Read/Write

The global ID of the tag.

PropertyID

Long

Notes: Read only

The local ID of the tag.

Value

String

Notes: Read/Write

The value assigned to this tag.

This field has a 255 character limit. If the value is greater than 255 characters long, set the value to "<memo>" and insert the body of text in the 'Notes' attribute.

When reading existing Tagged Values, if 'Value'' = "<memo>" then the developer should read the actual body of text from the 'Notes' attribute.

TaggedValue Methods

Method

Description

See also

GetAttribute(string propName)

String

Notes: Returns the text of a single named property within a structured Tagged Value.

Parameters:

  • propName: String - the name of the property for which the text is being returned

GetLastError()

String

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

HasAttributes()

Boolean

Notes: Returns True if the Tagged Value is a structured Tagged Value with one or more properties.

SetAttribute(string propName, string propValue)

Boolean

Notes: Sets the text of a single named property within a structured Tagged Value.

Parameters:

  • propName: String - the name of the property for which the text is being set
  • propValue: the value of the property

Update()

Boolean

Notes: Updates the current TaggedValue object after modification or appending a new item.

If False is returned, check the 'GetLastError()' function for more information.