Skip to content

Latest commit

 

History

History
144 lines (105 loc) · 3.32 KB

Set-PnPTheme.md

File metadata and controls

144 lines (105 loc) · 3.32 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Set-PnPTheme

SYNOPSIS

Sets the theme of the current web.

SYNTAX

Set-PnPTheme [-ColorPaletteUrl <String>]
             [-FontSchemeUrl <String>]
             [-BackgroundImageUrl <String>]
             [-ResetSubwebsToInherit [<SwitchParameter>]]
             [-UpdateRootWebOnly [<SwitchParameter>]]
             [-Web <WebPipeBind>]
             [-Connection <SPOnlineConnection>]

DESCRIPTION

Sets the theme of the current web, if any of the attributes is not set, that value will be set to null

EXAMPLES

------------------EXAMPLE 1------------------

PS:> Set-PnPTheme

Removes the current theme and resets it to the default.

------------------EXAMPLE 2------------------

PS:> Set-PnPTheme -ColorPaletteUrl /_catalogs/theme/15/company.spcolor

------------------EXAMPLE 3------------------

PS:> Set-PnPTheme -ColorPaletteUrl /_catalogs/theme/15/company.spcolor -BackgroundImageUrl '/sites/Team Site/style library/background.png'

------------------EXAMPLE 4------------------

PS:> Set-PnPTheme -ColorPaletteUrl /_catalogs/theme/15/company.spcolor -BackgroundImageUrl '/sites/Team Site/style library/background.png' -ResetSubwebsToInherit

Sets the theme to the web, and updates all subwebs to inherit the theme from this web.

PARAMETERS

-BackgroundImageUrl

Specifies the Background Image Url based on the server relative url

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-ColorPaletteUrl

Specifies the Color Palette Url based on the site relative url

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-FontSchemeUrl

Specifies the Font Scheme Url based on the server relative url

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-ResetSubwebsToInherit

Resets subwebs to inherit the theme from the rootweb

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-UpdateRootWebOnly

Updates only the rootweb, even if subwebs are set to inherit the theme.

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Connection

Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type: WebPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices