"XsltArgumentList" für Stylesheetparameter und Erweiterungsobjekte

Artikel
04/27/2011

Die XsltArgumentList enthält XSLT-Parameter (Extensible Stylesheet Transformation) und XSLT-Erweiterungsobjekte. Bei der Übergabe an die Transform-Methode können diese Parameter und Erweiterungsobjekte von Stylesheets aus ausgerufen werden.

Hinweis
Die XslTransform-Klasse und die XsltArgumentList-Klasse sind in .NET Framework, Version 2.0 veraltet.Sie können XSLT-Transformationen mit der XslCompiledTransform-Klasse durchführen.Weitere Informationen finden Sie unter Verwenden der XslCompiledTransform-Klasse und Migrieren von der XslTransform-Klasse.

Die XsltArgumentList-Klasse enthält XSLT-Parameter und XSLT-Erweiterungsobjekte. Bei der Übergabe an die Transform-Methode können diese Parameter und Erweiterungsobjekte von Stylesheets aus ausgerufen werden.

Die Übergabe eines Objekts bietet gegenüber der Verwendung eines eingebetteten Skripts folgende Vorteile:

Sie ermöglicht eine bessere Kapselung und Wiederverwendung von Klassen.
Stylesheets werden kleiner und sind besser verwaltbar.
Das Aufrufen von Methoden für Klassen, die zu anderen Namespaces gehören als zu denen, die im Rahmen der unterstützten System-Namespaces definiert sind, wird unterstützt.
Bei Verwendung von XPathNodeIterator wird die Übergabe von Ergebnisstrukturfragmenten an das Stylesheet unterstützt.

XSLT-Stylesheetparameter

XSLT-Parameter werden der XsltArgumentList mithilfe der AddParam-Methode hinzugefügt. Dabei wird ein qualifizierter Name und ein Namespace-URI (Uniform Resource Identifier) mit dem Parameterobjekt verknüpft.

Das Parameterobjekt muss einem W3C-Typ entsprechen. In der folgenden Tabelle sind die jeweiligen W3C-Typen mit den entsprechenden .NET Framework-Klassen (Typ) aufgelistet und es ist angegeben, ob es sich bei dem W3C-Typ um einen XPath-Typ (XML Path Language) oder einen XSLT-Typ handelt.

W3C-Typ	Entsprechende .NET Framework-Klasse (Typ)	XPath-Typ oder XSLT-Typ
String	System.String	XPath
Boolean	System.Boolean	XPath
Number	System.Double	XPath
Ergebnisstrukturfragment	System.Xml.XPath.XPathNavigator	XSLT
Knotengruppe	System.Xml.XPath.XPathNodeIterator	XPath

Wenn es sich bei dem Parameterobjekt um keine der obigen Klassen handelt, wird je nach Bedarf entweder ein "Double" oder ein "String" erzwungen. Für die Typen Int16, UInt16, Int32, UInt32, Int64, UInt64, Single und Decimal wird ein Double erzwungen. Für alle anderen Typen wird mit der ToString-Methode ein string erzwungen.

So verwenden Sie den XSLT-Parameter:

Erstellen Sie eine XsltArgumentList und fügen Sie die Objekte mit AddParam hinzu.
Rufen Sie die Parameter aus dem Stylesheet auf.
Übergeben Sie die XsltArgumentList an die Transform-Methode.

Beispiel

Im folgenden Beispiel wird mit der AddParam-Methode ein Parameter erstellt, der das berechnete Skontodatum enthält. Das Skontodatum ist 20 Tage nach dem Auftragsdatum.

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

Public class Sample

   Private Const filename As String = "order.xml"
   Private Const stylesheet As String = "discount.xsl"

   Public Shared Sub Main()

    'Create the XslTransform and load the style sheet.
    Dim xslt As XslTransform = New XslTransform
    xslt.Load(stylesheet)

    'Load the XML data file.
    Dim doc As XPathDocument = New XPathDocument(filename)

    'Create an XsltArgumentList.
    Dim xslArg As XsltArgumentList = New XsltArgumentList
         
    'Calculate the discount date.
    Dim today As DateTime = DateTime.Now
    Dim d As DateTime = today.AddDays(20)
    xslArg.AddParam("discount", "", d.ToString())

    'Create an XmlTextWriter to handle the output.
    Dim writer As XmlTextWriter = New XmlTextWriter("orderout.xml", Nothing)

    'Transform the file.
    xslt.Transform(doc, xslArg, writer, Nothing)

    writer.Close()

  End Sub
End Class

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

public class Sample
{
   private const String filename = "order.xml";
   private const String stylesheet = "discount.xsl";

   public static void Main() {

    //Create the XslTransform and load the style sheet.
    XslTransform xslt = new XslTransform();
    xslt.Load(stylesheet);

    //Load the XML data file.
    XPathDocument doc = new XPathDocument(filename);

    //Create an XsltArgumentList.
    XsltArgumentList xslArg = new XsltArgumentList();
         
    //Calculate the discount date.
    DateTime today = DateTime.Now;
    DateTime d = today.AddDays(20);
    xslArg.AddParam("discount", "", d.ToString());

    //Create an XmlTextWriter to handle the output.
    XmlTextWriter writer = new XmlTextWriter("orderout.xml", null);

    //Transform the file.
    xslt.Transform(doc, xslArg, writer, null);
    writer.Close();
  }
}

Eingabe

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>

discount.xsl

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:param name="discount"/>
  <xsl:template match="/">
    <order>
      <xsl:variable name="sub-total" select="sum(//price)"/>
      <total><xsl:value-of select="$sub-total"/></total>
      15% discount if paid by: <xsl:value-of select="$discount"/>
    </order>
  </xsl:template>
</xsl:stylesheet>

Ausgabe

<order>
   <total>36.9</total> 
   15% discount if paid by: 5/6/2001 5:01:15 PM 
</order>

XSLT-Erweiterungsobjekte

XSLT-Erweiterungsobjekte werden der XsltArgumentList mithilfe der AddExtensionObject-Methode hinzugefügt. Dabei wird ein qualifizierter Name und ein Namespace-URI (Uniform Resource Identifier) mit dem Parameterobjekt verknüpft.

Wenn ein Objekt hinzugefügt wird, muss der Aufrufer von AddExtensionObject in den Sicherheitsrichtlinien mit vollständiger Vertrauenswürdigkeit eingestuft sein. Wenn der Aufrufer nur teilweise vertrauenswürdig ist, schlägt das Hinzufügen fehl.

Das erfolgreiche Hinzufügen eines Objekts garantiert jedoch nicht zwangsläufig eine erfolgreiche Ausführung. Wenn die Transform-Methode aufgerufen wird, werden die Berechtigungen mit den zur Load-Zeit bereitgestellten Beweisen berechnet, und dem gesamten Transformationsprozess wird dieser Berechtigungssatz zugewiesen. Bei dem Versuch, durch ein Erweiterungsobjekt eine Aktion zu initiieren, die eine nicht im Berechtigungssatz enthaltene Berechtigung erfordert, wird eine Ausnahme ausgelöst.

Von Erweiterungsobjekten kann einer der vier XPath-Grunddatentypen (node-set, Boolean, number oder string) zurückgegeben werden.

So verwenden Sie das XSLT-Erweiterungsobjekt:

Erstellen Sie eine XsltArgumentList, und fügen Sie das Erweiterungsobjekt mit AddExtensionObject hinzu.
Rufen Sie das Erweiterungsobjekt aus dem Stylesheet auf.
Übergeben Sie die XsltArgumentList an die Transform-Methode.

Beispiel

Im folgenden Beispiel wird der Umfang eines Kreises bei gegebenem Radius berechnet.

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

Public Class Sample
   Private Const filename As String = "number.xml"
   Private Const stylesheet As String = "circle.xsl"

   Public Shared Sub Main()
        Dim test As Sample = New Sample
   End Sub
    
  Public Sub New()
    'Create the XslTransform and load the style sheet.
    Dim xslt As XslTransform = New XslTransform
    xslt.Load(stylesheet)

    'Load the XML data file.
    Dim doc As XPathDocument = New XPathDocument(filename)

    'Create an XsltArgumentList.
    Dim xslArg As XsltArgumentList = New XsltArgumentList
         
    'Add an object to calculate the circumference of the circle.
    Dim obj As Calculate = New Calculate
    xslArg.AddExtensionObject("urn:myObj", obj)

    'Create an XmlTextWriter to output to the console.
    Dim writer As XmlTextWriter = New XmlTextWriter(Console.Out)

    'Transform the file.
    xslt.Transform(doc, xslArg, writer, Nothing)
    writer.Close()

  End Sub

  'Calculates the circumference of a circle given the radius.
  Public Class Calculate

    Private circ As double = 0
      
    Public Function Circumference(radius As Double) As Double
       circ = Math.PI*2*radius
       Return circ
    End Function
  End Class
End Class

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


public class Sample
{
   private const String filename = "number.xml";
   private const String stylesheet = "circle.xsl";

   public static void Main() {

        Sample test = new Sample();
    }
    
  public Sample() {

    //Create the XslTransform and load the style sheet.
    XslTransform xslt = new XslTransform();
    xslt.Load(stylesheet);

    //Load the XML data file.
    XPathDocument doc = new XPathDocument(filename);

    //Create an XsltArgumentList.
    XsltArgumentList xslArg = new XsltArgumentList();
         
    //Add an object to calculate the circumference of the circle.
    Calculate obj = new Calculate();
    xslArg.AddExtensionObject("urn:myObj", obj);

    //Create an XmlTextWriter to output to the console.
    XmlTextWriter writer = new XmlTextWriter(Console.Out);

    //Transform the file.
    xslt.Transform(doc, xslArg, writer, null);
    writer.Close();

  }

  //Calculates the circumference of a circle given the radius.
  public class Calculate{

    private double circ = 0;
      
    public double Circumference(double radius){
       circ = Math.PI*2*radius;
       return circ;
    }
  }
}

Eingabe

number.xml

<?xml version='1.0'?>
<data>
  <circle>
    <radius>12</radius>
  </circle>
  <circle>
    <radius>37.5</radius>
  </circle>
</data>

circle.xsl

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
    xmlns:myObj="urn:myObj">

  <xsl:template match="data">
  <circles>
  <xsl:for-each select="circle">
    <circle>
    <xsl:copy-of select="node()"/>
       <circumference>
          <xsl:value-of select="myObj:Circumference(radius)"/>        
       </circumference>
    </circle>
  </xsl:for-each>
  </circles>
  </xsl:template>
</xsl:stylesheet>

Ausgabe

</circle>

</circle>

</circles>

Siehe auch

Konzepte

Implementierung des XSLT-Prozessors durch die XslTransform-Klasse

Freigeben über

"XsltArgumentList" für Stylesheetparameter und Erweiterungsobjekte

XSLT-Stylesheetparameter

So verwenden Sie den XSLT-Parameter:

Beispiel

Eingabe

Ausgabe

XSLT-Erweiterungsobjekte

So verwenden Sie das XSLT-Erweiterungsobjekt:

Beispiel

Eingabe

Ausgabe

Siehe auch

Konzepte

Zusätzliche Ressourcen