WebProxy Class
Contains HTTP proxy settings for the WebRequest class.
Assembly: System (in System.dll)
The WebProxy type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | WebProxy() | Initializes an empty instance of the WebProxy class. |
![]() | WebProxy(String) | Initializes a new instance of the WebProxy class with the specified URI. |
![]() | WebProxy(Uri) | Initializes a new instance of the WebProxy class from the specified Uri instance. |
![]() | WebProxy(SerializationInfo, StreamingContext) | Initializes an instance of the WebProxy class using previously serialized content. |
![]() | WebProxy(String, Boolean) | Initializes a new instance of the WebProxy class with the specified URI and bypass setting. |
![]() | WebProxy(String, Int32) | Initializes a new instance of the WebProxy class with the specified host and port number. |
![]() | WebProxy(Uri, Boolean) | Initializes a new instance of the WebProxy class with the Uri instance and bypass setting. |
![]() | WebProxy(String, Boolean, array<String>) | Initializes a new instance of the WebProxy class with the specified URI, bypass setting, and list of URIs to bypass. |
![]() | WebProxy(Uri, Boolean, array<String>) | Initializes a new instance of the WebProxy class with the specified Uri instance, bypass setting, and list of URIs to bypass. |
![]() | WebProxy(String, Boolean, array<String>, ICredentials) | Initializes a new instance of the WebProxy class with the specified URI, bypass setting, list of URIs to bypass, and credentials. |
![]() | WebProxy(Uri, Boolean, array<String>, ICredentials) | Initializes a new instance of the WebProxy class with the specified Uri instance, bypass setting, list of URIs to bypass, and credentials. |
| Name | Description | |
|---|---|---|
![]() | Address | Gets or sets the address of the proxy server. |
![]() | BypassArrayList | Gets a list of addresses that do not use the proxy server. |
![]() | BypassList | Gets or sets an array of addresses that do not use the proxy server. |
![]() | BypassProxyOnLocal | Gets or sets a value that indicates whether to bypass the proxy server for local addresses. |
![]() | Credentials | Gets or sets the credentials to submit to the proxy server for authentication. |
![]() | UseDefaultCredentials | Gets or sets a Boolean value that controls whether the DefaultCredentials are sent with requests. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | GetDefaultProxy | Obsolete. Reads the Internet Explorer nondynamic proxy settings. |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetObjectData | Populates a SerializationInfo with the data that is needed to serialize the target object. |
![]() | GetProxy | Returns the proxied URI for a request. |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IsBypassed | Indicates whether to use the proxy server for the specified host. |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | ISerializable::GetObjectData | Infrastructure. Creates the serialization data and context that are used by the system to serialize a WebProxy object. |
The WebProxy class contains the proxy settings that WebRequest instances use to determine whether a Web proxy is used to send requests. Global Web proxy settings can be specified in machine and application configuration files, and applications can use instances of the WebProxy class to customize Web proxy use. The WebProxy class is the base implementation of the IWebProxy interface.
To obtain instances of the Web proxy class, you can use any of the following methods:
The WebProxy constructor.
The GetDefaultProxy method.
The Select method.
These methods each supply a WebProxy instance that you can further customize; the difference between them is how the instance is initialized before it is returned to your application. The WebProxy constructor returns an instance of the WebProxy class with the Address property set to nullptr. When a request uses a WebProxy instance in this state, no proxy is used to send the request.
The GetDefaultProxy method returns an instance of the WebProxy class with the Address, BypassProxyOnLocal, and BypassList properties set to the values used by Internet Explorer 5.5 and later.
The Select method returns an instance of the WebProxy class with it properties set according to a combination of Internet Explorer and configuration file settings.
The WebProxy class supports automatic detection and execution of proxy configuration scripts. This feature is also known as Web Proxy Auto-Discovery (WPAD). When using automatic proxy configuration, a configuration script, typically named Wpad.dat, must be located, downloaded, compiled, and run. If these operations are successful, the script returns the proxies that can be used for a request.
The following code example assigns a WebProxy instance to a WebRequest instance. The WebRequest instance uses the proxy to connect to external Internet resources. (For an example that demonstrates using the WPAD feature, see the documentation for the IWebProxyScript class.)
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
