Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.
Contents |
Prev | Next |
AttributeTag Class
An AttributeTag represents a Tagged Value associated with an attribute.
Associated table in .EAP file:
t_attributetag
AttributeTag Attributes:
Attribute |
Remarks |
See also |
---|---|---|
AttributeID |
Long Notes: Read/Write The local ID of the attribute associated with this Tagged Value. |
|
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 |
Notes: Read only Distinguishes objects referenced through a Dispatch interface. |
|
TagGUID |
String Notes: Read/Write A globally unique ID for this Tagged Value. |
|
TagID |
Long Notes: Read only The local ID to identify the Tagged Value. |
|
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. |
AttributeTag Methods:
Method |
Remarks |
See also |
---|---|---|
GetAttribute(string propName) |
String Notes: Returns the text of a single named property within a structured Tagged Value. |
|
GetLastError() |
String Notes: 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. |
|
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. |
|
Update() |
Boolean Notes: Updates the current AttributeTag object after modification or appending a new item. If False is returned, check the 'GetLastError()' function for more information. |