Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- JavaScript object: XML
- JavaScript method: XML.addAttribute()
- JavaScript method: XML.addElement()
- JavaScript method: XML.appendNode()
- JavaScript method: XML.createNode()
- JavaScript method: XML.getAttributeNode()
- JavaScript method: XML.getAttributeValue()
- JavaScript method: XML.getDocumentElement()
- JavaScript method: XML.getFirstAttribute()
- JavaScript method: XML.getFirstChildElement()
- JavaScript method: XML.getName()
- JavaScript method: XML.getNextAttribute()
- JavaScript method: XML.getNextSiblingElement()
- JavaScript method: XML.getNodeName()
- JavaScript method: XML.getNodeType()
- JavaScript method: XML.getNodeValue()
- JavaScript method: XML.getParentNode()
- JavaScript method: XML.getPrefix()
- JavaScript method: XML.getQualifiedName()
- JavaScript method: XML.getText()
- JavaScript method: XML.getValue()
- JavaScript method: XML.importNode()
- JavaScript method: XML.isDocumentElement()
- JavaScript method: XML.removeAttribute()
- JavaScript method: XML.setAttributeValue()
- JavaScript method: XML.setContent()
- JavaScript method: XML.setNodeValue()
- JavaScript method: XML.setText()
- JavaScript method: XML.setValue()
- JavaScript method: XML.toXMLString()
- JavaScript method: XMLDoc.insertBefore()
JavaScript method: XML.setAttributeValue()
This method adds or updates the attribute value of the target attribute. You must use the other XML get methods to navigate through an XML document.
Syntax
XML.setAttributeValue( AttributeName, AttributeValue );
Arguments
The following arguments are valid for this method:
Argument | Data type | Description |
---|---|---|
AttributeName
|
String | This argument specifies the XML attribute whose value you want the script to add or update. |
AttributeValue | String | This argument specifies the text string you want the script to use as the XML attribute value. This argument must contain characters valid for an XML element (for example, the string cannot include the characters < or >). |
Return values
This method does not return any values.
Example
This example adds or updates the attribute value of any given element in an XML document.
This example requires the following sample data:
- A local XML file (for example, C:\test.xml which contains
<document><parent1><child1 attribute1="a" /><child2 /></parent1><parent2><child3 /><child4 /></parent2></document>
)
/* Create variables to store XML objects and strings. * Use XMLFile to store a valid XML file. * The script assigns values to the empty variables later on */ var XMLFile = new XML(); XMLFile = XMLFile.setContent( "C:\\test.xml", true ); var XMLSource; var TargetNode; var TargetAttribute; var TargetValue; var searchResults; /* Create a function that searches an XML object (node) for a particular * element (targetElem) and returns an XML object containing the element. * This function assumes that there is only one instance of the target * element in the source data. If it finds more than one element in the * data it only returns the first instance of the element. */ function findTargetElement( node, targetElem ) { var topNodeName = node.getNodeName(); while (node != null && node.getNodeName() != targetElem ) { var childNode = node.getFirstChildElement(); if (childNode == null) { childNode = node.getNextSiblingElement(); while (childNode == null) { node = node.getParentNode(); if ( node == null || topNodeName == node.getNodeName() ) { return null; } childNode = node.getNextSiblingElement(); } node = childNode; } else { node = childNode; } } return node; } /* Create a function to print the target element and search results */ function printFindResults( target, searchResult, attributeName, attributeValue ) { print( "The target element we are looking for is: " + target ); if ( searchResult != null ) { var elementName = searchResult.getNodeName(); print( "Found element " + elementName + " in: \n" + searchResult + "\n" ); var attributeSet = setAttributeValue( searchResult, attributeName, attributeValue ); print( "The XML object is " + searchResult ); return attributeSet } else { print( "Cannot find " + target ); return null } } /* Create a function to set the attribute value of the target attribute */ function setAttributeValue( sourceObject, attributeName, attributeValue ) { print( "Setting attribute value of " + attributeName ); var setAttributeValue = sourceObject.setAttributeValue( attributeName, attributeValue ); var newAttributeValue = sourceObject.getAttributeValue( attributeName ); print( "The value of " + attributeName + " is now " + newAttributeValue ); return newAttributeValue } /* Set variable values for XMLFile and TargetNode. Run functions */ print( "Processing XML from XMLFile... \n" ); TargetNode = "child1"; XMLSource = XMLFile; TargetAttribute = "attribute1"; TargetValue = "z"; searchResults = findTargetElement( XMLSource, TargetNode ); printFindResults( TargetNode, searchResults, TargetAttribute, TargetValue ); print( "Processing XML from XMLFile... \n" ); TargetNode = "child2"; XMLSource = XMLFile; TargetAttribute = "attribute1"; TargetValue = "z"; searchResults = findTargetElement( XMLSource, TargetNode ); printFindResults( TargetNode, searchResults, TargetAttribute, TargetValue );