Community articleSetAttribute function
Added by IBM contributorIBM on May 2, 2012
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.


This function sets the value of a specific attribute for a node. For example, the following XFDL represents a value node:
   <value custom:myAtt="x"></value>

To change the custom attribute, you would use setAttribute. If the attribute does not already exist, setAttribute will create it and assign the appropriate value.
Note: Do not use SetAttribute to set the compute attribute. Instead, use


   Sub SetAttribute(
      theNamespaceURI As String, 
      theName As String, 
      theValue As String)


Table 1. Function parameters
theNamespaceURIStringThe namespace URI for the attribute. For example:

theAttributeStringThe local name of the attribute. For example, encoding.
theValueStringThe value to assign to the attribute.


Nothing or throws an exception if an error occurs.

Usage details

Attributes and the null namespace:
If an attribute is on a node in a non-XFDL namespace, and that attribute has no namespace prefix, then the attribute is in the null namespace. For example, the following node is the custom namespace, as is the first attribute, but since the second attribute does not have a namespace prefix, it is in the null namespace:
   <custom:processing custom:stage="2" user="tjones">

When an attribute is the null namespace, you may either provide a null value for the namespace URI or use the namespace URI for the containing element.
For example, to indicate user attribute on the processing node, you could use the null namespace or the custom namespace URI.
Attributes and namespace prefixes:
If you refer to an attribute with a namespace prefix, SetAttribute first looks for a complete match, including both prefix and attribute name. If it does not find a match, it will look for a matching attribute name that has no prefix but whose containing element has the same namespace.
For example, assume that the custom namespace and the test namespace both resolve to the same URI. In the following case, looking for the id attribute would locate the second attribute (test:id), since it has an explicit namespace declaration:
   <a xmlns:custom="ABC" xmlns:test="ABC">
      <custom:myElement id="1" test:id="2">

However, in the next case, the id attribute does not have an explicit namespace declaration. Instead, it inherits the custom namespace. However, since the inherited namespace resolves to the same URI, the id attribute is still located:
   <custom:myElement id="1">


The following function uses DereferenceEx to locate a custom node in the form. It then uses RemoveAttribute to delete the "stage" attribute from the node, and calls SetAttribute to update the value of the status attribute to "completed".
   Sub CompletedProcessing(Form)
      Dim TempNode  ' object
      Set TempNode = Form
      ' Dereference the custom processing node in the global item.
      Set TempNode = TempNode.DereferenceEx(vbNullString, _
         "", 0, UFL_OPTION_REFERENCE, _
      ' Remove the "stage" attribute from the node.
      TempNode.RemoveAttribute vbNullString, "stage"
      ' Update the status attribute to "completed".
      TempNode.SetAttribute vbNullString, "status", "completed"
   End Sub

Parent topic:
FormNodeP functions