Get-Rendering
Returns a RenderingDefinition for an item using the filtering parameters.
Get-Rendering -Item <Item> [-DataSource <String>] [-Rendering <Item>] [-Index <Int32>] [-PlaceHolder <String>] [-Parameter <Hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]​Get-Rendering -Item <Item> -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]​Get-Rendering -Item <Item> -UniqueId <String> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]​Get-Rendering -Path <String> [-DataSource <String>] [-Rendering <Item>] [-Index <Int32>] [-PlaceHolder <String>] [-Parameter <Hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]​Get-Rendering -Path <String> -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]​Get-Rendering -Path <String> -UniqueId <String> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]​Get-Rendering [-Id <String>] [-Database <String>] [-DataSource <String>] [-Rendering <Item>] [-Index <Int32>] [-PlaceHolder <String>] [-Parameter <Hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]​Get-Rendering [-Id <String>] [-Database <String>] -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]​Get-Rendering [-Id <String>] [-Database <String>] -UniqueId <String> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
The Get-Rendering command returns a RenderingDefinition for an item using the filtering parameters.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
The item to be processed.
Aliases | ​ |
Required? | true |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | true (ByValue, ByPropertyName) |
Accept Wildcard Characters? | false |
Path to the item to be processed - can work with Language parameter to narrow the publication scope.
Aliases | ​ |
Required? | true |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Id of the item to be processed - can work with Language parameter to narrow the publication scope.
Aliases | ​ |
Required? | false |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
Aliases | ​ |
Required? | false |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Data source filter - supports wildcards.
Aliases | ​ |
Required? | false |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Item representing the sublayout/rendering. If matching the rendering will be returned.
Aliases | ​ |
Required? | false |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Index at which the rendering exists in the layout. The rendering at that index will be returned.
Aliases | ​ |
Required? | false |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Place holder at which the rendering exists in the layout. Renderings at that place holder will be returned.
Aliases | ​ |
Required? | false |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Additional rendering parameter values. If both name and value match - the rendering will be returned. Values support wildcards.
Aliases | ​ |
Required? | false |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Specific instance of rendering that should be returned. The instance could earlier be obtained through e.g. use of Get-Rendering.
Aliases | ​ |
Required? | true |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
UniqueID of the rendering to be retrieved.
Aliases | ​ |
Required? | true |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Device for which the renderings will be retrieved.
Aliases | ​ |
Required? | false |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Targets the Final Layout. If not provided, the Shared Layout will be targeted. Applies to Sitecore 8.0 and higher only.
Aliases | ​ |
Required? | false |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Aliases | ​ |
Required? | false |
Position? | named |
Default Value | ​ |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
The input type is the type of the objects that you can pipe to the cmdlet.
Sitecore.Data.Items.Item
The output type is the type of the objects that the cmdlet emits.
Sitecore.Layouts.RenderingDefinition
Help Author: Adam Najmanowicz, Michael West
Get all renderings for "Default" device, located in the any placeholder that has name in it or any of its sub-placeholders.
Get-Item master:\content\home |Get-Rendering -Placeholder "*main*" -Device (Get-LayoutDevice "Default")
The following example returns all renderings on the home page.
$item = Get-Item -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"$defaultLayout = Get-LayoutDevice "Default"Get-Rendering -Item $item -Device $defaultLayout -FinalLayout
​Add-Rendering​
​New-Rendering​
​Set-Rendering​
​Get-LayoutDevice​
​Remove-Rendering​
​Get-Layout​
​Set-Layout​
