Show-FieldEditor
Shows Field editor for a provided item.
Syntax
Show-FieldEditor -Item <Item> -PreserveSections [-Name <String[]>] [-Title <String>] [-Width <Int32>] [-Height <Int32>] [-IncludeStandardFields]
Show-FieldEditor -Item <Item> [-SectionTitle <String>] [-SectionIcon <String>] [-Name <String[]>] [-Title <String>] [-Width <Int32>] [-Height <Int32>] [-IncludeStandardFields]
Show-FieldEditor -Path <String> [-Language <String[]>] -PreserveSections [-Name <String[]>] [-Title <String>] [-Width <Int32>] [-Height <Int32>] [-IncludeStandardFields]
Show-FieldEditor -Path <String> [-Language <String[]>] [-SectionTitle <String>] [-SectionIcon <String>] [-Name <String[]>] [-Title <String>] [-Width <Int32>] [-Height <Int32>] [-IncludeStandardFields]
Show-FieldEditor -Id <String> [-Database <String>] [-Language <String[]>] -PreserveSections [-Name <String[]>] [-Title <String>] [-Width <Int32>] [-Height <Int32>] [-IncludeStandardFields]
Show-FieldEditor -Id <String> [-Database <String>] [-Language <String[]>] [-SectionTitle <String>] [-SectionIcon <String>] [-Name <String[]>] [-Title <String>] [-Width <Int32>] [-Height <Int32>] [-IncludeStandardFields]
Detailed Description
Shows Field editor for a provided item allows for editing all or selected list of fields. If user closes the dialog by pressing the "OK" button "ok" string will be returned. Otherwise "cancel" will be returned.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
Parameters
-Name <String[]>
Array of names of the fields to be edited.
This parameter supports globbing so you can simply use "" to allow editing of all fields. If a field is prefixed with a dash - this field will be excluded from the list of fields. e.g. the following will display all fields except title from Show-FieldEditor -Path "master:\content\home" -Name "", "-Title"
| Aliases | |
|---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-Title <String>
Title of the dialog containing the field editor.
| Aliases | |
|---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-Width <Int32>
Width of the dialog containing the field editor.
| Aliases | |
|---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-Height <Int32>
Height of the dialog containing the field editor.
| Aliases | |
|---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-IncludeStandardFields <SwitchParameter>
Add this parameter to add standard fields to the list that is being considered to be displayed
| Aliases | |
|---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-Item <Item>
The item to be edited.
| Aliases | |
|---|---|
Required? | true |
Position? | named |
Default Value | |
Accept Pipeline Input? | true (ByValue, ByPropertyName) |
Accept Wildcard Characters? | false |
-Path <String>
Path to the item to be edited - additionally specify Language parameter to fetch different item language than the current user language.
| Aliases | |
|---|---|
Required? | true |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-Id <String>
Id of the the item to be edited - additionally specify Language parameter to fetch different item language than the current user language.
| Aliases | |
|---|---|
Required? | true |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-Database <String>
Database containing the item to be edited - 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 |
-Language <String[]>
Language that will be edited. If not specified the current user language will be used. Globbing/wildcard supported.
| Aliases | |
|---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-PreserveSections <SwitchParameter>
If added this parameter tells editor to preserve the original item field sections, otherwise all fields are placed in a single section Named by SectionTitle parameter and having the SectionIcon icon.
| Aliases | |
|---|---|
Required? | true |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-SectionTitle <String>
If PreserveSections is not added to parameters - this parameter provides a title for the global section all fields are placed under.
| Aliases | |
|---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-SectionIcon <String>
If PreserveSections is not added to parameters - this parameter provides a iconfor the global section all fields are placed under.
| 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
Outputs
The output type is the type of the objects that the cmdlet emits.
System.String
Notes
Help Author: Adam Najmanowicz, Michael West
Examples
EXAMPLE 1
Show field editor that shows all non-standard fields on sitecore/content/home item except for field "title" The dialog will be titled "My Home Item" all fields inside will be in single section.
EXAMPLE 2
Show field editor that shows all fields including standard fields on sitecore/content/home The dialog will preserve the item sections.
Related Topics
Last updated