Remove-Rendering
Removes renderings from an item.
Syntax
Detailed Description
Removes renderings from an item based on a number of qualifying criteria. The search criteria are cumulative and narrowing the search in an "AND" manner.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
Parameters
-Item <Item>
The item to be processed.
-Path <String>
Path to the item to be processed - can work with Language parameter to narrow the publication scope.
-Id <String>
Id of the item to be processed - can work with Language parameter to narrow the publication scope.
-Database <String>
Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
-DataSource <String>
Data source filter - supports wildcards.
-Rendering <Item>
Item representing the sublayout/rendering. If matching the rendering will be removed.
-Index <Int32>
Index at which the rendering exists in the layout. The rendering at that index will be removed.
-PlaceHolder <String>
Place holder at which the rendering exists in the layout. Rendering at that placeholder will be removed.
-Parameter <Hashtable>
Additional rendering parameter values. If both name and value match - the rendering will be removed. Values support wildcards.
-Instance <RenderingDefinition>
Specific instance of rendering that should be removed. The instance coule earlier be obtained through e.g. use of Get-Rendering.
-UniqueId <String>
UniqueID of the rendering to be removed. The instance coule earlier be obtained through e.g. use of OD of rendering retrieved with Get-Rendering.
-Device <DeviceItem>
Device for which the rendering should be removed.
-FinalLayout <SwitchParameter>
Targets the Final Layout. If not provided, the Shared Layout will be targeted. Applies to Sitecore 8.0 and higher only.
-Language <String[]>
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Sitecore.Data.Items.Item
Outputs
The output type is the type of the objects that the cmdlet emits.
System.Void
Notes
Help Author: Adam Najmanowicz, Michael West
Examples
EXAMPLE 1
remove all renderings for "Default" device
EXAMPLE 2
remove all renderings from the "main" placeholder and all of its embedded placeholders.
EXAMPLE 3
remove all renderings from the "main" placeholder and all of its embedded placeholders, but only in the "Default" device
Related Topics
Last updated