Switches an existing rendering with an alternate one to a chosen device for the presentation of an item.
Switch-Rendering -NewRendering <RenderingDefinition> -Item <Item> [-DataSource <string>] [-Rendering <Item>] [-Index <int>] [-PlaceHolder <string>] [-Parameter <hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Switch-Rendering -NewRendering <RenderingDefinition> -Item <Item> -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm][<CommonParameters>]
Switch-Rendering -NewRendering <RenderingDefinition> -Item <Item> -UniqueId <string> [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Switch-Rendering -NewRendering <RenderingDefinition> -Path <string> [-DataSource <string>] [-Rendering <Item>] [-Index <int>] [-PlaceHolder <string>] [-Parameter <hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Switch-Rendering -NewRendering <RenderingDefinition> -Path <string> -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Switch-Rendering -NewRendering <RenderingDefinition> -Path <string> -UniqueId <string> [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Switch-Rendering -NewRendering <RenderingDefinition> [-Id <string>] [-Database <string>] [-DataSource <string>] [-Rendering <Item>] [-Index <int>] [-PlaceHolder <string>] [-Parameter <hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Switch-Rendering -NewRendering <RenderingDefinition> -Instance <RenderingDefinition> [-Id <string>] [-Database <string>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Switch-Rendering -NewRendering <RenderingDefinition> -UniqueId <string> [-Id <string>] [-Database <string>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Switches an existing rendering with an alternate one to a chosen device for the presentation of an item.
© 2010-2022 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
Existing rendering definition to be swapped on the item
Aliases | |
---|---|
Required? | true |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
New rendering definition to be swapped on the item
Aliases | |
---|---|
Required? | true |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Rendering Parameters to be overriden on the Rendering that is being updated - if not specified the value provided in rendering definition specified in the Instance parameter will be used.
Aliases | |
---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Placeholder path the Rendering should be added to - if not specified the value provided in rendering definition specified in the Instance parameter will be used.
Aliases | |
---|---|
Required? | true |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Data source of the Rendering - if not specified the value provided in rendering definition specified in the Instance parameter will be used.
Aliases | |
---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Index at which the Rendering should be inserted. If not provided the rendering will be appended at the end of the list.
Aliases | |
---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Device the rendering is assigned to. If not specified - default device will be used.
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 item to be processed.
Aliases | |
---|---|
Required? | true |
Position? | 1 |
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? | 1 |
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? | true |
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 |
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.
- System.Void
Help Author: Adam Najmanowicz, Michael West
Switch an old rendering for the new.
$itemId = "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
$item = Get-Item -Path "master:" -ID $itemId
$defaultLayout = Get-LayoutDevice "Default"
$sourceRenderingId = "{37F58448-7460-4AD2-B0FB-67C85C2A49CB}"
$targetRenderingId = "{90A9C167-5714-481F-82E4-29E394D12614}"
$sourceRenderings = Get-Rendering -Item $item -Device $defaultLayout -FinalLayout |
Where-Object { $_.ItemID -eq $sourceRenderingId }
$targetRendering = Get-Item -Path "master:" -ID $targetRenderingId | New-Rendering
# Replace all instances of the old rendering with the new rendering
foreach($sourceRendering in $sourceRenderings) {
$item | Switch-Rendering -Instance $sourceRendering -Device $defaultLayout -FinalLayout -NewRendering $targetRendering
}
- #1110 Switch-Rendering added in 6.0
- New-Rendering
- Set-Rendering
- Get-Rendering
- Get-LayoutDevice
- Remove-Rendering
- Get-Layout
- Set-Layout