New-IseSnippet
Skapar ett Windows PowerShell ISE-kodfragment.
Syntax
Default (Standard)
New-IseSnippet
[-Title] <String>
[-Description] <String>
[-Text] <String>
[-Author <String>]
[-CaretOffset <Int32>]
[-Force]
[<CommonParameters>]
Description
Cmdleten New-ISESnippet skapar ett återanvändbart textfragment för Windows PowerShell ISE. Du kan använda kodfragment för att lägga till text i skriptfönstret eller kommandofönstret i Windows PowerShell ISE. Den här cmdleten är endast tillgänglig i Windows PowerShell ISE.
Från och med Windows PowerShell 3.0 innehåller Windows PowerShell ISE en samling inbyggda kodfragment. Med cmdleten New-ISESnippet kan du skapa egna kodfragment att lägga till i den inbyggda samlingen. Du kan visa, ändra, lägga till, ta bort och dela kodfragmentfiler och inkludera dem i Windows PowerShell-moduler. Om du vill se kodfragment i Windows PowerShell ISE går du till menyn Redigera, väljer Starta kodfragment eller trycker på CTRL+J.
Cmdleten New-ISESnippet skapar en <Title>. Filen Snippets.ps1xml i katalogen $home\Documents\WindowsPowerShell\Snippets med den rubrik som du anger. Om du vill inkludera en kodfragmentfil i en modul som du redigerar lägger du till kodfragmentfilen i en underkatalog för kodfragment i modulkatalogen.
Du kan inte använda användarskapade kodfragment i en session där körningsprincipen är Begränsad eller AllSigned.
Den här cmdleten introducerades i Windows PowerShell 3.0.
Exempel
Exempel 1: Skapa ett Comment-BasedHelp kodfragment
PS C:\> New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
.SYNOPSIS
.DESCRIPTION
.PARAMETER <Parameter-Name>
.INPUTS
.OUTPUTS
.EXAMPLE
.LINK
#>"
Det här kommandot skapar ett Comment-BasedHelp kodfragment för Windows PowerShell ISE. Den skapar en fil med namnet "Comment-BasedHelp.snippets.ps1xml" i användarens kodfragmentkatalog ($home\Documents\WindowsPowerShell\Snippets).
Exempel 2: Skapa ett obligatoriskt kodfragment
PS C:\> $M = @'
Param
(
[parameter(Mandatory=$true)]
[String[]]
$<ParameterName>
)
'@
PS C:\> New-ISESnippet -Text $M -Title Mandatory -Description "Adds a mandatory function parameter." -Author "Patti Fuller, Fabrikam Corp." -Force
I det här exemplet skapas ett obligatoriskt kodfragment för Windows PowerShell ISE. Det första kommandot sparar kodfragmenttexten i variabeln $M. Det andra kommandot använder cmdleten New-ISESnippet för att skapa kodfragmentet. Kommandot använder parametern Force för att skriva över ett tidigare kodfragment med samma namn.
Exempel 3: Kopiera ett obligatoriskt kodfragment från en mapp till en målmapp
PS C:\> Copy-Item "$Home\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"
Det här kommandot använder cmdleten Copy-Item för att kopiera det obligatoriska kodfragmentet från mappen där New-ISESnippet placerar det på filresursen Server\Share.
Eftersom Snippets.ps1xml-filerna som New-ISESnippet skapar är textfiler (XML), kan du använda cmdletarna Item för att hämta, ändra, flytta, byta namn på och kopiera dem.
Parametrar
-Author
Anger författaren till kodfragmentet. Fältet författare visas i kodfragmentfilen, men det visas inte när du klickar på kodfragmentnamnet i Windows PowerShell ISE.
Parameteregenskaper
| Typ: | String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-CaretOffset
Anger tecknet för kodfragmenttexten som den här cmdleten placerar markören på. Ange ett heltal som representerar markörens position med "1" som representerar det första tecknet i texten. Standardvärdet 0 (noll) placerar markören omedelbart före det första tecknet i texten. Den här parametern drar inte in kodfragmenttexten.
Parameteregenskaper
| Typ: | Int32 |
| Standardvärde: | 0 |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Description
Anger en beskrivning av kodfragmentet. Beskrivningsvärdet visas när du klickar på kodfragmentnamnet i Windows PowerShell ISE. Den här parametern krävs.
Parameteregenskaper
| Typ: | String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | 2 |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Force
Anger att denna cmdlet skriver över kodfragmentfiler med samma namn på samma plats. Som standard skriver New-ISESnippet inte över filer.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Text
Anger det textvärde som läggs till när du väljer kodfragmentet. Kodfragmenttexten visas när du klickar på kodfragmentnamnet i Windows PowerShell ISE. Den här parametern krävs.
Parameteregenskaper
| Typ: | String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | 3 |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Title
Anger en rubrik eller ett namn för kodfragmentet. Rubriken namnger även kodfragmentfilen. Den här parametern krävs.
Parameteregenskaper
| Typ: | String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | 1 |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.
Indata
None
Den här cmdleten tar inte indata från pipelinen.
Utdata
None
Den här cmdleten genererar inga utdata.
Kommentarer
- New-IseSnippet lagrar nya användarskapade kodfragment i osignerade .ps1xml-filer. Windows PowerShell kan därför inte lägga till dem i en session där körningsprincipen är AllSigned eller Restricted. I en Begränsad eller AllSigned session kan du skapa, hämta och importera osignerade användarskapade kodfragment, men du kan inte använda dem i sessionen.
Om du använder cmdleten New-IseSnippet i en Restricted eller AllSigned session skapas kodfragmentet, men ett felmeddelande visas när Windows PowerShell försöker lägga till det nyligen skapade kodfragmentet i sessionen. Om du vill använda det nya kodfragmentet (och andra osignerade användarskapade kodfragment) ändrar du körningsprincipen och startar sedan om Windows PowerShell ISE.
Mer information om Körningsprinciper för Windows PowerShell finns i about_Execution_Policies.
Om du vill ändra ett kodfragment redigerar du kodfragmentfilen. Du kan redigera kodfragmentfiler i fönstret Skript i Windows PowerShell ISE.
Om du vill ta bort ett kodfragment som du har lagt till tar du bort kodfragmentfilen.
Du kan inte ta bort ett inbyggt kodfragment, men du kan dölja alla inbyggda kodfragment med hjälp av "$psise. Options.ShowDefaultSnippets=$false" kommando.
Du kan skapa ett kodfragment som har samma namn som ett inbyggt kodfragment. Båda kodfragmenten visas i kodfragmentmenyn i Windows PowerShell ISE.