New-PlaceholderSetting
Creates new placeholder setting definition that can later be added to an item.

Syntax

1
New-PlaceholderSetting [-Item] <Item> [-Key <string>] [-Language <string[]>]
2
3
New-PlaceholderSetting [-Path] <string> [-Key <string>] [-Language <string[]>]
4
5
New-PlaceholderSetting -Id <string> [-Key <string>] [-Language <string[]>] [-Database <string>]
Copied!

Detailed Description

Creates new placeholder setting definition that can later be added to an item. Most parameters can later be overriden when calling Add-PlaceholderSetting.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Database <string>

Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
Aliases
None
Required?
false
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Id <string>

Id of the item to be processed - can work with Language parameter to narrow the publication scope.
Aliases
None
Required?
true
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Item <Item>

The item to be processed.
Aliases
None
Required?
true
Position?
0
Default Value
Accept Pipeline Input?
true (ByValue, ByPropertyName)
Accept Wildcard Characters?
false

-Key <string>

The key for this placeholder setting.
Aliases
None
Required?
false
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Language <string[]>

Language that will be used as source language. If not specified the current user language will be used. Globbing/wildcard supported.
Aliases
Languages
Required?
false
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Path <string>

Path to the item to be processed - can work with Language parameter to narrow the publication scope.
Aliases
FullName, FileName
Required?
true
Position?
0
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.Data.Items.Item

Outputs

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

Examples

EXAMPLE 1

Create item defining placeholder setting
1
$placeholderSetting = gi "master:\layout\Placeholder Settings\content" | New-PlaceholderSetting -Key "content"
Copied!

Related Topics