A user attribute is a piece of data, such as a reference to an external database, that you can attach to an Imagenation entity (a document, page, or layer) or make globally available. Some user attributes are predefined, but you can also set your own. These are treated as a "black box"--the data is stored, but is not manipulated in any way. All user attributes are stored as text.
To request current user attributes:
· Use the GetUserAttribute(docwinID, <pageID>, <layerID>, "attributeName") transaction.
For global and document attributes, use only the docwinID (and attributeName). For page attributes, also use the pageID. For layer attributes, also use the pageID and layerID.
To set user attributes:
· Use the SetUserAttribute(docwinID, <pageID>, <layerID>, "attributeName", "value") transaction.
When setting your own user attributes, decide what object it makes the most sense to attach the attribute to--the entire product (global attribute), or to a specific document, page, or layer. The number of user attributes that are attached to an object or to the product is not limited.
To delete user attributes:
· Use the DeleteUserAttribute transaction.
Normally you would only delete a user attribute that you had created earlier but no longer applies. It does not make a lot of sense to delete predefined user attributes.
For a list and description of predefined user attributes, click Predefined user attributes.
See also