|
|
Set-SPContentQueryWebPartTarget
Retargets a Content Query web part (do not provide list or site if you wish to show items from all sites in the containing site collection). Set-SPContentQueryWebPartTarget -WebPartId <String> -Site <SPSitePipeBind> -File <SPFilePipeBind> [-ListType [<String>]] [-Publish [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]] Set-SPContentQueryWebPartTarget -WebPartId <String> -List <SPListPipeBind> [-Web [<SPWebPipeBind>]] -File <SPFilePipeBind> [-ListType [<String>]] [-Publish [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]] Set-SPContentQueryWebPartTarget -WebPartTitle <String> -AllMatching <SwitchParameter> -Site <SPSitePipeBind> -File <SPFilePipeBind> [-ListType [<String>]] [-Publish [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]] Set-SPContentQueryWebPartTarget -WebPartTitle <String> -AllMatching <SwitchParameter> -List <SPListPipeBind> [-Web [<SPWebPipeBind>]] -File <SPFilePipeBind> [-ListType [<String>]] [-Publish [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]] Parameters1 | Parameter | Required | Type | Description |
|---|
| WebPartId | True | String | The ID of the Web Part to update. | | Site | True | SPSitePipeBind | Specifies the URL or GUID of the Site to show items from. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. | | File | True | SPFilePipeBind | The URL to a web part page or an instance of an SPFile object. | | ListType | False | String | The list type, or template, to show items from. | | Publish | False | SwitchParameter | If specified the page will be published after adjusting the Web Part. | | AssignmentCollection | False | SPAssignmentCollection | 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 | Parameter | Required | Type | Description |
|---|
| WebPartId | True | String | The ID of the Web Part to update. | | List | True | SPListPipeBind | The list to point the CQWP to. | | Web | False | SPWebPipeBind | The web containing the list. This parameter is required if the List parameter is a relative URL to a list. | | File | True | SPFilePipeBind | The URL to a web part page or an instance of an SPFile object. | | ListType | False | String | The list type, or template, to show items from. | | Publish | False | SwitchParameter | If specified the page will be published after adjusting the Web Part. | | AssignmentCollection | False | SPAssignmentCollection | 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. |
3 | Parameter | Required | Type | Description |
|---|
| WebPartTitle | True | String | The title of the Web Part to update. | | AllMatching | True | SwitchParameter | If more than one Content Query Web Part is found matching the title then update all matches. If not specified then an exception is thrown. | | Site | True | SPSitePipeBind | Specifies the URL or GUID of the Site to show items from. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. | | File | True | SPFilePipeBind | The URL to a web part page or an instance of an SPFile object. | | ListType | False | String | The list type, or template, to show items from. | | Publish | False | SwitchParameter | If specified the page will be published after adjusting the Web Part. | | AssignmentCollection | False | SPAssignmentCollection | 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. |
4 | Parameter | Required | Type | Description |
|---|
| WebPartTitle | True | String | The title of the Web Part to update. | | AllMatching | True | SwitchParameter | If more than one Content Query Web Part is found matching the title then update all matches. If not specified then an exception is thrown. | | List | True | SPListPipeBind | The list to point the CQWP to. | | Web | False | SPWebPipeBind | The web containing the list. This parameter is required if the List parameter is a relative URL to a list. | | File | True | SPFilePipeBind | The URL to a web part page or an instance of an SPFile object. | | ListType | False | String | The list type, or template, to show items from. | | Publish | False | SwitchParameter | If specified the page will be published after adjusting the Web Part. | | AssignmentCollection | False | SPAssignmentCollection | 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 DescriptionRetargets a Content Query web part (do not provide list or site if you wish to show items from all sites in the containing site collection). 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------------------ PS C:\> Set-SPContentQueryWebPartTarget -List "http://server_name/lists/mylist" -File "http://server_name/pages/default.aspx" -WebPartTitle "My CQWP" -AllMatching -Publish |