UploadFile Method

Summary

Uploads an item in a disk file to a SharePoint server folder.

Syntax

C++/CLI

Python

public void UploadFile( 
   string sourceFileName, 
   Uri siteUri, 
   string destinationPath 
)

public: 
void UploadFile(  
   String^ sourceFileName, 
   Uri^ siteUri, 
   String^ destinationPath 
)

def UploadFile(self,sourceFileName,siteUri,destinationPath):

Parameters

sourceFileName
The file containing the item data to upload. This value cannot be null (Nothing in VB) and must contain the location of an existing file on disk.

siteUri
Full URL to the destination SharePoint site. This could be http://MySite or http://MySiteCollection/MySite. This value cannot be null (Nothing in VB).

destinationPath
Destination path (folder and file name) of the item to be created in the SharePoint server. See the remarks section for more information. This value cannot be null (Nothing in VB).

Remarks

This method will upload the content of sourceFileName to SharePoint server. The location and name of the destination item in the server is determined as follows:

DestinationFileFullUrl = siteUri + destinationPath

For example, assume the SharePoint server contains a folder with the following name:

http://site/Shared Documents/

And you want the uploaded item with the name File.ext into this folder. You can perform this using this code:

Uri siteUri = new Uri(@"http://site"); 
string destinationPath = @"Shared Documents/File.ext"; 
sharePointClientObject.UploadFile(sourceFileName, siteUri, destinationPath);

You can use the .NET System.IO.Path and System.UriBuilder classes to build the path and URI of the items. No that destinationPath is allowed to contain slashes (/) as in HTTP URI's or forward slashes (\) as in Windows paths or a mix of both.

This method will not return until the item is finished uploading to the server. If an error occurs, this method will throw an exception.

To upload a file asynchronously, use UploadFileAsync.

To upload the data in a stream to the server, use UploadStream or UploadStreamAsync.

To down an item from SharePoint, use DownloadFile, DownloadFileAsync, GetDownloadStream or GetDownloadStreamAsync.

Example

This example will upload an image file to SharePoint.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.SharePoint.Client; 
 
 
public void SharePointClientUploadFileExample() 
{ 
   string sourceFileName = LEAD_VARS.ImagesDir + @"\Ocr1.tif"; 
 
   // Replace SHAREPOINT_SITE_URI with a valid URL to a SharePoint site, for example 
   // http://SiteCollection/MySite 
   Uri siteUri = new Uri(SHAREPOINT_SITE_URI); 
 
   // Replace SHAREPOINT_FOLDER_NAME with a valid folder on the site above, for example 
   // "Documents" or "Documents\Sub Documents" 
   string folderName = SHAREPOINT_FOLDER_NAME; 
 
   SharePointClient spClient = new SharePointClient(); 
   spClient.OverwriteExistingFiles = true; 
 
   // Optional: Set the credentials: 
   spClient.Credentials = new NetworkCredential(USER_NAME, PASSWORD, DOMAIN); 
 
   // Build the upload document full path (folder + file name) 
   string destinationPath = Path.Combine(folderName, Path.GetFileName(sourceFileName)); 
 
   // Upload the document 
   spClient.UploadFile(sourceFileName, siteUri, destinationPath); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

SharePointClient Class

SharePointClient Members

Download our FREE evaluation

Help Version 22.0.2023.3.31

Leadtools.SharePoint.Client Assembly

Introduction

Getting Started

Namespaces

Leadtools.SharePoint.Client Namespace

Assemblies