This documentation is archived and is not being maintained.

SPFolder.WelcomePage Property

Windows SharePoint Services 3

Gets or sets the URL to which users are redirected when they browse to the folder.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

public string WelcomePage { get; set; }

Property Value

Type: System.String
A string that contains the URL to which users are redirected. For a wiki site, the string specifies a site-relative URL, for example, MyWikiFolder/MyWelcomePage.aspx, but for a wiki library, the string specifies a folder-relative URL, for example, MyWelcome.aspx.

The following example sets the site-relative URL of an item in a wiki library as the Welcome page that is used for the wiki site.

using (SPSite oSiteCollection = new SPSite("http://MyServer/sites/MyWikiSite"))
    SPWeb oWebsite = oSiteCollection.OpenWeb();
    SPFolder oFolder = oWebsite.RootFolder; 
    oFolder.WelcomePage = "My Wiki Library/MyWelcome.aspx";

Certain objects implement the IDisposable interface, and you must avoid retaining these objects in memory after they are no longer needed. For information about good coding practices, see Best Practices: Using Disposable Windows SharePoint Services Objects.