1 <?xml version="1.0" encoding="utf-8"?>
4 <name>System.Net.WebProxy</name>
7 <member name="T:System.Net.IWebProxyScript">
8 <summary>Provides the base interface to load and execute scripts for automatic proxy detection.</summary>
10 <member name="M:System.Net.IWebProxyScript.Close">
11 <summary>Closes a script.</summary>
13 <member name="M:System.Net.IWebProxyScript.Load(System.Uri,System.String,System.Type)">
14 <summary>Loads a script.</summary>
15 <param name="scriptLocation">Internal only.</param>
16 <param name="script">Internal only.</param>
17 <param name="helperType">Internal only.</param>
18 <returns>A <see cref="T:System.Boolean" /> indicating whether the script was successfully loaded.</returns>
20 <member name="M:System.Net.IWebProxyScript.Run(System.String,System.String)">
21 <summary>Runs a script.</summary>
22 <param name="url">Internal only.</param>
23 <param name="host">Internal only.</param>
24 <returns>A <see cref="T:System.String" />.
25 An internal-only value returned.</returns>
27 <member name="T:System.Net.WebProxy">
28 <summary>Contains HTTP proxy settings for the <see cref="T:System.Net.WebRequest" /> class.</summary>
30 <member name="M:System.Net.WebProxy.#ctor">
31 <summary>Initializes an empty instance of the <see cref="T:System.Net.WebProxy" /> class.</summary>
33 <member name="M:System.Net.WebProxy.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
34 <summary>Initializes an instance of the <see cref="T:System.Net.WebProxy" /> class using previously serialized content.</summary>
35 <param name="serializationInfo">The serialization data.</param>
36 <param name="streamingContext">The context for the serialized data.</param>
38 <member name="M:System.Net.WebProxy.#ctor(System.String)">
39 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the specified URI.</summary>
40 <param name="Address">The URI of the proxy server.</param>
41 <exception cref="T:System.UriFormatException">
42 <paramref name="Address" /> is an invalid URI.</exception>
44 <member name="M:System.Net.WebProxy.#ctor(System.String,System.Boolean)">
45 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the specified URI and bypass setting.</summary>
46 <param name="Address">The URI of the proxy server.</param>
47 <param name="BypassOnLocal">
48 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
49 <exception cref="T:System.UriFormatException">
50 <paramref name="Address" /> is an invalid URI.</exception>
52 <member name="M:System.Net.WebProxy.#ctor(System.String,System.Boolean,System.String[])">
53 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the specified URI, bypass setting, and list of URIs to bypass.</summary>
54 <param name="Address">The URI of the proxy server.</param>
55 <param name="BypassOnLocal">
56 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
57 <param name="BypassList">An array of regular expression strings that contain the URIs of the servers to bypass.</param>
58 <exception cref="T:System.UriFormatException">
59 <paramref name="Address" /> is an invalid URI.</exception>
61 <member name="M:System.Net.WebProxy.#ctor(System.String,System.Boolean,System.String[],System.Net.ICredentials)">
62 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the specified URI, bypass setting, list of URIs to bypass, and credentials.</summary>
63 <param name="Address">The URI of the proxy server.</param>
64 <param name="BypassOnLocal">
65 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
66 <param name="BypassList">An array of regular expression strings that contains the URIs of the servers to bypass.</param>
67 <param name="Credentials">An <see cref="T:System.Net.ICredentials" /> instance to submit to the proxy server for authentication.</param>
68 <exception cref="T:System.UriFormatException">
69 <paramref name="Address" /> is an invalid URI.</exception>
71 <member name="M:System.Net.WebProxy.#ctor(System.String,System.Int32)">
72 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the specified host and port number.</summary>
73 <param name="Host">The name of the proxy host.</param>
74 <param name="Port">The port number on <paramref name="Host" /> to use.</param>
75 <exception cref="T:System.UriFormatException">The URI formed by combining <paramref name="Host" /> and <paramref name="Port" /> is not a valid URI.</exception>
77 <member name="M:System.Net.WebProxy.#ctor(System.Uri)">
78 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class from the specified <see cref="T:System.Uri" /> instance.</summary>
79 <param name="Address">A <see cref="T:System.Uri" /> instance that contains the address of the proxy server.</param>
81 <member name="M:System.Net.WebProxy.#ctor(System.Uri,System.Boolean)">
82 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the <see cref="T:System.Uri" /> instance and bypass setting.</summary>
83 <param name="Address">A <see cref="T:System.Uri" /> instance that contains the address of the proxy server.</param>
84 <param name="BypassOnLocal">
85 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
87 <member name="M:System.Net.WebProxy.#ctor(System.Uri,System.Boolean,System.String[])">
88 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the specified <see cref="T:System.Uri" /> instance, bypass setting, and list of URIs to bypass.</summary>
89 <param name="Address">A <see cref="T:System.Uri" /> instance that contains the address of the proxy server.</param>
90 <param name="BypassOnLocal">
91 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
92 <param name="BypassList">An array of regular expression strings that contains the URIs of the servers to bypass.</param>
94 <member name="M:System.Net.WebProxy.#ctor(System.Uri,System.Boolean,System.String[],System.Net.ICredentials)">
95 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the specified <see cref="T:System.Uri" /> instance, bypass setting, list of URIs to bypass, and credentials.</summary>
96 <param name="Address">A <see cref="T:System.Uri" /> instance that contains the address of the proxy server.</param>
97 <param name="BypassOnLocal">
98 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
99 <param name="BypassList">An array of regular expression strings that contains the URIs of the servers to bypass.</param>
100 <param name="Credentials">An <see cref="T:System.Net.ICredentials" /> instance to submit to the proxy server for authentication.</param>
102 <member name="P:System.Net.WebProxy.Address">
103 <summary>Gets or sets the address of the proxy server.</summary>
104 <returns>A <see cref="T:System.Uri" /> instance that contains the address of the proxy server.</returns>
106 <member name="P:System.Net.WebProxy.BypassArrayList">
107 <summary>Gets a list of addresses that do not use the proxy server.</summary>
108 <returns>An <see cref="T:System.Collections.ArrayList" /> that contains a list of <see cref="P:System.Net.WebProxy.BypassList" /> arrays that represents URIs that do not use the proxy server when accessed.</returns>
110 <member name="P:System.Net.WebProxy.BypassList">
111 <summary>Gets or sets an array of addresses that do not use the proxy server.</summary>
112 <returns>An array that contains a list of regular expressions that describe URIs that do not use the proxy server when accessed.</returns>
114 <member name="P:System.Net.WebProxy.BypassProxyOnLocal">
115 <summary>Gets or sets a value that indicates whether to bypass the proxy server for local addresses.</summary>
117 <see langword="true" /> to bypass the proxy server for local addresses; otherwise, <see langword="false" />. The default value is <see langword="false" />.</returns>
119 <member name="P:System.Net.WebProxy.Credentials">
120 <summary>Gets or sets the credentials to submit to the proxy server for authentication.</summary>
121 <returns>An <see cref="T:System.Net.ICredentials" /> instance that contains the credentials to submit to the proxy server for authentication.</returns>
122 <exception cref="T:System.InvalidOperationException">You attempted to set this property when the <see cref="P:System.Net.WebProxy.UseDefaultCredentials" /> property was set to <see langword="true" />.</exception>
124 <member name="M:System.Net.WebProxy.GetDefaultProxy">
125 <summary>Reads the Internet Explorer nondynamic proxy settings.</summary>
126 <returns>A <see cref="T:System.Net.WebProxy" /> instance that contains the nondynamic proxy settings from Internet Explorer 5.5 and later.</returns>
128 <member name="M:System.Net.WebProxy.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
129 <summary>Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the data that is needed to serialize the target object.</summary>
130 <param name="serializationInfo">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
131 <param name="streamingContext">A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that specifies the destination for this serialization.</param>
133 <member name="M:System.Net.WebProxy.GetProxy(System.Uri)">
134 <summary>Returns the proxied URI for a request.</summary>
135 <param name="destination">The <see cref="T:System.Uri" /> instance of the requested Internet resource.</param>
136 <returns>The <see cref="T:System.Uri" /> instance of the Internet resource, if the resource is on the bypass list; otherwise, the <see cref="T:System.Uri" /> instance of the proxy.</returns>
137 <exception cref="T:System.ArgumentNullException">The <paramref name="destination" /> parameter is <see langword="null" />.</exception>
139 <member name="M:System.Net.WebProxy.IsBypassed(System.Uri)">
140 <summary>Indicates whether to use the proxy server for the specified host.</summary>
141 <param name="host">The <see cref="T:System.Uri" /> instance of the host to check for proxy use.</param>
143 <see langword="true" /> if the proxy server should not be used for <paramref name="host" />; otherwise, <see langword="false" />.</returns>
144 <exception cref="T:System.ArgumentNullException">The <paramref name="host" /> parameter is <see langword="null" />.</exception>
146 <member name="M:System.Net.WebProxy.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
147 <summary>Creates the serialization data and context that are used by the system to serialize a <see cref="T:System.Net.WebProxy" /> object.</summary>
148 <param name="serializationInfo">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object to populate with data.</param>
149 <param name="streamingContext">A <see cref="T:System.Runtime.Serialization.StreamingContext" /> structure that indicates the destination for this serialization.</param>
151 <member name="P:System.Net.WebProxy.UseDefaultCredentials">
152 <summary>Gets or sets a <see cref="T:System.Boolean" /> value that controls whether the <see cref="P:System.Net.CredentialCache.DefaultCredentials" /> are sent with requests.</summary>
154 <see langword="true" /> if the default credentials are used; otherwise, <see langword="false" />. The default value is <see langword="false" />.</returns>
155 <exception cref="T:System.InvalidOperationException">You attempted to set this property when the <see cref="P:System.Net.WebProxy.Credentials" /> property contains credentials other than the default credentials.</exception>