Set-ItemTemplate

Sets the item template.

Syntax

Set-ItemTemplate -Item <Item> -TemplateItem <TemplateItem> [-FieldsToCopy <Hashtable>]
Set-ItemTemplate -Item <Item> -Template <String> [-FieldsToCopy <Hashtable>]
Set-ItemTemplate -Path <String> -TemplateItem <TemplateItem> [-FieldsToCopy <Hashtable>]
Set-ItemTemplate -Path <String> -Template <String> [-FieldsToCopy <Hashtable>]
Set-ItemTemplate -Id <String> -TemplateItem <TemplateItem> [-FieldsToCopy <Hashtable>]
Set-ItemTemplate -Id <String> -Template <String> [-FieldsToCopy <Hashtable>]
Set-ItemTemplate [-Database <String>] [-FieldsToCopy <Hashtable>]

Detailed Description

The Set-ItemTemplate command sets the template for an item.

© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Item <Item>

The item to set the template for.

Aliases

Required?

true

Position?

named

Default Value

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Path <String>

Path to the item to set the template for.

Aliases

Required?

true

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Id <String>

Id of the item to set the template for.

Aliases

Required?

true

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TemplateItem <TemplateItem>

Sitecore item representing the template.

Aliases

Required?

true

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Template <String>

Path representing the template item. This must be of the same database as the item to be altered.

Aliases

Required?

true

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FieldsToCopy <Hashtable>

Hashtable of key value pairs mapping the old template field to a new template field.

@{"Title"="Headline";"Text"="Copy"}

Aliases

Required?

false

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Database <String>

Database containing the item to set the template for - required if item is specified with Id.

Aliases

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.Data.Items.Item

Notes

Help Author: Adam Najmanowicz, Michael West, Alex Washtell

Examples

EXAMPLE 1

Set template of /sitecore/content/home item using a Template path.

Set-ItemTemplate -Path master:/sitecore/content/home -Template "/sitecore/templates/User Defined/Page"

EXAMPLE 2

Set template of /sitecore/content/home item using a TemplateItem.

$template = Get-ItemTemplate -Path master:\content\home\page1
Set-ItemTemplate -Path master:\content\home\page2 -TemplateItem $template

EXAMPLE 3

Set the template and remap fields to their new name.

Set-ItemTemplate -Path "master:\content\home\Page1" `
    -Template "User Defined/Target" `
    -FieldsToCopy @{Field1="Field4"; Field2="Field5"; Field3="Field6"}

Last updated