System.Xml.Xsl.IXsltContextFunction Interface

Assembly: System.Xml.dll
Namespace: System.Xml.Xsl
Summary
Provides an interface to a given function defined in the XSLT stylesheet during runtime execution.
C# Syntax:
public interface IXsltContextFunction
See also:
System.Xml.Xsl Namespace

System.Xml.Xsl.IXsltContextFunction Member List:

Public Properties
ArgTypes Read-only

Gets the supplied XPath types for the function's argument list. This information can be used to discover the signature of the function which allows you to differentiate between overloaded functions.
Maxargs Read-only

Gets the maximum number of arguments for the function. This enables the user to differentiate between overloaded functions.
Minargs Read-only

Gets the minimum number of arguments for the function. This enables the user to differentiate between overloaded functions.
ReturnType Read-only

Gets the XPathResultType representing the XPath type returned by the function.
Public Methods
Invoke Provides the method to invoke the function with the given arguments in the given context.

System.Xml.Xsl.IXsltContextFunction Member Details

Property: ArgTypes (read-only)
Summary
Gets the supplied XPath types for the function's argument list. This information can be used to discover the signature of the function which allows you to differentiate between overloaded functions.
C# Syntax:
XPathResultType[] ArgTypes {get;}

Return to top


Property: Maxargs (read-only)
Summary
Gets the maximum number of arguments for the function. This enables the user to differentiate between overloaded functions.
C# Syntax:
int Maxargs {get;}

Return to top


Property: Minargs (read-only)
Summary
Gets the minimum number of arguments for the function. This enables the user to differentiate between overloaded functions.
C# Syntax:
int Minargs {get;}

Return to top


Property: ReturnType (read-only)
Summary
Gets the XPathResultType representing the XPath type returned by the function.
C# Syntax:
XPathResultType ReturnType {get;}

Return to top


Method: Invoke(
   XsltContext xsltContext,
   object[] args,
   XPathNavigator docContext
)
Summary
Provides the method to invoke the function with the given arguments in the given context.
C# Syntax:
object Invoke(
   XsltContext xsltContext,
   object[] args,
   XPathNavigator docContext
);
Parameters:

xsltContext

The XSLT context for the function call.

args

The arguments of the function call. Each argument is an element in the array.

docContext

The context node for the function call.

Return Value:
An Object representing the return value of the function.
Remarks
The docContext parameter is required so that functions which require a node set can be supplied the current context node.

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.