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" />.
26 An internal-only value returned.</returns>
28 <member name="T:System.Net.WebProxy">
29 <summary>Contains HTTP proxy settings for the <see cref="T:System.Net.WebRequest" /> class.</summary>
31 <member name="M:System.Net.WebProxy.#ctor">
32 <summary>Initializes an empty instance of the <see cref="T:System.Net.WebProxy" /> class.</summary>
34 <member name="M:System.Net.WebProxy.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
35 <summary>Initializes an instance of the <see cref="T:System.Net.WebProxy" /> class using previously serialized content.</summary>
36 <param name="serializationInfo">The serialization data.</param>
37 <param name="streamingContext">The context for the serialized data.</param>
39 <member name="M:System.Net.WebProxy.#ctor(System.String)">
40 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the specified URI.</summary>
41 <param name="Address">The URI of the proxy server.</param>
42 <exception cref="T:System.UriFormatException">
43 <paramref name="Address" /> is an invalid URI.</exception>
45 <member name="M:System.Net.WebProxy.#ctor(System.String,System.Boolean)">
46 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the specified URI and bypass setting.</summary>
47 <param name="Address">The URI of the proxy server.</param>
48 <param name="BypassOnLocal">
49 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
50 <exception cref="T:System.UriFormatException">
51 <paramref name="Address" /> is an invalid URI.</exception>
53 <member name="M:System.Net.WebProxy.#ctor(System.String,System.Boolean,System.String[])">
54 <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>
55 <param name="Address">The URI of the proxy server.</param>
56 <param name="BypassOnLocal">
57 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
58 <param name="BypassList">An array of regular expression strings that contain the URIs of the servers to bypass.</param>
59 <exception cref="T:System.UriFormatException">
60 <paramref name="Address" /> is an invalid URI.</exception>
62 <member name="M:System.Net.WebProxy.#ctor(System.String,System.Boolean,System.String[],System.Net.ICredentials)">
63 <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>
64 <param name="Address">The URI of the proxy server.</param>
65 <param name="BypassOnLocal">
66 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
67 <param name="BypassList">An array of regular expression strings that contains the URIs of the servers to bypass.</param>
68 <param name="Credentials">An <see cref="T:System.Net.ICredentials" /> instance to submit to the proxy server for authentication.</param>
69 <exception cref="T:System.UriFormatException">
70 <paramref name="Address" /> is an invalid URI.</exception>
72 <member name="M:System.Net.WebProxy.#ctor(System.String,System.Int32)">
73 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class with the specified host and port number.</summary>
74 <param name="Host">The name of the proxy host.</param>
75 <param name="Port">The port number on <paramref name="Host" /> to use.</param>
76 <exception cref="T:System.UriFormatException">The URI formed by combining <paramref name="Host" /> and <paramref name="Port" /> is not a valid URI.</exception>
78 <member name="M:System.Net.WebProxy.#ctor(System.Uri)">
79 <summary>Initializes a new instance of the <see cref="T:System.Net.WebProxy" /> class from the specified <see cref="T:System.Uri" /> instance.</summary>
80 <param name="Address">A <see cref="T:System.Uri" /> instance that contains the address of the proxy server.</param>
82 <member name="M:System.Net.WebProxy.#ctor(System.Uri,System.Boolean)">
83 <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>
84 <param name="Address">A <see cref="T:System.Uri" /> instance that contains the address of the proxy server.</param>
85 <param name="BypassOnLocal">
86 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
88 <member name="M:System.Net.WebProxy.#ctor(System.Uri,System.Boolean,System.String[])">
89 <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>
90 <param name="Address">A <see cref="T:System.Uri" /> instance that contains the address of the proxy server.</param>
91 <param name="BypassOnLocal">
92 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
93 <param name="BypassList">An array of regular expression strings that contains the URIs of the servers to bypass.</param>
95 <member name="M:System.Net.WebProxy.#ctor(System.Uri,System.Boolean,System.String[],System.Net.ICredentials)">
96 <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>
97 <param name="Address">A <see cref="T:System.Uri" /> instance that contains the address of the proxy server.</param>
98 <param name="BypassOnLocal">
99 <see langword="true" /> to bypass the proxy for local addresses; otherwise, <see langword="false" />.</param>
100 <param name="BypassList">An array of regular expression strings that contains the URIs of the servers to bypass.</param>
101 <param name="Credentials">An <see cref="T:System.Net.ICredentials" /> instance to submit to the proxy server for authentication.</param>
103 <member name="M:System.Net.WebProxy.GetDefaultProxy">
104 <summary>Reads the Internet Explorer nondynamic proxy settings.</summary>
105 <returns>A <see cref="T:System.Net.WebProxy" /> instance that contains the nondynamic proxy settings from Internet Explorer 5.5 and later.</returns>
107 <member name="M:System.Net.WebProxy.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
108 <summary>Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the data that is needed to serialize the target object.</summary>
109 <param name="serializationInfo">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
110 <param name="streamingContext">A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that specifies the destination for this serialization.</param>
112 <member name="M:System.Net.WebProxy.GetProxy(System.Uri)">
113 <summary>Returns the proxied URI for a request.</summary>
114 <param name="destination">The <see cref="T:System.Uri" /> instance of the requested Internet resource.</param>
115 <exception cref="T:System.ArgumentNullException">The <paramref name="destination" /> parameter is <see langword="null" />.</exception>
116 <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>
118 <member name="M:System.Net.WebProxy.IsBypassed(System.Uri)">
119 <summary>Indicates whether to use the proxy server for the specified host.</summary>
120 <param name="host">The <see cref="T:System.Uri" /> instance of the host to check for proxy use.</param>
121 <exception cref="T:System.ArgumentNullException">The <paramref name="host" /> parameter is <see langword="null" />.</exception>
123 <see langword="true" /> if the proxy server should not be used for <paramref name="host" />; otherwise, <see langword="false" />.</returns>
125 <member name="M:System.Net.WebProxy.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
126 <summary>Creates the serialization data and context that are used by the system to serialize a <see cref="T:System.Net.WebProxy" /> object.</summary>
127 <param name="serializationInfo">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object to populate with data.</param>
128 <param name="streamingContext">A <see cref="T:System.Runtime.Serialization.StreamingContext" /> structure that indicates the destination for this serialization.</param>
130 <member name="P:System.Net.WebProxy.Address">
131 <summary>Gets or sets the address of the proxy server.</summary>
132 <returns>A <see cref="T:System.Uri" /> instance that contains the address of the proxy server.</returns>
134 <member name="P:System.Net.WebProxy.BypassArrayList">
135 <summary>Gets a list of addresses that do not use the proxy server.</summary>
136 <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>
138 <member name="P:System.Net.WebProxy.BypassList">
139 <summary>Gets or sets an array of addresses that do not use the proxy server.</summary>
140 <returns>An array that contains a list of regular expressions that describe URIs that do not use the proxy server when accessed.</returns>
142 <member name="P:System.Net.WebProxy.BypassProxyOnLocal">
143 <summary>Gets or sets a value that indicates whether to bypass the proxy server for local addresses.</summary>
145 <see langword="true" /> to bypass the proxy server for local addresses; otherwise, <see langword="false" />. The default value is <see langword="false" />.</returns>
147 <member name="P:System.Net.WebProxy.Credentials">
148 <summary>Gets or sets the credentials to submit to the proxy server for authentication.</summary>
149 <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>
150 <returns>An <see cref="T:System.Net.ICredentials" /> instance that contains the credentials to submit to the proxy server for authentication.</returns>
152 <member name="P:System.Net.WebProxy.UseDefaultCredentials">
153 <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 <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>
156 <see langword="true" /> if the default credentials are used; otherwise, <see langword="false" />. The default value is <see langword="false" />.</returns>