Get and Update Welcome Page URL

In this Code Snippet, we will see about how to fetch and update the welcome page url from the web.

I have created a console application, which fetches and updates the welcome page url to the site using CSOM. For that, we have to add the Managed Client Object SharePoint dlls as reference to the project.

Microsoft.SharePoint.Client.dll

Microsoft.SharePoint.Client.Runtime.dll

After the references are added, insert the following snippet to the development area,

static void Main(string[] args)
{
ClientContext ctx = new ClientContext("https://sharepointsite");
ctx.Credentials = new System.Net.NetworkCredential("<User Name with Domain>", " <Password >");
Web web = ctx.Web;
//Fetch the Welcome Page URL from the given Web
GetHomePage(web);
//Update the Welcome Page URL to the given Web
string welcomePageURL = "sitepage/home.aspx";
UpdateHomePage(web, welcomePageURL);
}
/// <summary>
/// Update the welcome page to the website
/// </summary>
/// <param name="web">SharePoint COM Web Object</param>
/// <param name="welcomePageURL"> Relative URL</param>
private static void UpdateHomePage(Web web, string welcomePageURL)
{
ClientRuntimeContext ctx = web.Context;
var rootFolder = web.RootFolder;
rootFolder.WelcomePage = welcomePageURL;
rootFolder.Update();
ctx.ExecuteQuery();
Console.WriteLine("Welcome Page updated successfully.");
Console.Read();
}
/// <summary>
/// Get the welcome page for the websote
/// </summary>
/// <param name="web">SharePoint COM Web Object</param>
private static void GetHomePage(Web web)
{
ClientRuntimeContext ctx = web.Context;
Folder folder = web.RootFolder;
ctx.Load(folder);
ctx.ExecuteQuery();
Console.WriteLine("Welcome Page Relative URL: " + folder.WelcomePage.ToString());
Console.Read();
}

Hope, you have enjoyed the snipper