Skip to content

Latest commit

 

History

History
95 lines (70 loc) · 2.38 KB

Get-PnPAvailableClientSideComponents.md

File metadata and controls

95 lines (70 loc) · 2.38 KB
external help file applicable schema
SharePoint Online
2.0.0

Get-PnPAvailableClientSideComponents

SYNOPSIS

Gets the available client side components on a particular page

SYNTAX

Get-PnPAvailableClientSideComponents -Page <ClientSidePagePipeBind>
                                     [-Component <ClientSideComponentPipeBind>]
                                     [-Web <WebPipeBind>]
                                     [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Get-PnPAvailableClientSideComponents -Page "MyPage.aspx"

Gets the list of available client side components on the page 'MyPage.aspx'

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

PS:> Get-PnPAvailableClientSideComponents $page

Gets the list of available client side components on the page contained in the $page variable

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

PS:> Get-PnPAvailableClientSideComponents -Page "MyPage.aspx" -ComponentName "HelloWorld"

Gets the client side component 'HelloWorld' if available on the page 'MyPage.aspx'

PARAMETERS

-Component

Specifies the component instance or Id to look for.

Type: ClientSideComponentPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Page

The name of the page.

Type: ClientSidePagePipeBind
Parameter Sets: (All)

Required: True
Position: 0
Accept pipeline input: True

-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