1 <?xml version="1.0" encoding="utf-8"?><doc>
3 <name>System.Web.HttpUtility</name>
6 <member name="T:System.Web.HttpUtility">
7 <summary>Provides methods for encoding and decoding URLs when processing Web requests. This class cannot be inherited.</summary>
9 <member name="M:System.Web.HttpUtility.#ctor">
10 <summary>Initializes a new instance of the <see cref="T:System.Web.HttpUtility"></see> class.</summary>
12 <member name="M:System.Web.HttpUtility.HtmlAttributeEncode(System.String)">
13 <summary>Minimally converts a string to an HTML-encoded string.</summary>
14 <param name="s">The string to encode.</param>
15 <returns>An encoded string.</returns>
17 <member name="M:System.Web.HttpUtility.HtmlAttributeEncode(System.String,System.IO.TextWriter)">
18 <summary>Minimally converts a string into an HTML-encoded string and sends the encoded string to a <see cref="T:System.IO.TextWriter"></see> output stream.</summary>
19 <param name="s">The string to encode</param>
20 <param name="output">A <see cref="T:System.IO.TextWriter"></see> output stream.</param>
22 <member name="M:System.Web.HttpUtility.HtmlDecode(System.String)">
23 <summary>Converts a string that has been HTML-encoded for HTTP transmission into a decoded string.</summary>
24 <param name="s">The string to decode.</param>
25 <returns>A decoded string.</returns>
27 <member name="M:System.Web.HttpUtility.HtmlDecode(System.String,System.IO.TextWriter)">
28 <summary>Converts a string that has been HTML-encoded into a decoded string, and sends the decoded string to a <see cref="T:System.IO.TextWriter"></see> output stream.</summary>
29 <param name="s">The string to decode.</param>
30 <param name="output">A <see cref="T:System.IO.TextWriter"></see> stream of output.</param>
32 <member name="M:System.Web.HttpUtility.HtmlEncode(System.Object)">
33 <summary>Converts an object&#39;s string representation into an HTML-encoded string, and returns the encoded string.</summary>
34 <param name="value">An object.</param>
35 <returns>An encoded string.</returns>
37 <member name="M:System.Web.HttpUtility.HtmlEncode(System.String)">
38 <summary>Converts a string to an HTML-encoded string.</summary>
39 <param name="s">The string to encode.</param>
40 <returns>An encoded string.</returns>
42 <member name="M:System.Web.HttpUtility.HtmlEncode(System.String,System.IO.TextWriter)">
43 <summary>Converts a string into an HTML-encoded string, and returns the output as a <see cref="T:System.IO.TextWriter"></see> stream of output.</summary>
44 <param name="s">The string to encode</param>
45 <param name="output">A <see cref="T:System.IO.TextWriter"></see> output stream.</param>
47 <member name="M:System.Web.HttpUtility.JavaScriptStringEncode(System.String)">
48 <summary>Encodes a string.</summary>
49 <param name="value">A string to encode.</param>
50 <returns>An encoded string.</returns>
52 <member name="M:System.Web.HttpUtility.JavaScriptStringEncode(System.String,System.Boolean)">
53 <summary>Encodes a string.</summary>
54 <param name="value">A string to encode.</param>
55 <param name="addDoubleQuotes">A value that indicates whether double quotation marks will be included around the encoded string.</param>
56 <returns>An encoded string.</returns>
58 <member name="M:System.Web.HttpUtility.ParseQueryString(System.String)">
59 <summary>Parses a query string into a <see cref="T:System.Collections.Specialized.NameValueCollection"></see> using <see cref="P:System.Text.Encoding.UTF8"></see> encoding.</summary>
60 <param name="query">The query string to parse.</param>
61 <returns>A <see cref="T:System.Collections.Specialized.NameValueCollection"></see> of query parameters and values.</returns>
62 <exception cref="T:System.ArgumentNullException"><paramref name="query">query</paramref> is <see langword="null"></see>.</exception>
64 <member name="M:System.Web.HttpUtility.ParseQueryString(System.String,System.Text.Encoding)">
65 <summary>Parses a query string into a <see cref="T:System.Collections.Specialized.NameValueCollection"></see> using the specified <see cref="T:System.Text.Encoding"></see>.</summary>
66 <param name="query">The query string to parse.</param>
67 <param name="encoding">The <see cref="T:System.Text.Encoding"></see> to use.</param>
68 <returns>A <see cref="T:System.Collections.Specialized.NameValueCollection"></see> of query parameters and values.</returns>
69 <exception cref="T:System.ArgumentNullException"><paramref name="query">query</paramref> is <see langword="null"></see>.
71 <paramref name="encoding">encoding</paramref> is <see langword="null"></see>.</exception>
73 <member name="M:System.Web.HttpUtility.UrlDecode(System.String,System.Text.Encoding)">
74 <summary>Converts a URL-encoded string into a decoded string, using the specified encoding object.</summary>
75 <param name="str"></param>
76 <param name="e">The <see cref="T:System.Text.Encoding"></see> that specifies the decoding scheme.</param>
77 <returns>A decoded string.</returns>
79 <member name="M:System.Web.HttpUtility.UrlDecode(System.Byte[],System.Int32,System.Int32,System.Text.Encoding)">
80 <summary>Converts a URL-encoded byte array into a decoded string using the specified encoding object, starting at the specified position in the array, and continuing for the specified number of bytes.</summary>
81 <param name="bytes">The array of bytes to decode.</param>
82 <param name="offset">The position in the byte to begin decoding.</param>
83 <param name="count">The number of bytes to decode.</param>
84 <param name="e">The <see cref="T:System.Text.Encoding"></see> object that specifies the decoding scheme.</param>
85 <returns>A decoded string.</returns>
86 <exception cref="T:System.ArgumentNullException"><paramref name="bytes">bytes</paramref> is <see langword="null"></see>, but <paramref name="count">count</paramref> does not equal <see langword="0"></see>.</exception>
87 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than <see langword="0"></see> or greater than the length of the <paramref name="bytes">bytes</paramref> array.
89 <paramref name="count">count</paramref> is less than <see langword="0"></see>, or <paramref name="count">count</paramref> + <paramref name="offset">offset</paramref> is greater than the length of the <paramref name="bytes">bytes</paramref> array.</exception>
91 <member name="M:System.Web.HttpUtility.UrlDecode(System.String)">
92 <summary>Converts a string that has been encoded for transmission in a URL into a decoded string.</summary>
93 <param name="str">The string to decode.</param>
94 <returns>A decoded string.</returns>
96 <member name="M:System.Web.HttpUtility.UrlDecode(System.Byte[],System.Text.Encoding)">
97 <summary>Converts a URL-encoded byte array into a decoded string using the specified decoding object.</summary>
98 <param name="bytes">The array of bytes to decode.</param>
99 <param name="e">The <see cref="T:System.Text.Encoding"></see> that specifies the decoding scheme.</param>
100 <returns>A decoded string.</returns>
102 <member name="M:System.Web.HttpUtility.UrlDecodeToBytes(System.Byte[])">
103 <summary>Converts a URL-encoded array of bytes into a decoded array of bytes.</summary>
104 <param name="bytes">The array of bytes to decode.</param>
105 <returns>A decoded array of bytes.</returns>
107 <member name="M:System.Web.HttpUtility.UrlDecodeToBytes(System.String)">
108 <summary>Converts a URL-encoded string into a decoded array of bytes.</summary>
109 <param name="str">The string to decode.</param>
110 <returns>A decoded array of bytes.</returns>
112 <member name="M:System.Web.HttpUtility.UrlDecodeToBytes(System.String,System.Text.Encoding)">
113 <summary>Converts a URL-encoded string into a decoded array of bytes using the specified decoding object.</summary>
114 <param name="str">The string to decode.</param>
115 <param name="e">The <see cref="T:System.Text.Encoding"></see> object that specifies the decoding scheme.</param>
116 <returns>A decoded array of bytes.</returns>
118 <member name="M:System.Web.HttpUtility.UrlDecodeToBytes(System.Byte[],System.Int32,System.Int32)">
119 <summary>Converts a URL-encoded array of bytes into a decoded array of bytes, starting at the specified position in the array and continuing for the specified number of bytes.</summary>
120 <param name="bytes">The array of bytes to decode.</param>
121 <param name="offset">The position in the byte array at which to begin decoding.</param>
122 <param name="count">The number of bytes to decode.</param>
123 <returns>A decoded array of bytes.</returns>
124 <exception cref="T:System.ArgumentNullException"><paramref name="bytes">bytes</paramref> is <see langword="null"></see>, but <paramref name="count">count</paramref> does not equal <see langword="0"></see>.</exception>
125 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than <see langword="0"></see> or greater than the length of the <paramref name="bytes">bytes</paramref> array.
127 <paramref name="count">count</paramref> is less than <see langword="0"></see>, or <paramref name="count">count</paramref> + <paramref name="offset">offset</paramref> is greater than the length of the <paramref name="bytes">bytes</paramref> array.</exception>
129 <member name="M:System.Web.HttpUtility.UrlEncode(System.String,System.Text.Encoding)">
130 <summary>Encodes a URL string using the specified encoding object.</summary>
131 <param name="str"></param>
132 <param name="e"></param>
133 <returns>An encoded string.</returns>
135 <member name="M:System.Web.HttpUtility.UrlEncode(System.Byte[],System.Int32,System.Int32)">
136 <summary>Converts a byte array into a URL-encoded string, starting at the specified position in the array and continuing for the specified number of bytes.</summary>
137 <param name="bytes">The array of bytes to encode.</param>
138 <param name="offset">The position in the byte array at which to begin encoding.</param>
139 <param name="count">The number of bytes to encode.</param>
140 <returns>An encoded string.</returns>
142 <member name="M:System.Web.HttpUtility.UrlEncode(System.Byte[])">
143 <summary>Converts a byte array into an encoded URL string.</summary>
144 <param name="bytes">The array of bytes to encode.</param>
145 <returns>An encoded string.</returns>
147 <member name="M:System.Web.HttpUtility.UrlEncode(System.String)">
148 <summary>Encodes a URL string.</summary>
149 <param name="str">The text to encode.</param>
150 <returns>An encoded string.</returns>
152 <member name="M:System.Web.HttpUtility.UrlEncodeToBytes(System.Byte[])">
153 <summary>Converts an array of bytes into a URL-encoded array of bytes.</summary>
154 <param name="bytes">The array of bytes to encode.</param>
155 <returns>An encoded array of bytes.</returns>
157 <member name="M:System.Web.HttpUtility.UrlEncodeToBytes(System.String)">
158 <summary>Converts a string into a URL-encoded array of bytes.</summary>
159 <param name="str">The string to encode.</param>
160 <returns>An encoded array of bytes.</returns>
162 <member name="M:System.Web.HttpUtility.UrlEncodeToBytes(System.String,System.Text.Encoding)">
163 <summary>Converts a string into a URL-encoded array of bytes using the specified encoding object.</summary>
164 <param name="str">The string to encode</param>
165 <param name="e">The <see cref="T:System.Text.Encoding"></see> that specifies the encoding scheme.</param>
166 <returns>An encoded array of bytes.</returns>
168 <member name="M:System.Web.HttpUtility.UrlEncodeToBytes(System.Byte[],System.Int32,System.Int32)">
169 <summary>Converts an array of bytes into a URL-encoded array of bytes, starting at the specified position in the array and continuing for the specified number of bytes.</summary>
170 <param name="bytes">The array of bytes to encode.</param>
171 <param name="offset">The position in the byte array at which to begin encoding.</param>
172 <param name="count">The number of bytes to encode.</param>
173 <returns>An encoded array of bytes.</returns>
174 <exception cref="T:System.ArgumentNullException"><paramref name="bytes">bytes</paramref> is <see langword="null"></see>, but <paramref name="count">count</paramref> does not equal <see langword="0"></see>.</exception>
175 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than <see langword="0"></see> or greater than the length of the <paramref name="bytes">bytes</paramref> array.
177 <paramref name="count">count</paramref> is less than <see langword="0"></see>, or <paramref name="count">count</paramref> + <paramref name="offset">offset</paramref> is greater than the length of the <paramref name="bytes">bytes</paramref> array.</exception>
179 <member name="M:System.Web.HttpUtility.UrlEncodeUnicode(System.String)">
180 <summary>Converts a string into a Unicode string.</summary>
181 <param name="str">The string to convert.</param>
182 <returns>A Unicode string in %<paramref name="UnicodeValue">UnicodeValue</paramref> notation.</returns>
184 <member name="M:System.Web.HttpUtility.UrlEncodeUnicodeToBytes(System.String)">
185 <summary>Converts a Unicode string into an array of bytes.</summary>
186 <param name="str">The string to convert.</param>
187 <returns>A byte array.</returns>
189 <member name="M:System.Web.HttpUtility.UrlPathEncode(System.String)">
190 <summary>Do not use; intended only for browser compatibility. Use <see cref="M:System.Web.HttpUtility.UrlEncode(System.String)"></see>.</summary>
191 <param name="str"></param>
192 <returns>The encoded text.</returns>