Compartilhar via

New-IseSnippet

Módulo:
ISE Module

Cria um snippet de código ISE do Windows PowerShell.

Sintaxe

Default (Default) 

New-IseSnippet
    [-Title] <String>
    [-Description] <String>
    [-Text] <String>
    [-Author <String>]
    [-CaretOffset <Int32>]
    [-Force]
    [<CommonParameters>]

Description

O cmdlet New-ISESnippet cria um texto reutilizável "snippet" para o ISE do Windows PowerShell. Você pode usar snippets de código para adicionar texto ao painel Script ou painel comando no ISE do Windows PowerShell. Esse cmdlet só está disponível no ISE do Windows PowerShell.

A partir do Windows PowerShell 3.0, o ISE do Windows PowerShell inclui uma coleção de snippets internos. O cmdlet New-ISESnippet permite criar seus próprios snippets para adicionar à coleção interna. Você pode exibir, alterar, adicionar, excluir e compartilhar arquivos de snippet e incluí-los em módulos do Windows PowerShell. Para ver snippets no ISE do Windows PowerShell, no menu Editar , selecione Iniciar Snippets ou pressione CTRL+J.

O cmdlet new-ISESnippet cria umde título . Arquivo Snippets.ps1xml no diretório $home\Documents\WindowsPowerShell\Snippets com o título especificado. Para incluir um arquivo de snippet em um módulo que você está criando, adicione o arquivo de snippet a um subdiretório Snippets do diretório do módulo.

Não é possível usar snippets criados pelo usuário em uma sessão na qual a política de execução é Restrito ou AllSigned.

Esse cmdlet foi introduzido no Windows PowerShell 3.0.

Exemplos

Exemplo 1: Criar um snippet de Comment-BasedHelp

PS C:\> New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
    .SYNOPSIS
    .DESCRIPTION
    .PARAMETER  <Parameter-Name>
    .INPUTS
    .OUTPUTS
    .EXAMPLE
    .LINK
#>"

Esse comando cria um snippet de Comment-BasedHelp para o ISE do Windows PowerShell. Ele cria um arquivo chamado "Comment-BasedHelp.snippets.ps1xml" no diretório Snippets do usuário ($home\Documents\WindowsPowerShell\Snippets).

Exemplo 2: Criar um snippet obrigatório

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

Este exemplo cria um snippet de código obrigatório para o ISE do Windows PowerShell. O primeiro comando salva o texto do snippet na variável $M. O segundo comando usa o cmdlet New-ISESnippet para criar o snippet. O comando usa o parâmetro Force para substituir um snippet anterior com o mesmo nome.

Exemplo 3: copiar um snippet obrigatório de uma pasta para uma pasta de destino

PS C:\> Copy-Item "$Home\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"

Esse comando usa o cmdlet Copy-Item para copiar o snippet obrigatório da pasta em que New-ISESnippet o coloca no compartilhamento de arquivos Server\Share.

Como os arquivos Snippets.ps1xml que New-ISESnippet cria são arquivos XML (texto), você pode usar os cmdlets Item para obter, alterar, mover, renomear e copiá-los.

Parâmetros

-Author

Especifica o autor do snippet. O campo autor aparece no arquivo de snippet, mas não aparece quando você clica no nome do snippet no ISE do Windows PowerShell.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-CaretOffset

Especifica o caractere do texto do snippet no qual esse cmdlet coloca o cursor. Insira um inteiro que representa a posição do cursor, com "1" representando o primeiro caractere do texto. O valor padrão, 0 (zero), coloca o cursor imediatamente antes do primeiro caractere do texto. Esse parâmetro não recuou o texto do snippet.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:0
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Description

Especifica uma descrição do snippet. O valor de descrição é exibido quando você clica no nome do snippet no ISE do Windows PowerShell. Este parâmetro é obrigatório.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

Indica que esse cmdlet substitui arquivos de snippet com o mesmo nome no mesmo local. Por padrão, New-ISESnippet não substitui arquivos.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Text

Especifica o valor de texto que é adicionado quando você seleciona o snippet. O texto do snippet é exibido quando você clica no nome do snippet no ISE do Windows PowerShell. Este parâmetro é obrigatório.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:3
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Title

Especifica um título ou nome para o snippet. O título também nomeia o arquivo de snippet. Este parâmetro é obrigatório.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

None

Esse cmdlet não usa a entrada do pipeline.

Saídas

None

Este cmdlet não gera saída.

Observações

  • New-IseSnippet armazena novos snippets criados pelo usuário em arquivos .ps1xml sem sinal. Dessa forma, o Windows PowerShell não pode adicioná-los a uma sessão na qual a política de execução é AllSigned ou Restrito. Em uma sessão Restricted ou AllSigned, você pode criar, obter e importar snippets não assinados criados pelo usuário, mas não é possível usá-los na sessão.

Se você usar o cmdlet New-IseSnippet em um Restrito ou sessão AllSigned, o snippet será criado, mas uma mensagem de erro será exibida quando o Windows PowerShell tentar adicionar o snippet recém-criado à sessão. Para usar o novo snippet (e outros snippets não assinados criados pelo usuário), altere a política de execução e reinicie o ISE do Windows PowerShell.

Para obter mais informações sobre as políticas de execução do Windows PowerShell, consulte about_Execution_Policies.

  • Para alterar um snippet de código, edite o arquivo de snippet. Você pode editar arquivos de snippet no painel Script do ISE do Windows PowerShell.

  • Para excluir um snippet que você adicionou, exclua o arquivo de snippet.

  • Você não pode excluir um snippet interno, mas pode ocultar todos os snippets internos usando o "$psise. Comando Options.ShowDefaultSnippets=$false".

  • Você pode criar um snippet que tenha o mesmo nome de um snippet interno. Ambos os snippets aparecem no menu de snippet no ISE do Windows PowerShell.