WebDAV Component

Properties   Methods   Events   Config Settings   Errors  

The WebDAV Component implements an easy-to-use interface to the Web Distributed Authoring and Versioning protocol (WebDAV).

Syntax

nsoftware.IPWorksSSL.Webdav

Remarks

The WebDAV Component supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The component allows remote management of resource properties and collection, including creation, deletion, listing, copying, and moving. Resource locking is also supported.

The ListDirectory and FindProperties methods will list the properties of a resource collection or resource, and a DirList or ResourceProperties event will be fired for each matching resource.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.

A number of operations can be performed on resources by using the various methods of the component. Please refer to the individual methods for more information.

WebDAV allows non-standard properties to be specified through XML namespaces.

The namespaces are provided in the Namespaces collection, which is filled automatically when retrieving DAV responses, but must be filled manually when requesting non-standard properties.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Accept Property (WebDAV Component)

This property includes a list of acceptable MIME types for the request.

Syntax

• C#
• VB.NET

public string Accept { get; set; }

Public Property Accept As String

Default Value

""

Remarks

If this property contains a nonempty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

Authorization Property (WebDAV Component)

This property includes the Authorization string to be sent to the server.

Syntax

• C#
• VB.NET

public string Authorization { get; set; }

Public Property Authorization As String

Default Value

""

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

AuthScheme Property (WebDAV Component)

The authentication scheme to use when server authentication is required.

Syntax

• C#
• VB.NET

public WebdavAuthSchemes AuthScheme { get; set; }

enum WebdavAuthSchemes {
  authBasic,
  authDigest,
  authProprietary,
  authNone,
  authNtlm,
  authNegotiate,
  authOAuth
}

Public Property AuthScheme As WebdavAuthSchemes

Enum WebdavAuthSchemes
  authBasic
  authDigest
  authProprietary
  authNone
  authNtlm
  authNegotiate
  authOAuth
End Enum

Default Value

0

Remarks

This property will tell the component which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the component will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the component.

For security, changing the value of this property will cause the component to clear the values of User, Password, and Authorization.

Connected Property (WebDAV Component)

This shows whether the component is connected.

Syntax

• C#
• VB.NET

public bool Connected { get; set; }

Public Property Connected As Boolean

Default Value

False

Remarks

This property is used to determine whether or not the component is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Cookies Property (WebDAV Component)

This property includes a collection of cookies.

Syntax

• C#
• VB.NET

public HTTPCookieList Cookies { get; }

Public Property Cookies As HTTPCookieList

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This collection is indexed from 0 to count -1.

This property is not available at design time.

Depth Property (WebDAV Component)

The depth associated with the current operation.

Syntax

• C#
• VB.NET

public WebdavDepths Depth { get; set; }

enum WebdavDepths {
  dpUnspecified,
  dpResourceOnly,
  dpImmediateChildren,
  dpInfinity
}

Public Property Depth As WebdavDepths

Enum WebdavDepths
  dpUnspecified
  dpResourceOnly
  dpImmediateChildren
  dpInfinity
End Enum

Default Value

0

Remarks

When performing certain operations on resource collections, the component will use Depth to instruct the server on how deep to operate within the collection. Depth is an enumerated type with the following possible values:

Depth is used when performing the following operations: LockResource, MoveResource CopyResource, FindProperties, PatchProperties, and ListDirectory.

Firewall Property (WebDAV Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

FollowRedirects Property (WebDAV Component)

This property determines what happens when the server issues a redirect.

Syntax

• C#
• VB.NET

public WebdavFollowRedirects FollowRedirects { get; set; }

enum WebdavFollowRedirects {
  frNever,
  frAlways,
  frSameScheme
}

Public Property FollowRedirects As WebdavFollowRedirects

Enum WebdavFollowRedirects
  frNever
  frAlways
  frSameScheme
End Enum

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the component throws an exception.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the component throws an exception instead.

Idle Property (WebDAV Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

LocalFile Property (WebDAV Component)

The path to a local file used for DAV operations.

Syntax

• C#
• VB.NET

public string LocalFile { get; set; }

Public Property LocalFile As String

Default Value

""

Remarks

After a GetResource operation, LocalFile will contain the contents of the resource.

For a PutResource operation, LocalFile contains the data that will be uploaded to the server.

If LocalFile is empty then the received data is provided through the Transfer event.

LocalHost Property (WebDAV Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

LockOwner Property (WebDAV Component)

The principle that owns the current resource lock.

Syntax

• C#
• VB.NET

public string LockOwner { get; set; }

Public Property LockOwner As String

Default Value

""

Remarks

Before a call to the LockResource method, LockOwner may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful LockResource operation, the component will set the LockOwner property to the correct value returned in the server's response.

LockScope Property (WebDAV Component)

The scope of the current resource lock.

Syntax

• C#
• VB.NET

public string LockScope { get; set; }

Public Property LockScope As String

Default Value

""

Remarks

Before a call to the LockResource method, LockScope may be set to the type of scope needed for the lock. Currently the component will only allow two types of scopes to be requested:

If no scope is specified, the protocol default scope, "exclusive", will be requested. After a successful LockResource operation, the component will set the LockScope property to the correct value returned in the server's response.

LockTimeout Property (WebDAV Component)

The time to live for the current resource lock.

Syntax

• C#
• VB.NET

public int LockTimeout { get; set; }

Public Property LockTimeout As Integer

Default Value

0

Remarks

Before a call to the LockResource method, LockTimeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If Timeout of 0 is specified, the server will use a default timeout. After a successful LockResource operation, the component will set the LockTimeout property to the correct value returned in the server's response.

LockTokens Property (WebDAV Component)

The lock string to be used when submitting operations on a locked resource.

Syntax

• C#
• VB.NET

public string LockTokens { get; set; }

Public Property LockTokens As String

Default Value

""

Remarks

Before a call to the LockResource method, LockTokens may be set to the tokens returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in LockTimeout. If the lock request is not a lock refresh, LockTokens must be empty, and will be parsed out of the server response after a successful call to the LockResource method.

LockType Property (WebDAV Component)

The type of the current resource lock.

Syntax

• C#
• VB.NET

public string LockType { get; set; }

Public Property LockType As String

Default Value

"write"

Remarks

Before a call to the LockResource method, LockType may be set to the type of lock being requested. Currently, the component only supports requesting locks of type "write", although the protocol defines an optional "read" lock. After a successful LockResource operation, the component will set the LockType property to the correct value returned in the server's response.

Namespaces Property (WebDAV Component)

Collection of namespaces in the current stack.

Syntax

• C#
• VB.NET

public XMLNamespaceList Namespaces { get; }

Public Property Namespaces As XMLNamespaceList

Remarks

WebDAV allows non-standard properties to be specified through XML namespaces.

The collection is filled automatically when retrieving DAV responses, but must be filled manually when requesting non-standard properties.

If the DAV URI is not found in the namespaces collection, it will be added as the default namespace when generating a request. The DAV namespace URI is "DAV:".

This collection is indexed from 0 to count -1.

This property is not available at design time.

OtherHeaders Property (WebDAV Component)

This property includes other headers as determined by the user (optional).

Syntax

• C#
• VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the component beyond what is provided.

This property is not available at design time.

ParsedHeaders Property (WebDAV Component)

This property includes a collection of headers returned from the last request.

Syntax

• C#
• VB.NET

public HeaderList ParsedHeaders { get; }

Public ReadOnly Property ParsedHeaders As HeaderList

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This collection is indexed from 0 to count -1.

This property is read-only and not available at design time.

Password Property (WebDAV Component)

This property includes a password if authentication is to be used.

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

Properties Property (WebDAV Component)

A collection of WebDAV properties.

Syntax

• C#
• VB.NET

public DAVPropertyList Properties { get; }

Public Property Properties As DAVPropertyList

Remarks

The property names provided in Properties collection are used by the FindProperties and PatchProperties methods.

After a call to FindProperties, the Properties collection will contain the name, value and status of DAV property returned by the server. The contents of the collection changes for every matching resource (ResourceProperties event). After the call completes, the collection will contain the values of the last matching resource.

When a call is made to PatchProperties, the component will use the operations provided in the Properties collection to tell the server what to do with the properties under the following scheme:

This collection is indexed from 0 to count -1.

Proxy Property (WebDAV Component)

This property includes a set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

Referer Property (WebDAV Component)

This property includes the referer URL/document (optional).

Syntax

• C#
• VB.NET

public string Referer { get; set; }

Public Property Referer As String

Default Value

""

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

This property is not available at design time.

Resources Property (WebDAV Component)

Collection of resources resulting from the last directory listing.

Syntax

• C#
• VB.NET

public DAVResourceList Resources { get; }

Public ReadOnly Property Resources As DAVResourceList

Remarks

This property contains a list of resources listed by the server after a call to the ListDirectory method. To retrieve properties of a particular resource, please refer to the FindProperties method).

MaxResources can be used to control the number of resource listings saved.

This collection is indexed from 0 to count -1.

This property is read-only.

SSLAcceptServerCert Property (WebDAV Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (WebDAV Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (WebDAV Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public WebdavSSLProviders SSLProvider { get; set; }

enum WebdavSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As WebdavSSLProviders

Enum WebdavSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (WebDAV Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

StatusLine Property (WebDAV Component)

This property is the first line of the last server response.

Syntax

• C#
• VB.NET

public string StatusLine { get; }

Public ReadOnly Property StatusLine As String

Default Value

""

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the component, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].

This property is read-only and not available at design time.

Timeout Property (WebDAV Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TransferredData Property (WebDAV Component)

This property includes the contents of the last response from the server.

Syntax

• C#
• VB.NET

public string TransferredData { get; }
public byte[] TransferredDataB { get; }

Public ReadOnly Property TransferredData As String
Public ReadOnly Property TransferredDataB As Byte()

Default Value

""

Remarks

This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).

This property is read-only and not available at design time.

TransferredDataLimit Property (WebDAV Component)

This property specifies the the maximum amount of data to be transferred.

Syntax

• C#
• VB.NET

public long TransferredDataLimit { get; set; }

Public Property TransferredDataLimit As Long

Default Value

0

Remarks

This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData property.

TransferredHeaders Property (WebDAV Component)

This property includes the full set of headers as received from the server.

Syntax

• C#
• VB.NET

public string TransferredHeaders { get; }

Public ReadOnly Property TransferredHeaders As String

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the component.

This property is read-only and not available at design time.

User Property (WebDAV Component)

This property includes a user name if authentication is to be used.

Syntax

• C#
• VB.NET

public string User { get; set; }

Public Property User As String

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

AddCookie Method (WebDAV Component)

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

• C#
• VB.NET

public void AddCookie(string cookieName, string cookieValue);

Async Version
public async Task AddCookie(string cookieName, string cookieValue);
public async Task AddCookie(string cookieName, string cookieValue, CancellationToken cancellationToken);

Public Sub AddCookie(ByVal CookieName As String, ByVal CookieValue As String)

Async Version
Public Sub AddCookie(ByVal CookieName As String, ByVal CookieValue As String) As Task
Public Sub AddCookie(ByVal CookieName As String, ByVal CookieValue As String, cancellationToken As CancellationToken) As Task

Remarks

This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

AddNamespace Method (WebDAV Component)

Adds a namespace to the Namespaces properties.

Syntax

• C#
• VB.NET

public void AddNamespace(string prefix, string namespaceURI);

Async Version
public async Task AddNamespace(string prefix, string namespaceURI);
public async Task AddNamespace(string prefix, string namespaceURI, CancellationToken cancellationToken);

Public Sub AddNamespace(ByVal Prefix As String, ByVal NamespaceURI As String)

Async Version
Public Sub AddNamespace(ByVal Prefix As String, ByVal NamespaceURI As String) As Task
Public Sub AddNamespace(ByVal Prefix As String, ByVal NamespaceURI As String, cancellationToken As CancellationToken) As Task

Remarks

Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

Config Method (WebDAV Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CopyResource Method (WebDAV Component)

Copy a resource to a new location.

Syntax

• C#
• VB.NET

public void CopyResource(string sourceResourceURI, string destinationResourceURI);

Async Version
public async Task CopyResource(string sourceResourceURI, string destinationResourceURI);
public async Task CopyResource(string sourceResourceURI, string destinationResourceURI, CancellationToken cancellationToken);

Public Sub CopyResource(ByVal SourceResourceURI As String, ByVal DestinationResourceURI As String)

Async Version
Public Sub CopyResource(ByVal SourceResourceURI As String, ByVal DestinationResourceURI As String) As Task
Public Sub CopyResource(ByVal SourceResourceURI As String, ByVal DestinationResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

The CopyResource method will copy the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

This method is associated with the Depth property. If Depth is set to "0", the component will copy only SourceResourceURI. If Depth is set to "infinity", the component will copy SourceResourceURI and its entire subtree to locations relative to it.

If the user has acquired a LockResource of infinite depth on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

DeleteResource Method (WebDAV Component)

Delete a resource.

Syntax

• C#
• VB.NET

public void DeleteResource(string resourceURI);

Async Version
public async Task DeleteResource(string resourceURI);
public async Task DeleteResource(string resourceURI, CancellationToken cancellationToken);

Public Sub DeleteResource(ByVal ResourceURI As String)

Async Version
Public Sub DeleteResource(ByVal ResourceURI As String) As Task
Public Sub DeleteResource(ByVal ResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

The resource or collection specified by ResourceURI is deleted. The DeleteResource method behaves independently of the Depth property. If ResourceURI denotes a non-collection resource, it is first removed from any collection which contains, then is removed from the server. If ResourceURI denotes a collection, the server behaves as if the command were issued with an infinite depth (ie, all internal member URIs denoting single resources or collections are deleted).

DoEvents Method (WebDAV Component)

Processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

FindProperties Method (WebDAV Component)

Get resource property values from the server.

Syntax

• C#
• VB.NET

public void FindProperties(string resourceURI);

Async Version
public async Task FindProperties(string resourceURI);
public async Task FindProperties(string resourceURI, CancellationToken cancellationToken);

Public Sub FindProperties(ByVal ResourceURI As String)

Async Version
Public Sub FindProperties(ByVal ResourceURI As String) As Task
Public Sub FindProperties(ByVal ResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

FindProperties will request the values for the names at each item provided in the Properties collection. The matching URIs and property values will be returned through one or more ResourceProperties events (one for each matching resource).

If there are no Properties set, then the server will be asked for all the properties of the resource. The properties will be returned via one or more ResourceProperties events.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.

FindPropertyNames Method (WebDAV Component)

Get resource property names from the server.

Syntax

• C#
• VB.NET

public void FindPropertyNames(string resourceURI);

Async Version
public async Task FindPropertyNames(string resourceURI);
public async Task FindPropertyNames(string resourceURI, CancellationToken cancellationToken);

Public Sub FindPropertyNames(ByVal ResourceURI As String)

Async Version
Public Sub FindPropertyNames(ByVal ResourceURI As String) As Task
Public Sub FindPropertyNames(ByVal ResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

FindPropertyNames will request names of all the properties of ResourceURI. The matching URIs will be returned through one or more ResourceProperties events (one for each matching resource), and the property names will be provided through the Properties collection.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.

GetProperty Method (WebDAV Component)

Get the value for a particular property.

Syntax

• C#
• VB.NET

public string GetProperty(string propertyName);

Async Version
public async Task<string> GetProperty(string propertyName);
public async Task<string> GetProperty(string propertyName, CancellationToken cancellationToken);

Public Function GetProperty(ByVal PropertyName As String) As String

Async Version
Public Function GetProperty(ByVal PropertyName As String) As Task(Of String)
Public Function GetProperty(ByVal PropertyName As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

The component will search through its internal Properties collection for the property identified by PropertyName and will return the value associated with it.

PropertyName may also be a partial XPath expression to the retrieved resource XML. This is useful for reading values of composite properties.

GetResource Method (WebDAV Component)

Get a resource using the WebDAV GET method.

Syntax

• C#
• VB.NET

public void GetResource(string resourceURI);

Async Version
public async Task GetResource(string resourceURI);
public async Task GetResource(string resourceURI, CancellationToken cancellationToken);

Public Sub GetResource(ByVal ResourceURI As String)

Async Version
Public Sub GetResource(ByVal ResourceURI As String) As Task
Public Sub GetResource(ByVal ResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

Fetch the resource using the WebDAV GET method. The resource contents are delivered through the Transfer event, and the HTTP response headers through the Header event.

Interrupt Method (WebDAV Component)

Interrupt the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListDirectory Method (WebDAV Component)

List the files and subdirectories of the ResourceURI .

Syntax

• C#
• VB.NET

public void ListDirectory(string resourceURI);

Async Version
public async Task ListDirectory(string resourceURI);
public async Task ListDirectory(string resourceURI, CancellationToken cancellationToken);

Public Sub ListDirectory(ByVal ResourceURI As String)

Async Version
Public Sub ListDirectory(ByVal ResourceURI As String) As Task
Public Sub ListDirectory(ByVal ResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

This method will return a list of resources from the specified URI. The results will be returned through one or more DirList events (one for each matching resource).

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.

LockResource Method (WebDAV Component)

Obtain a lock for a specified resource.

Syntax

• C#
• VB.NET

public void LockResource(string resourceURI);

Async Version
public async Task LockResource(string resourceURI);
public async Task LockResource(string resourceURI, CancellationToken cancellationToken);

Public Sub LockResource(ByVal ResourceURI As String)

Async Version
Public Sub LockResource(ByVal ResourceURI As String) As Task
Public Sub LockResource(ByVal ResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

The LockResource method will request a new lock to be placed on ResourceURI in the user's name so that only the user can operate on it. The method is linked to a number of properties that it uses to generate the lock request:

This method is associated with the Depth property. If Depth is set to "0", the component will lock only ResourceURI and its properties. If Depth is set to "infinity", the component will lock ResourceURI and its entire subtree.

If MoveResource or CopyResource are used to place a resource or collection in a location under a resource locked with "infinity", the new resource or collection will be added to the lock. Any lock on a collection will prevent non-lock owners from adding resources to that collection.

MakeDirectory Method (WebDAV Component)

Make a new directory.

Syntax

• C#
• VB.NET

public void MakeDirectory(string resourceURI);

Async Version
public async Task MakeDirectory(string resourceURI);
public async Task MakeDirectory(string resourceURI, CancellationToken cancellationToken);

Public Sub MakeDirectory(ByVal ResourceURI As String)

Async Version
Public Sub MakeDirectory(ByVal ResourceURI As String) As Task
Public Sub MakeDirectory(ByVal ResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

A new resource collection is created at the location specified by ResourceURI.

MoveResource Method (WebDAV Component)

Moves one resource to a new location.

Syntax

• C#
• VB.NET

public void MoveResource(string sourceResourceURI, string destinationResourceURI);

Async Version
public async Task MoveResource(string sourceResourceURI, string destinationResourceURI);
public async Task MoveResource(string sourceResourceURI, string destinationResourceURI, CancellationToken cancellationToken);

Public Sub MoveResource(ByVal SourceResourceURI As String, ByVal DestinationResourceURI As String)

Async Version
Public Sub MoveResource(ByVal SourceResourceURI As String, ByVal DestinationResourceURI As String) As Task
Public Sub MoveResource(ByVal SourceResourceURI As String, ByVal DestinationResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

The MoveResource method will move the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

This method is associated with the Depth property. If Depth is set to "0", the component will move only SourceResourceURI. If Depth is set to "infinity", the component will move SourceResourceURI and its entire subtree to locations relative to it.

If the user has acquired a LockResource of infinite depth on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

PatchProperties Method (WebDAV Component)

Update the current set of properties on the server.

Syntax

• C#
• VB.NET

public void PatchProperties(string resourceURI);

Async Version
public async Task PatchProperties(string resourceURI);
public async Task PatchProperties(string resourceURI, CancellationToken cancellationToken);

Public Sub PatchProperties(ByVal ResourceURI As String)

Async Version
Public Sub PatchProperties(ByVal ResourceURI As String) As Task
Public Sub PatchProperties(ByVal ResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

When the user calls PatchProperties, the component will send a request to the server to update the existing property list. The method is linked to the Properties property: the component will use the Operation field to tell the server what to do with the properties.

PostToResource Method (WebDAV Component)

Posts data to a resource using the WebDAV POST method.

Syntax

• C#
• VB.NET

public void PostToResource(string resourceURI, byte[] postData);

Async Version
public async Task PostToResource(string resourceURI, byte[] postData);
public async Task PostToResource(string resourceURI, byte[] postData, CancellationToken cancellationToken);

Public Sub PostToResource(ByVal ResourceURI As String, ByVal PostData As String)

Async Version
Public Sub PostToResource(ByVal ResourceURI As String, ByVal PostData As String) As Task
Public Sub PostToResource(ByVal ResourceURI As String, ByVal PostData As String, cancellationToken As CancellationToken) As Task

Remarks

Posts data to the resource ResourceURI using the WebDAV POST method. The posted data is taken from PostData. The server response text is received through the Transfer event, and the HTTP response headers through the Header event. If LocalFile is not empty the data (not the headers) is written there as well.

PutResource Method (WebDAV Component)

Send data to the server using the PUT method.

Syntax

• C#
• VB.NET

public void PutResource(string resourceURI);

Async Version
public async Task PutResource(string resourceURI);
public async Task PutResource(string resourceURI, CancellationToken cancellationToken);

Public Sub PutResource(ByVal ResourceURI As String)

Async Version
Public Sub PutResource(ByVal ResourceURI As String) As Task
Public Sub PutResource(ByVal ResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

The data is taken from LocalFile. The server will normally require authentication for this operation, so User and Password must have valid values before the request is made.

Reset Method (WebDAV Component)

Reset the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method will reset the component's properties to their default values.

SetDownloadStream Method (WebDAV Component)

Sets the stream to which the downloaded data from the server will be written.

Syntax

• C#
• VB.NET

public void SetDownloadStream(System.IO.Stream downloadStream);

Async Version
public async Task SetDownloadStream(System.IO.Stream downloadStream);
public async Task SetDownloadStream(System.IO.Stream downloadStream, CancellationToken cancellationToken);

Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream)

Async Version
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) As Task
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

If a download stream is set before the GetResource method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

The component will automatically close this stream if CloseStreamAfterTransfer is true (default). If the stream is closed, you will need to call SetDownloadStream again before calling GetResource again.

The downloaded content will be written starting at the current position in the stream.

SetProperty Method (WebDAV Component)

Set the value of a property.

Syntax

• C#
• VB.NET

public void SetProperty(string propertyName, string propertyValue);

Async Version
public async Task SetProperty(string propertyName, string propertyValue);
public async Task SetProperty(string propertyName, string propertyValue, CancellationToken cancellationToken);

Public Sub SetProperty(ByVal PropertyName As String, ByVal PropertyValue As String)

Async Version
Public Sub SetProperty(ByVal PropertyName As String, ByVal PropertyValue As String) As Task
Public Sub SetProperty(ByVal PropertyName As String, ByVal PropertyValue As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used to set a single property to a certain value. The name and new value of the property must be supplied in the parameters for this method.

NOTE: This is the same as calling the PatchProperties on one property where the operation is opSet.

Example

Control.SetProperty("MyProperty", "MyValue")

is equivalent to: Control.Properties.Add(new DAVProperty()) Control.Properties[0].Name = "MyProperty" Control.Properties[0].Value = "MyValue" Control.Properties[0].Operation = DAVPropertyOperations.opSet Control.PatchProperties()

SetUploadStream Method (WebDAV Component)

Sets the stream to be uploaded to the server.

Syntax

• C#
• VB.NET

public void SetUploadStream(System.IO.Stream uploadStream);

Async Version
public async Task SetUploadStream(System.IO.Stream uploadStream);
public async Task SetUploadStream(System.IO.Stream uploadStream, CancellationToken cancellationToken);

Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream)

Async Version
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) As Task
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

If an upload stream is set before data is to be uploaded to the server, the content of the stream will be read by the component and uploaded to the server. The stream should be open and normally set to position 0.

The component will automatically close this stream if CloseStreamAfterTransfer is true (default). If the stream is closed, you will need to call SetUploadStream again before calling the PutResource/PostToResource again.

The content of the stream will be read from the current position all the way to the end and no bytes will be skipped.

UnLockResource Method (WebDAV Component)

Unlocks a resource.

Syntax

• C#
• VB.NET

public void UnLockResource(string resourceURI);

Async Version
public async Task UnLockResource(string resourceURI);
public async Task UnLockResource(string resourceURI, CancellationToken cancellationToken);

Public Sub UnLockResource(ByVal ResourceURI As String)

Async Version
Public Sub UnLockResource(ByVal ResourceURI As String) As Task
Public Sub UnLockResource(ByVal ResourceURI As String, cancellationToken As CancellationToken) As Task

Remarks

Before calling UnLockResource on a particular resource, the LockTokens property must be set to the lock tokens for ResourceURI. The method will remove the lock, allowing other users or non-privileged users to access and operate on the file.

Connected Event (WebDAV Component)

This event is fired immediately after a connection completes (or fails).

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, WebdavConnectedEventArgs e);

public class WebdavConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As WebdavConnectedEventArgs)

Public Class WebdavConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (WebDAV Component)

This event is fired to indicate changes in the connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, WebdavConnectionStatusEventArgs e);

public class WebdavConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As WebdavConnectionStatusEventArgs)

Public Class WebdavConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

DirList Event (WebDAV Component)

Fires for each entry returned in a directory listing.

Syntax

• C#
• VB.NET

public event OnDirListHandler OnDirList;

public delegate void OnDirListHandler(object sender, WebdavDirListEventArgs e);

public class WebdavDirListEventArgs : EventArgs {
  public string ResourceURI { get; }
  public string DisplayName { get; }
  public string ContentLanguage { get; }
  public string ContentLength { get; }
  public string ContentType { get; }
  public string LastModified { get; }
}

Public Event OnDirList As OnDirListHandler

Public Delegate Sub OnDirListHandler(sender As Object, e As WebdavDirListEventArgs)

Public Class WebdavDirListEventArgs Inherits EventArgs
  Public ReadOnly Property ResourceURI As String
  Public ReadOnly Property DisplayName As String
  Public ReadOnly Property ContentLanguage As String
  Public ReadOnly Property ContentLength As String
  Public ReadOnly Property ContentType As String
  Public ReadOnly Property LastModified As String
End Class

Remarks

The DirList event is fired when a directory listing is received as a response to ListDirectory.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

Disconnected Event (WebDAV Component)

This event is fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, WebdavDisconnectedEventArgs e);

public class WebdavDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As WebdavDisconnectedEventArgs)

Public Class WebdavDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (WebDAV Component)

Fired when a document finishes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, WebdavEndTransferEventArgs e);

public class WebdavEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As WebdavEndTransferEventArgs)

Public Class WebdavEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (WebDAV Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, WebdavErrorEventArgs e);

public class WebdavErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As WebdavErrorEventArgs)

Public Class WebdavErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (WebDAV Component)

This event is fired every time a header line comes in.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, WebdavHeaderEventArgs e);

public class WebdavHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As WebdavHeaderEventArgs)

Public Class WebdavHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (WebDAV Component)

This event fires once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, WebdavLogEventArgs e);

public class WebdavLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As WebdavLogEventArgs)

Public Class WebdavLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Redirect Event (WebDAV Component)

This event is fired when a redirection is received from the server.

Syntax

• C#
• VB.NET

public event OnRedirectHandler OnRedirect;

public delegate void OnRedirectHandler(object sender, WebdavRedirectEventArgs e);

public class WebdavRedirectEventArgs : EventArgs {
  public string Location { get; }
  public bool Accept { get; set; }
}

Public Event OnRedirect As OnRedirectHandler

Public Delegate Sub OnRedirectHandler(sender As Object, e As WebdavRedirectEventArgs)

Public Class WebdavRedirectEventArgs Inherits EventArgs
  Public ReadOnly Property Location As String
  Public Property Accept As Boolean
End Class

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the component throws an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

ResourceProperties Event (WebDAV Component)

Fires for each entry returned through a property search.

Syntax

• C#
• VB.NET

public event OnResourcePropertiesHandler OnResourceProperties;

public delegate void OnResourcePropertiesHandler(object sender, WebdavResourcePropertiesEventArgs e);

public class WebdavResourcePropertiesEventArgs : EventArgs {
  public string ResourceURI { get; }
  public string ResourceProperties { get; }
}

Public Event OnResourceProperties As OnResourcePropertiesHandler

Public Delegate Sub OnResourcePropertiesHandler(sender As Object, e As WebdavResourcePropertiesEventArgs)

Public Class WebdavResourcePropertiesEventArgs Inherits EventArgs
  Public ReadOnly Property ResourceURI As String
  Public ReadOnly Property ResourceProperties As String
End Class

Remarks

The ResourceProperties event is fired when resource properties are received as a response to FindProperties.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The ResourceProperties contains the full XML containing the properties of the resource.

ResourceURI contains the name of the resource.

The parsed property names, values, and status are contained within the Properties collection.

SetCookie Event (WebDAV Component)

This event is fired for every cookie set by the server.

Syntax

• C#
• VB.NET

public event OnSetCookieHandler OnSetCookie;

public delegate void OnSetCookieHandler(object sender, WebdavSetCookieEventArgs e);

public class WebdavSetCookieEventArgs : EventArgs {
  public string Name { get; }
  public string Value { get; }
  public string Expires { get; }
  public string Domain { get; }
  public string Path { get; }
  public bool Secure { get; }
}

Public Event OnSetCookie As OnSetCookieHandler

Public Delegate Sub OnSetCookieHandler(sender As Object, e As WebdavSetCookieEventArgs)

Public Class WebdavSetCookieEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property Value As String
  Public ReadOnly Property Expires As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property Secure As Boolean
End Class

Remarks

The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (WebDAV Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, WebdavSSLServerAuthenticationEventArgs e);

public class WebdavSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As WebdavSSLServerAuthenticationEventArgs)

Public Class WebdavSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (WebDAV Component)

Shows the progress of the secure connection.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, WebdavSSLStatusEventArgs e);

public class WebdavSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As WebdavSSLStatusEventArgs)

Public Class WebdavSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (WebDAV Component)

Fired when a document starts transferring (after the headers).

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, WebdavStartTransferEventArgs e);

public class WebdavStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As WebdavStartTransferEventArgs)

Public Class WebdavStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (WebDAV Component)

This event is fired when the HTTP status line is received from the server.

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, WebdavStatusEventArgs e);

public class WebdavStatusEventArgs : EventArgs {
  public string HTTPVersion { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As WebdavStatusEventArgs)

Public Class WebdavStatusEventArgs Inherits EventArgs
  Public ReadOnly Property HTTPVersion As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (WebDAV Component)

This event is fired while a document transfers (delivers document).

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, WebdavTransferEventArgs e);

public class WebdavTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As WebdavTransferEventArgs)

Public Class WebdavTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

DAVProperty Type

A property that is either sent to or received from the server.

Remarks

This type defines a property that is used when the component sends a property find or patch request to the server. When FindProperties is used, this property will be populated with the properties returned from the server. When a call is made to PatchProperties, the component will use the information provided by this type to tell the server what to do with the property being specified.

Fields

Constructors

• C#
• VB.NET

public DAVProperty();

Public DAVProperty()

• C#
• VB.NET

public DAVProperty(string name);

Public DAVProperty(ByVal Name As String)

DAVResource Type

A resource as returned in a directory listing from the WebDAV component.

Remarks

This type describes a resource that has been returned by the server during a response to a ListDirectory request. The DAVResource type contains fields which describe each listing as returned from the server.

Fields

Constructors

• C#
• VB.NET

public DAVResource();

Public DAVResource()

Firewall Type

This is the firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the Name and Value fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Constructors

• C#
• VB.NET

public HTTPCookie();

Public HTTPCookie()

• C#
• VB.NET

public HTTPCookie(string name, string value);

Public HTTPCookie(ByVal Name As String, ByVal Value As String)

Proxy Type

This is the proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

XMLNamespace Type

An XML namespace from the current namespace stack.

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the Prefix and the URI of the namespace being defined.

The default namespace exists at index 0. The Prefix field at index 0 is "xmlns", and the Name field contains the default namespace.

Fields

Constructors

• C#
• VB.NET

public XMLNamespace();

Public XMLNamespace()

• C#
• VB.NET

public XMLNamespace(string name, string prefix);

Public XMLNamespace(ByVal Name As String, ByVal Prefix As String)

Config Settings (WebDAV Component)

WebDAV Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (WebDAV Component)

WebDAV Errors

The component may also return one of the following error codes, which are inherited from other components.

HTTP Errors

The component may also return one of the following error codes, which are inherited from other components.

SSLClient Errors