Loading...

Class ProxySettings

Describes proxy settings collection for HTTP/HTTPS proxy and bypass hosts list

Inheritance
System.Object
ProxySettings
Namespace: Telerik.NetworkConnections
Assembly: Telerik.NetworkConnections.dll

Syntax

public class ProxySettings : Object, IEquatable<ProxySettings>

Constructors

ProxySettings()

Creates a new empty ProxySettings instance

Declaration
public ProxySettings()

ProxySettings(Boolean, Boolean, String, String, Boolean, String, UInt16, Boolean, String, UInt16, Boolean, String, UInt16, Boolean, String, UInt16)

Creates a new ProxySettings instance with specific properties

Declaration
public ProxySettings(bool useWebProxyAutoDiscovery, bool proxyAutoConfigEnabled, string proxyAutoConfigUrl, string bypassHosts, bool httpProxyEnabled, string httpProxyHost, ushort httpProxyPort, bool httpsProxyEnabled, string httpsProxyHost, ushort httpsProxyPort, bool ftpProxyEnabled, string ftpProxyHost, ushort ftpProxyPort, bool socksProxyEnabled, string socksProxyHost, ushort socksProxyPort)
Parameters
System.Boolean useWebProxyAutoDiscovery

Set to true to enable WPAD for the proxy settings
System.Boolean proxyAutoConfigEnabled

Whether to use a PAC script for getting the proxy configuration
System.String proxyAutoConfigUrl

The URL of a PAC script to use for proxy configuration
System.String bypassHosts

A semicolon separated list of hosts that will bypass the proxy
System.Boolean httpProxyEnabled

True if HTTP proxy is set
System.String httpProxyHost

The host to use for HTTP proxy settings
System.UInt16 httpProxyPort

The port to use for HTTP proxy settings
System.Boolean httpsProxyEnabled

True if HTTPS proxy is set
System.String httpsProxyHost

The host to use for HTTPS proxy settings
System.UInt16 httpsProxyPort

The port to use for HTTPS proxy settings
System.Boolean ftpProxyEnabled

(Obsolete) True if FTP proxy is set
System.String ftpProxyHost

(Obsolete) The host to use for FTP proxy settings
System.UInt16 ftpProxyPort

(Obsolete) The port to use for FTP proxy settings
System.Boolean socksProxyEnabled

(Obsolete) True if SOCKS proxy is set
System.String socksProxyHost

(Obsolete) The host to use for SOCKS proxy settings
System.UInt16 socksProxyPort

(Obsolete) The port to use for SOCKS proxy settings

ProxySettings(Boolean, String)

Creates a new ProxySettings instance with specific properties

Declaration
public ProxySettings(bool useWebProxyAutoDiscovery, string bypassHosts)
Parameters
System.Boolean useWebProxyAutoDiscovery

Set to true to enable WPAD for the proxy settings
System.String bypassHosts

A semicolon separated list of hosts that will bypass the proxy

ProxySettings(Boolean, String, String)

Creates a new ProxySettings instance with specific properties

Declaration
public ProxySettings(bool proxyAutoConfigEnabled, string proxyAutoConfigUrl, string bypassHosts)
Parameters
System.Boolean proxyAutoConfigEnabled

Whether to use a PAC script for getting the proxy configuration
System.String proxyAutoConfigUrl

The URL of a PAC script to use for proxy configuration
System.String bypassHosts

A semicolon separated list of hosts that will bypass the proxy

ProxySettings(Boolean, String, UInt16, String)

Creates a new ProxySettings instance with specific properties

Declaration
public ProxySettings(bool allProtocolsEnabled, string allProtocolsHost, ushort allProtocolsPort, string bypassHosts)
Parameters
System.Boolean allProtocolsEnabled

True if HTTP/HTTPS proxy settings are set
System.String allProtocolsHost

The proxy host to use for HTTP/HTTPS proxy settings
System.UInt16 allProtocolsPort

The proxy port to use for HTTP/HTTPS proxy settings
System.String bypassHosts

A semicolon separated list of hosts that will bypass the proxy

Properties

BypassHosts

A semicolon separated list of hosts that will bypass the proxy

Declaration
public string BypassHosts { get; set; }
Property Value
System.String

FtpProxyEnabled

(Obsolete) Set to true if FTP proxy is set

Declaration
public bool FtpProxyEnabled { get; set; }
Property Value
System.Boolean

FtpProxyHost

(Obsolete) The host to use for FTP proxy settings

Declaration
public string FtpProxyHost { get; set; }
Property Value
System.String

FtpProxyPort

(Obsolete) The port to use for FTP proxy settings

Declaration
public ushort FtpProxyPort { get; set; }
Property Value
System.UInt16

HttpProxyEnabled

Set to true if HTTP proxy is set

Declaration
public bool HttpProxyEnabled { get; set; }
Property Value
System.Boolean

HttpProxyHost

The host to use for HTTP proxy settings

Declaration
public string HttpProxyHost { get; set; }
Property Value
System.String

HttpProxyPort

The port to use for HTTP proxy settings

Declaration
public ushort HttpProxyPort { get; set; }
Property Value
System.UInt16

HttpsProxyEnabled

Set to true if HTTPS proxy is set

Declaration
public bool HttpsProxyEnabled { get; set; }
Property Value
System.Boolean

HttpsProxyHost

The host to use for HTTPS proxy settings

Declaration
public string HttpsProxyHost { get; set; }
Property Value
System.String

HttpsProxyPort

The port to use for HTTPS proxy settings

Declaration
public ushort HttpsProxyPort { get; set; }
Property Value
System.UInt16

ProxyAutoConfigEnabled

Whether to use a PAC script for getting the proxy configuration

Declaration
public bool ProxyAutoConfigEnabled { get; set; }
Property Value
System.Boolean

ProxyAutoConfigUrl

The URL of a PAC script to use for proxy configuration

Declaration
public string ProxyAutoConfigUrl { get; set; }
Property Value
System.String

SocksProxyEnabled

(Obsolete) Set to true if SOCKS proxy is set

Declaration
public bool SocksProxyEnabled { get; set; }
Property Value
System.Boolean

SocksProxyHost

(Obsolete) The host to use for SOCKS proxy settings

Declaration
public string SocksProxyHost { get; set; }
Property Value
System.String

SocksProxyPort

(Obsolete) The port to use for SOCKS proxy settings

Declaration
public ushort SocksProxyPort { get; set; }
Property Value
System.UInt16

UseWebProxyAutoDiscovery

Set to true to enable WPAD for the proxy settings

Declaration
public bool UseWebProxyAutoDiscovery { get; set; }
Property Value
System.Boolean

Methods

Equals(Object)

Implements the System.IEquatable<> interface Equals for comparing to another object

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The object instance to compare to
Returns
System.Boolean

True if the object is a ProxySettings instance and proxy settings are equal

Equals(ProxySettings)

Compares this instance to another ProxySettings instance

Declaration
public bool Equals(ProxySettings other)
Parameters
ProxySettings other

The ProxySettings instance to compare to
Returns
System.Boolean

True if the proxy settings are equal

GetHashCode()

Implements the System.IEquatable<> interface GetHashCode

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the proxy settings

GetProxyServerString()

Returns a string representation of the current proxy settings

Declaration
public string GetProxyServerString()
Returns
System.String

Operators

Equality(ProxySettings, ProxySettings)

Compares two ProxySettings instances for equality

Declaration
public static bool operator ==(ProxySettings left, ProxySettings right)
Parameters
ProxySettings left

First ProxySettings instance
ProxySettings right

Second ProxySettings instance
Returns
System.Boolean

True if the proxy settings are equal

Inequality(ProxySettings, ProxySettings)

Compares two ProxySettings instances for difference

Declaration
public static bool operator !=(ProxySettings left, ProxySettings right)
Parameters
ProxySettings left

First ProxySettings instance
ProxySettings right

Second ProxySettings instance
Returns
System.Boolean

True if the proxy settings are not equal