Provides methods for encoding strings.
Namespace: Microsoft.SharePoint.Utilities
Assembly: Microsoft.SharePoint (in microsoft.sharepoint.dll)
Syntax
Visual Basic (Declaration)
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel:=True)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level:=AspNetHostingPermissionLevel.Minimal)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel:=True)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class SPEncode
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel=true)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level=AspNetHostingPermissionLevel.Minimal)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel=true)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, 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.
Example
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);
Inheritance Hierarchy
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.
See Also