LEADTOOLS SharePoint Client (Leadtools.SharePoint.Client assembly)
Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.5.11.1
| Leadtools.SharePoint.Client Namespace > SharePointClient Class : UploadCompleted Event |
public event EventHandler<SharePointClientUploadCompletedEventArgs> UploadCompleted
'Declaration Public Event UploadCompleted As EventHandler(Of SharePointClientUploadCompletedEventArgs)
'Usage Dim instance As SharePointClient Dim handler As EventHandler(Of SharePointClientUploadCompletedEventArgs) AddHandler instance.UploadCompleted, handler
public event EventHandler<SharePointClientUploadCompletedEventArgs> UploadCompleted
add_UploadCompleted(function(sender, e)) remove_UploadCompleted(function(sender, e))
public: event EventHandler<SharePointClientUploadCompletedEventArgs^>^ UploadCompleted
The event handler receives an argument of type SharePointClientUploadCompletedEventArgs containing data related to this event. The following SharePointClientUploadCompletedEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| Cancelled (Inherited from System.ComponentModel.AsyncCompletedEventArgs) | Gets a value indicating whether an asynchronous operation has been canceled. |
| DestinationPath | Gets the destination path on the SharePoint server. |
| Error (Inherited from System.ComponentModel.AsyncCompletedEventArgs) | Gets a value indicating which error occurred during an asynchronous operation. |
| SiteUri | Gets the SharePoint server site URI. |
| SourceFileName | Gets the source file name. |
| SourceStream | Gets the source stream. |
| UserState (Inherited from System.ComponentModel.AsyncCompletedEventArgs) | Gets the unique identifier for the asynchronous task. |
The SharePointClient class supports uploading an item asynchronously through UploadFileAsync and UploadStreamAsync. When you call these methods, control returns instantly to your program and the Leadtools.SharePoint.Client.SharePointClient.UploadCompleted event will occur when the upload operation is completed (successfully or when an error occur).
Note that the SharePointClientUploadCompletedEventArgs derives from the standard .NET System.ComponentModel.AsyncCompletedEventArgs class and adds properties specified to SharePoint upload support.
When the upload operation is completed, the Leadtools.SharePoint.Client.SharePointClient.UploadCompleted event will receive an object of type SharePointClientUploadCompletedEventArgs containing the operation result as following:
| Property | Value |
|---|---|
| SourceFileName |
The source file name. This is the same value as the sourceFileName parameter passed to UploadFileAsync if this method is used to initiate the upload operation. If UploadStreamAsync was used instead, then the value of this property will be null ( Nothing in Visual Basic) |
| SourceStream |
The source stream. This is the same value as the sourceStream parameter passed to UploadStreamAsync if this method is used to initiate the upload operation. If UploadFileAsync was used instead, then the value of this property will be null ( Nothing in Visual Basic) |
| SiteUri |
The Share Point server site URI. This is the same value as the siteUri parameter passed to UploadFileAsync or UploadStreamAsync. |
| DestinationPath |
The destination path. This is the same value as the destinationPath parameter passed to UploadFileAsync or UploadStreamAsync. |
| System.ComponentModel.AsyncCompletedEventArgs.Error |
Gets a value that indicates which error occurred during the asynchronous upload operation. If an exception is raised during the asynchronous upload operation, the class will assign the exception to the System.ComponentModel.AsyncCompletedEventArgs.Error property. The client application's event-handler delegate should check the System.ComponentModel.AsyncCompletedEventArgs.Error property before accessing any properties in SharePointClientUploadCompletedEventArgs. The value of the System.ComponentModel.AsyncCompletedEventArgs.Error property is null (Nothing in Visual Basic) if the operation was canceled |
| System.ComponentModel.AsyncCompletedEventArgs.UserState |
Gets the unique identifier for the asynchronous upload operation. The value of this property is the same as the userState parameter passed to UploadFileAsync or UploadStreamAsync. |
| System.ComponentModel.AsyncCompletedEventArgs.Cancelled |
true if the asynchronous upload operation has been canceled; otherwise, false. This class does not change the value of this property from the default value of false |
For an example, refer to UploadFileAsync or UploadStreamAsync.
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2