Back to all docs
API Reference / Telerik.NetworkConnections / ProxySettings

Class
ProxySettings

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

Definition

Namespace:Telerik.NetworkConnections

Assembly:Telerik.NetworkConnections.dll

Syntax:
cs-api-definition
public class ProxySettings : IEquatable<ProxySettings>

Inheritance: objectProxySettings

Implements: IEquatable<ProxySettings>

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object, object)object.ReferenceEquals(object, object)

Constructors

ProxySettings()

Creates a new empty ProxySettings instance

Declaration

cs-api-definition
public ProxySettings()

ProxySettings(bool, bool, string, string, bool, string, ushort, bool, string, ushort, bool, string, ushort, bool, string, ushort)

Creates a new ProxySettings instance with specific properties

Declaration

cs-api-definition
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

useWebProxyAutoDiscovery

bool

Set to true to enable WPAD for the proxy settings

proxyAutoConfigEnabled

bool

Whether to use a PAC script for getting the proxy configuration

proxyAutoConfigUrl

string

The URL of a PAC script to use for proxy configuration

bypassHosts

string

A semicolon separated list of hosts that will bypass the proxy

httpProxyEnabled

bool

True if HTTP proxy is set

httpProxyHost

string

The host to use for HTTP proxy settings

httpProxyPort

ushort

The port to use for HTTP proxy settings

httpsProxyEnabled

bool

True if HTTPS proxy is set

httpsProxyHost

string

The host to use for HTTPS proxy settings

httpsProxyPort

ushort

The port to use for HTTPS proxy settings

ftpProxyEnabled

bool

(Obsolete) True if FTP proxy is set

ftpProxyHost

string

(Obsolete) The host to use for FTP proxy settings

ftpProxyPort

ushort

(Obsolete) The port to use for FTP proxy settings

socksProxyEnabled

bool

(Obsolete) True if SOCKS proxy is set

socksProxyHost

string

(Obsolete) The host to use for SOCKS proxy settings

socksProxyPort

ushort

(Obsolete) The port to use for SOCKS proxy settings

ProxySettings(bool, string)

Creates a new ProxySettings instance with specific properties

Declaration

cs-api-definition
public ProxySettings(bool useWebProxyAutoDiscovery, string bypassHosts)

Parameters

useWebProxyAutoDiscovery

bool

Set to true to enable WPAD for the proxy settings

bypassHosts

string

A semicolon separated list of hosts that will bypass the proxy

ProxySettings(bool, string, string)

Creates a new ProxySettings instance with specific properties

Declaration

cs-api-definition
public ProxySettings(bool proxyAutoConfigEnabled, string proxyAutoConfigUrl, string bypassHosts)

Parameters

proxyAutoConfigEnabled

bool

Whether to use a PAC script for getting the proxy configuration

proxyAutoConfigUrl

string

The URL of a PAC script to use for proxy configuration

bypassHosts

string

A semicolon separated list of hosts that will bypass the proxy

ProxySettings(bool, string, ushort, string)

Creates a new ProxySettings instance with specific properties

Declaration

cs-api-definition
public ProxySettings(bool allProtocolsEnabled, string allProtocolsHost, ushort allProtocolsPort, string bypassHosts)

Parameters

allProtocolsEnabled

bool

True if HTTP/HTTPS proxy settings are set

allProtocolsHost

string

The proxy host to use for HTTP/HTTPS proxy settings

allProtocolsPort

ushort

The proxy port to use for HTTP/HTTPS proxy settings

bypassHosts

string

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

cs-api-definition
public string BypassHosts { get; set; }

Property Value

string

FtpProxyEnabled

(Obsolete) Set to true if FTP proxy is set

Declaration

cs-api-definition
public bool FtpProxyEnabled { get; set; }

Property Value

bool

FtpProxyHost

(Obsolete) The host to use for FTP proxy settings

Declaration

cs-api-definition
public string FtpProxyHost { get; set; }

Property Value

string

FtpProxyPort

(Obsolete) The port to use for FTP proxy settings

Declaration

cs-api-definition
public ushort FtpProxyPort { get; set; }

Property Value

ushort

HttpProxyEnabled

Set to true if HTTP proxy is set

Declaration

cs-api-definition
public bool HttpProxyEnabled { get; set; }

Property Value

bool

HttpProxyHost

The host to use for HTTP proxy settings

Declaration

cs-api-definition
public string HttpProxyHost { get; set; }

Property Value

string

HttpProxyPort

The port to use for HTTP proxy settings

Declaration

cs-api-definition
public ushort HttpProxyPort { get; set; }

Property Value

ushort

HttpsProxyEnabled

Set to true if HTTPS proxy is set

Declaration

cs-api-definition
public bool HttpsProxyEnabled { get; set; }

Property Value

bool

HttpsProxyHost

The host to use for HTTPS proxy settings

Declaration

cs-api-definition
public string HttpsProxyHost { get; set; }

Property Value

string

HttpsProxyPort

The port to use for HTTPS proxy settings

Declaration

cs-api-definition
public ushort HttpsProxyPort { get; set; }

Property Value

ushort

ProxyAutoConfigEnabled

Whether to use a PAC script for getting the proxy configuration

Declaration

cs-api-definition
public bool ProxyAutoConfigEnabled { get; set; }

Property Value

bool

ProxyAutoConfigUrl

The URL of a PAC script to use for proxy configuration

Declaration

cs-api-definition
public string ProxyAutoConfigUrl { get; set; }

Property Value

string

SocksProxyEnabled

(Obsolete) Set to true if SOCKS proxy is set

Declaration

cs-api-definition
public bool SocksProxyEnabled { get; set; }

Property Value

bool

SocksProxyHost

(Obsolete) The host to use for SOCKS proxy settings

Declaration

cs-api-definition
public string SocksProxyHost { get; set; }

Property Value

string

SocksProxyPort

(Obsolete) The port to use for SOCKS proxy settings

Declaration

cs-api-definition
public ushort SocksProxyPort { get; set; }

Property Value

ushort

UseWebProxyAutoDiscovery

Set to true to enable WPAD for the proxy settings

Declaration

cs-api-definition
public bool UseWebProxyAutoDiscovery { get; set; }

Property Value

bool

Methods

Equals(ProxySettings)

Compares this instance to another ProxySettings instance

Declaration

cs-api-definition
public bool Equals(ProxySettings other)

Parameters

other

ProxySettings

The ProxySettings instance to compare to

Returns

bool

True if the proxy settings are equal

Implements IEquatable<ProxySettings>.Equals(ProxySettings)

Equals(object)

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

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

The object instance to compare to

Returns

bool

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

Overrides object.Equals(object)

GetHashCode()

Implements the IEquatable<T> interface GetHashCode

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

A hash code for the proxy settings

Overrides object.GetHashCode()

GetProxyServerString()

Returns a string representation of the current proxy settings

Declaration

cs-api-definition
public string GetProxyServerString()

Returns

string

Operators

operator !=(ProxySettings, ProxySettings)

Compares two ProxySettings instances for difference

Declaration

cs-api-definition
public static bool operator !=(ProxySettings left, ProxySettings right)

Parameters

left

ProxySettings

First ProxySettings instance

right

ProxySettings

Second ProxySettings instance

Returns

bool

True if the proxy settings are not equal

operator ==(ProxySettings, ProxySettings)

Compares two ProxySettings instances for equality

Declaration

cs-api-definition
public static bool operator ==(ProxySettings left, ProxySettings right)

Parameters

left

ProxySettings

First ProxySettings instance

right

ProxySettings

Second ProxySettings instance

Returns

bool

True if the proxy settings are equal

In this article
DefinitionConstructorsProxySettings()ProxySettings(bool, bool, string, string, bool, string, ushort, bool, string, ushort, bool, string, ushort, bool, string, ushort)ProxySettings(bool, string)ProxySettings(bool, string, string)ProxySettings(bool, string, ushort, string)PropertiesBypassHostsFtpProxyEnabledFtpProxyHostFtpProxyPortHttpProxyEnabledHttpProxyHostHttpProxyPortHttpsProxyEnabledHttpsProxyHostHttpsProxyPortProxyAutoConfigEnabledProxyAutoConfigUrlSocksProxyEnabledSocksProxyHostSocksProxyPortUseWebProxyAutoDiscoveryMethodsEquals(ProxySettings)Equals(object)GetHashCode()GetProxyServerString()Operatorsoperator !=(ProxySettings, ProxySettings)operator ==(ProxySettings, ProxySettings)
Not finding the help you need?
Contact Support