Set-RenderingParameter
Adds and updates the specified rendering parameter from the rendering.

Syntax

1
Set-RenderingParameter -Instance <RenderingDefinition> -Parameter <IDictionary> [-Overwrite]
Copied!

Detailed Description

Adds and updates the specified rendering parameter from the rendering.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Instance <RenderingDefinition>

Rendering definition containing the rendering parameters.
Aliases
Text
Required?
true
Position?
named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Parameter <IDictionary>

The hashtable or dictionary of key/value pairs used to add/update rendering parameters.
Aliases
Text
Required?
false
Position?
named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Overwrite <SwitchParameter>

Specifying this parameter will remove all existing rendering parameters and use the new collection provided.
Aliases
Text
Required?
false
Position?
named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.
  • Sitecore.Layouts.RenderingDefinition

Outputs

The output type is the type of the objects that the cmdlet emits.
  • Sitecore.Layouts.RenderingDefinition

Notes

Help Author: Adam Najmanowicz, Michael West

Examples

EXAMPLE

The following updates the specified rendering parameter and updates the item.
1
$item = Get-Item -Path "master" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
2
3
# Accepts Hashtable, Ordered Dictionaries, etc.
4
$parameters = [ordered]@{"SampleKey2"="SampleValue2"}
5
Get-Rendering -Item $item -FinalLayout |
6
Set-RenderingParameter -Parameter $parameters |
7
Set-Rendering -Item $item -FinalLayout
Copied!

Related Topics