SPFolder.WelcomePage Property

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)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
<ClientCallableConstraintAttribute(Type := ClientCallableConstraintType.NotNull)> _
<ClientCallableAttribute> _
Public Property WelcomePage As String
    Get
    Set
'Usage
Dim instance As SPFolder
Dim value As String

value = instance.WelcomePage

instance.WelcomePage = value
[ClientCallableConstraintAttribute(Type = ClientCallableConstraintType.NotNull)]
[ClientCallableAttribute]
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.

Examples

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.

Dim siteCollection As New SPSite("http://MyServer/sites/MyWikiSite")
Try
    Dim webSite As SPWeb = siteCollection.OpenWeb()
    Dim folder As SPFolder = webSite.RootFolder
    folder.WelcomePage = "My Wiki Library/MyWelcome.aspx"
    folder.Update()
Finally
    siteCollection.Dispose()
End Try
using (SPSite oSiteCollection = new SPSite("http://MyServer/sites/MyWikiSite"))
{
    SPWeb oWebsite = oSiteCollection.OpenWeb();
    SPFolder oFolder = oWebsite.RootFolder; 
    oFolder.WelcomePage = "My Wiki Library/MyWelcome.aspx";
    oFolder.Update();
    oWebsite.Dispose();
}

Note

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 Disposing Objects.

See Also

Reference

SPFolder Class

SPFolder Members

Microsoft.SharePoint Namespace