SPHttpUtility.UrlKeyValueEncode Method (String, String)

Encodes a string key and value for use in a URL query string.

Namespace:  Microsoft.SharePoint.Utilities
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
Public Shared Function UrlKeyValueEncode ( _
    keyToEncode As String, _
    valueToEncode As String _
) As String
'Usage
Dim keyToEncode As String
Dim valueToEncode As String
Dim returnValue As String

returnValue = SPHttpUtility.UrlKeyValueEncode(keyToEncode, _
    valueToEncode)

public static string UrlKeyValueEncode(
    string keyToEncode,
    string valueToEncode
)

Parameters

• keyToEncode
  Type: System.String

  The key string to be encoded.

• valueToEncode
  Type: System.String

  The value string to encode.

Return Value

Type: System.String
The encoded string.

Remarks

Use the UrlKeyValueEncode method to encode a URL that you are constructing instead of passing an existing URL, for example, a URL that was entered by the user.

To encode the specified string for use as an attribute value for URL type attributes, use the HtmlUrlAttributeEncode method.

To encode an HTML string, use the HTMLEncode property.

See Also

Reference

SPHttpUtility Class

SPHttpUtility Members

UrlKeyValueEncode Overload

Microsoft.SharePoint.Utilities Namespace