SPWeb.ApplyTheme method (String)

  • Article

NOTE: This API is now obsolete.

Applies a theme to a website.

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

Syntax

'Declaration
<ObsoleteAttribute("This method applies to SharePoint 2007 theming and is no longer functional",  _
    False)> _
Public Sub ApplyTheme ( _
    strNewTheme As String _
)
'Usage
Dim instance As SPWeb
Dim strNewTheme As String

instance.ApplyTheme(strNewTheme)

[ObsoleteAttribute("This method applies to SharePoint 2007 theming and is no longer functional", 
    false)]
public void ApplyTheme(
    string strNewTheme
)

Parameters

  • strNewTheme
    Type: System.String

    The template ID of the new theme that is specified in the SpThemes.xml file of the \\ProgramFiles\Common Files\Microsoft Shared\web server extensions\14\Template\Layouts\1033 folder.

Remarks

Warning

Use this method only when the UI is in backward compatibility mode (SPWeb.UIVersion = 3).

This method sets the Theme property to the name of the theme specified by strNewTheme.

Examples

The following code example applies a specified theme to a site in the current site collection.

Using webSite As SPWeb = SPContext.Current.Site.OpenWeb("Website_URL")
    webSite.ApplyTheme("Theme_ID")
End Using

using (SPWeb oWebsite = SPContext.Current.Site.OpenWeb("Website_URL"))
{
    oWebsite.ApplyTheme("Theme_ID");
}

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

SPWeb class

SPWeb members

ApplyTheme overload

Microsoft.SharePoint namespace