Add a Button to the Visual Web Part

Oct 13, 2025 by talynt.org 7 views

Introduction

As a developer, you may encounter scenarios where you need to move a SharePoint folder from one site to another site. This can be a complex task, especially if you are new to SharePoint development. In this article, we will explore how to move a SharePoint folder from one site to another site using C#.

Prerequisites

Before we dive into the code, let's make sure you have the following prerequisites:

SharePoint Server 2013 or later
Visual Studio 2012 or later
SharePoint Client Side Object Model (CSOM) installed
Basic knowledge of C# and SharePoint development

Step 1: Create a Visual Web Part

To move a SharePoint folder from one site to another site, we will create a Visual Web Part that contains a button. When the button is clicked, it will move the folder to the new site.

Create a New Project

Open Visual Studio and create a new project. Select "Visual Web Part" under the "SharePoint" category.

Add a Button to the Visual Web Part

In the Visual Web Part designer, add a button to the page. You can do this by dragging and dropping a "Button" control from the toolbox onto the page.

Add a Click Event to the Button

Double-click the button to open the code behind. Add a click event to the button.

protected void Button1_Click(object sender, EventArgs e)
{
    // Move folder code will go here
}

Step 2: Get the Folder and Site Objects

To move the folder, we need to get the folder and site objects. We can do this using the SharePoint Client Side Object Model (CSOM).

Add a Reference to the SharePoint Client Side Object Model

Add a reference to the SharePoint Client Side Object Model (CSOM) to your project. You can do this by right-clicking on your project in the Solution Explorer and selecting "Add Reference". Then, browse to the location of the CSOM DLL and select it.

Get the Folder and Site Objects

In the code behind, add the following code to get the folder and site objects.

using Microsoft.SharePoint.Client;
protected void Button1_Click(object sender, EventArgs e)
{
// Get the site object
using (var clientContext = new ClientContext("https://your-sharepoint-site.com"))
{
// Get the folder object
var folder = clientContext.Web.GetFolderByServer("/sites/siteA/Documents/FolderToMove");
    // Get the destination site object
    var destinationSite = clientContext.Site;

    // Move the folder to the destination site
    MoveFolder(folder, destinationSite);
}

}
private void MoveFolder(Folder folder, Site destinationSite)
{
// Get the destination folder
var destinationFolder = destinationSite.RootWeb.GetFolderByServer("/sites/siteB/Documents/NewFolder");
// Move the folder
folder.MoveTo(destinationFolder.ServerRelativeUrl);

}

Step 3: Move the Folder

Now that we have the folder and site objects, we can move the folder to the new site.

Move the Folder

In the MoveFolder method, we get the destination folder and move the folder to the new site.

private void MoveFolder(Folder folder, Site destinationSite)
{
    // Get the destination folder
    var destinationFolder = destinationSite.RootWeb.GetFolderByServer("/sites/siteB/Documents/NewFolder");
// Move the folder
folder.MoveTo(destinationFolder.ServerRelativeUrl);

}

Step 4: Update the Folder Permissions

After moving the folder, we need to update the folder permissions.

Update the Folder Permissions

In the MoveFolder method, we update the folder permissions.

private void MoveFolder(Folder folder, Site destinationSite)
{
    // Get the destination folder
    var destinationFolder = destinationSite.RootWeb.GetFolderByServer("/sites/siteB/Documents/NewFolder");
// Move the folder
folder.MoveTo(destinationFolder.ServerRelativeUrl);

// Update the folder permissions
var permissions = folder.ListItem.AllProperties;
foreach (var permission in permissions)
{
    permission.Value = permission.Value;
}

}

Step 5: Test the Code

Now that we have the code, let's test it.

Test the Code

Open the Visual Web Part in the browser and click the button. The folder should be moved to the new site.

Conclusion

In this article, we explored how to move a SharePoint folder from one site to another site using C#. We created a Visual Web Part that contains a button. When the button is clicked, it moves the folder to the new site. We used the SharePoint Client Side Object Model (CSOM) to get the folder and site objects and move the folder. We also updated the folder permissions after moving the folder.

Additional Resources

Code Download

You can download the code from the following link:

Download Code

Note: Replace your-github-username with your actual GitHub username.

Discussion

If you have any questions or need further assistance, please feel free to ask in the comments section below.

Introduction

In our previous article, we explored how to move a SharePoint folder from one site to another site using C#. We created a Visual Web Part that contains a button. When the button is clicked, it moves the folder to the new site. We used the SharePoint Client Side Object Model (CSOM) to get the folder and site objects and move the folder. We also updated the folder permissions after moving the folder.

Q&A

Q: What is the SharePoint Client Side Object Model (CSOM)?

A: The SharePoint Client Side Object Model (CSOM) is a set of APIs that allows developers to interact with SharePoint from client-side applications. It provides a way to access and manipulate SharePoint data, such as lists, libraries, and sites.

Q: What is a Visual Web Part?

A: A Visual Web Part is a type of SharePoint web part that allows developers to create custom web parts using Visual Studio. It provides a way to create web parts that can be used in SharePoint pages.

Q: How do I get the folder and site objects using CSOM?

A: To get the folder and site objects using CSOM, you need to create a ClientContext object and use it to get the folder and site objects. You can do this by using the GetFolderByServer method to get the folder object and the GetSite method to get the site object.

Q: How do I move the folder to the new site?

A: To move the folder to the new site, you need to use the MoveTo method to move the folder to the new site. You can do this by passing the destination folder's ServerRelativeUrl to the MoveTo method.

Q: How do I update the folder permissions after moving the folder?

A: To update the folder permissions after moving the folder, you need to use the ListItem.AllProperties property to get the folder's permissions and then update them.

Q: What are the benefits of using CSOM to move a SharePoint folder?

A: The benefits of using CSOM to move a SharePoint folder include:

Improved performance: CSOM is a client-side API, which means it can improve performance by reducing the amount of data that needs to be transferred between the client and server.
Simplified development: CSOM provides a simple and intuitive API for interacting with SharePoint data, making it easier to develop custom SharePoint solutions.
Flexibility: CSOM allows developers to create custom SharePoint solutions that can be used in a variety of scenarios, such as moving folders between sites.

Q: What are the limitations of using CSOM to move a SharePoint folder?

A: The limitations of using CSOM to move a SharePoint folder include:

Limited functionality: CSOM is a client-side API, which means it may not provide access to all of the functionality that is available through the SharePoint server-side API.
Security restrictions: CSOM may be subject to security restrictions, such as authentication and authorization requirements, that can limit its functionality.
Compatibility issues: CSOM may not be compatible with all versions of SharePoint, which can limit its use in certain scenarios.

Q: How do I troubleshoot issues with CSOM?

A: To troubleshoot issues with CSOM, you can use the following steps:

Check the CSOM documentation: The CSOM documentation provides a wealth of information about how to use the API, including examples and troubleshooting tips.
Use the CSOM debugger: The CSOM debugger provides a way to step through the code and see what is happening at runtime.
Use the SharePoint ULS logs: The SharePoint ULS logs provide a way to see what is happening at runtime, including any errors that may be occurring.

Conclusion

In this article, we answered some of the most frequently asked questions about moving a SharePoint folder from one site to another site using C#. We covered topics such as the SharePoint Client Side Object Model (CSOM), Visual Web Parts, and troubleshooting issues with CSOM. We hope this article has been helpful in answering your questions and providing you with the information you need to move a SharePoint folder from one site to another site using C#.