Skip to main content
.NET Framework Class Library
XsltArgumentList..::.AddParam Method

Adds a parameter to the XsltArgumentList and associates it with the namespace qualified name.

Namespace: System.Xml.Xsl
Assembly: System.Xml (in System.Xml.dll)
Syntax
Public Sub AddParam ( _
	name As String, _
	namespaceUri As String, _
	parameter As Object _
)
public void AddParam(
	string name,
	string namespaceUri,
	Object parameter
)
public:
void AddParam(
	String^ name, 
	String^ namespaceUri, 
	Object^ parameter
)
member AddParam : 
        name:string * 
        namespaceUri:string * 
        parameter:Object -> unit 

Parameters

name
Type: System..::.String
The name to associate with the parameter.
namespaceUri
Type: System..::.String
The namespace URI to associate with the parameter. To use the default namespace, specify an empty string.
parameter
Type: System..::.Object
The parameter value or object to add to the list.
Exceptions
ExceptionCondition
ArgumentException

The namespaceUri is either nullNothingnullptra null reference (Nothing in Visual Basic) or http://www.w3.org/1999/XSL/Transform.

The name is not a valid name according to the W3C XML specification.

The namespaceUri already has a parameter associated with it.

Remarks

The parameter should correspond to a W3C type. The following table shows the W3C types, either XPath or XSLT, and the corresponding.NET class.

W3C Type

Equivalent.NET Class (Type)

String (XPath)

String

Boolean (XPath)

Boolean

Number (XPath)

Double

Result Tree Fragment (XSLT)

XPathNavigator

Node Set (XPath)

XPathNodeIterator

XPathNavigator[]

Node* (XPath)

XPathNavigator

*This is equivalent to a node set that contains a single node.

If the parameter object being invoked from within the style sheet is not one of the above, it is converted according to the following rules:

All other types throw an error.

Examples

The following example uses the AddParam method to create a parameter representing the current date and time.


Imports System
Imports System.IO
Imports System.Xml
Imports System.Xml.Xsl

Public Class Sample

    Public Shared Sub Main()

        ' Create the XslCompiledTransform and load the stylesheet.
        Dim xslt As New XslCompiledTransform()
        xslt.Load("order.xsl")

        ' Create the XsltArgumentList.
        Dim xslArg As New XsltArgumentList()

        ' Create a parameter which represents the current date and time.
        Dim d As DateTime = DateTime.Now
        xslArg.AddParam("date", "", d.ToString())

        Using w As XmlWriter = XmlWriter.Create("output.xml")
            ' Transform the file.
            xslt.Transform("order.xml", xslArg, w)
        End Using

    End Sub 'Main 
End Class 'Sample


using System;
using System.IO;
using System.Xml;
using System.Xml.Xsl;

public class Sample
{

    public static void Main()
    {

        // Create the XslCompiledTransform and load the stylesheet.
        XslCompiledTransform xslt = new XslCompiledTransform();
        xslt.Load("order.xsl");

        // Create the XsltArgumentList.
        XsltArgumentList xslArg = new XsltArgumentList();

        // Create a parameter which represents the current date and time.
        DateTime d = DateTime.Now;
        xslArg.AddParam("date", "", d.ToString());

        // Transform the file.
        using (XmlWriter w = XmlWriter.Create("output.xml"))
        {
            xslt.Transform("order.xml", xslArg, w);
        }
    }
}

The example uses the following two data files as input.

order.xml


<!--Represents a customer order-->
<order>
  <book ISBN='10-861003-324'>
    <title>The Handmaid's Tale</title>
    <price>19.95</price>
  </book>
  <cd ISBN='2-3631-4'>
    <title>Americana</title>
    <price>16.95</price>
  </cd>
</order>

order.xsl


<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:param name="date"/>
  <xsl:template match="/">
    <order>
      <date><xsl:value-of select="$date"/></date>
      <total><xsl:value-of select="sum(//price)"/></total>
    </order>
  </xsl:template>
</xsl:stylesheet>

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.