SPEncode Class
Provides methods for encoding strings.
Inheritance Hierarchy
System.Object
Microsoft.SharePoint.Utilities.SPEncode
Namespace: Microsoft.SharePoint.Utilities
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online
Syntax
'Declaration
<SubsetCallableTypeAttribute> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class SPEncode
'Usage
Dim instance As SPEncode
[SubsetCallableTypeAttribute]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class SPEncode
Remarks
Use the methods in the SPEncode class as a security precaution to help prevent malicious script blocks from being able to execute in applications that execute across sites.
You do not need to instantiate the SPEncode class to use them because all its methods are static.
In code that calls members within the Microsoft.SharePoint assembly, the encoding methods of the SPEncode class are more effective than methods of the [System.Web.HttpUtility] and [System.Web.HttpServerUtility] classes. The methods in the SPEncode class for encoding URLs and HTML can be used to encode a larger set of characters than the methods in the [System.Web.HttpUtility] and [System.Web.HttpServerUtility] classes.
Examples
The following example converts the specified string to "Please respond by <B>Friday</B>" so that the browser displays Please respond by <B>Friday</B>.
Dim myString As String = "Please respond by <B>Friday</B>."
SPEncode.WriteHtmlEncode(myString)
string myString = "Please respond by <B>Friday</B>.";
SPEncode.WriteHtmlEncode(myString);
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.