Skip to content

Latest commit

 

History

History
160 lines (120 loc) · 3.35 KB

Set-PnPClientSidePage.md

File metadata and controls

160 lines (120 loc) · 3.35 KB
Raw
external help file applicable schema
SharePoint Online
2.0.0

Set-PnPClientSidePage

SYNOPSIS

Sets parameters of a Client-Side Page

SYNTAX

Set-PnPClientSidePage -Identity <ClientSidePagePipeBind>
                      [-Name <String>]
                      [-LayoutType <ClientSidePageLayoutType>]
                      [-PromoteAs <ClientSidePagePromoteType>]
                      [-CommentsEnabled [<SwitchParameter>]]
                      [-Publish [<SwitchParameter>]]
                      [-PublishMessage <String>]
                      [-Web <WebPipeBind>]
                      [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Set-PnPClientSidePage -Identity "MyPage" -LayoutType Home

Updates the properties of the Client-Side page named 'MyPage'

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

PS:> Set-PnPClientSidePage -Identity "MyPage" -CommentsEnabled

Enables the comments on the Client-Side page named 'MyPage'

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

PS:> Set-PnPClientSidePage -Identity "MyPage" -CommentsEnabled:$false

Disables the comments on the Client-Side page named 'MyPage'

PARAMETERS

-CommentsEnabled

Enables or Disables the comments on the page

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Identity

The name/identity of the page

Type: ClientSidePagePipeBind
Parameter Sets: (All)

Required: True
Position: 0
Accept pipeline input: True

-LayoutType

Sets the layout type of the page. (Default = Article)

Type: ClientSidePageLayoutType
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Name

Sets the name of the page.

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-PromoteAs

Allows to promote the page for a specific purpose (HomePage | NewsPage)

Type: ClientSidePagePromoteType
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Publish

Publishes the page once it is saved.

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-PublishMessage

Sets the message for publishing the page.

Type: String
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