This documentation is archived and is not being maintained.

XsltSettings Class

Specifies the XSLT features to support during execution of the XSLT style sheet.


Namespace:  System.Xml.Xsl
Assembly:  System.Xml (in System.Xml.dll)

public sealed class XsltSettings

The XsltSettings type exposes the following members.

Public methodXsltSettings()Initializes a new instance of the XsltSettings class with default settings.
Public methodXsltSettings(Boolean, Boolean)Initializes a new instance of the XsltSettings class with the specified settings.

Public propertyStatic memberDefaultGets an XsltSettings object with default settings. Support for the XSLT document() function and embedded script blocks is disabled.
Public propertyEnableDocumentFunctionGets or sets a value indicating whether to enable support for the XSLT document() function.
Public propertyEnableScriptGets or sets a value indicating whether to enable support for embedded script blocks.
Public propertyStatic memberTrustedXsltGets an XsltSettings object that enables support for the XSLT document() function and embedded script blocks.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Embedded script blocks and the XSLT document() function are optional features on the XslCompiledTransform class. These features are disabled by default. The XsltSettings class specifies which of these optional features to support. Features are enabled or disabled using the class properties. The XsltSettings object is then passed to the XslCompiledTransform.Load method.

Security noteSecurity Note

XSLT style sheets can include references to other files and embedded script blocks. A malicious user can exploit this by supplying you with data or style sheets that when executed can cause your system to process until the computer runs low on resources. Do not enable scripting or the document() function unless the style sheet comes from a trusted source. If you cannot verify the source of the style sheet, or if the style sheet does not come from a trusted source, use the default XSLT settings.

The following example loads a style sheet and enables XSLT script support.

// Create the XsltSettings object with script enabled.
XsltSettings settings = new XsltSettings(false,true);

// Create the XslCompiledTransform object and load the style sheet.
XslCompiledTransform xslt = new XslCompiledTransform();
xslt.Load("sort.xsl", settings, new XmlUrlResolver());

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.