Get-SPWebPartList

Retrieves a listing of web parts on a page in XML format.

Get-SPWebPartList -Manager <SPLimitedWebPartManagerPipeBind> [-Minimal [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Get-SPWebPartList -File <SPFilePipeBind> [-Minimal [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Parameters

1

ParameterRequiredTypeDescription
ManagerTrueSPLimitedWebPartManagerPipeBind

The URL to a web part page or an instance of an SPLimitedWebPartManager object.

MinimalFalseSwitchParameter

Retrieves a minimal XML listing of the web parts on the page.

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

2

ParameterRequiredTypeDescription
FileTrueSPFilePipeBind

The URL to a web part page or an instance of an SPFile object.

MinimalFalseSwitchParameter

Retrieves a minimal XML listing of the web parts on the page.

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Detailed Description

Retrieves a listing of web parts on a page in XML format.

Copyright 2016 Falchion Consulting, LLC

> For more information on this cmdlet and others:

> http://blog.falchionconsulting.com/

> Use of this cmdlet is at your own risk.

> Gary Lapointe assumes no liability.

Examples

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

PS C:\> $xml = Get-SPWebPartList -File "http://portal/pages/default.aspx"

This example retrieves a listing of web parts associated with the page http://portal/pages/default.aspx.

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

PS C:\> $xml = Get-SPLimitedWebPartManager "http://portal/pages/default.aspx" | Get-SPWebPartList

This example retrieves a listing of web parts associated with the page http://portal/pages/default.aspx.