次の方法で共有

New-IseSnippet

モジュール:
ISE Module

Windows PowerShell ISE コード スニペットを作成します。

構文

Default (既定) 

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

説明

New-ISESnippet コマンドレットは、Windows PowerShell ISE 用の再利用可能なテキスト "スニペット" を作成します。 スニペットを使用して、Windows PowerShell ISE のスクリプト ペインまたはコマンド ペインにテキストを追加できます。 このコマンドレットは、Windows PowerShell ISE でのみ使用できます。

Windows PowerShell 3.0 以降、Windows PowerShell ISE には組み込みスニペットのコレクションが含まれています。 New-ISESnippet コマンドレットを使用すると、独自のスニペットを作成して組み込みコレクションに追加できます。 スニペット ファイルを表示、変更、追加、削除、共有したり、Windows PowerShell モジュールに含めたりすることができます。 Windows PowerShell ISE でスニペットを表示するには、[ 編集 ] メニューの [ スニペットの開始] を選択するか、Ctrl + J キーを押します。

New-ISESnippet コマンドレットは <Title> を作成します。Snippets.ps1xml ファイルを $home\Documents\WindowsPowerShell\Snippets ディレクトリに置き、指定したタイトルで保存します。 作成しているモジュールにスニペット ファイルを含めるには、モジュール ディレクトリの Snippets サブディレクトリにスニペット ファイルを追加します。

ユーザーが作成したスニペットは、実行ポリシーが Restricted または AllSigned のセッションでは使用できません。

このコマンドレットは、Windows PowerShell 3.0 で導入されました。

例

例 1: 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
#>"

このコマンドは、Windows PowerShell ISE の Comment-BasedHelp スニペットを作成します。 ユーザーの Snippets ディレクトリ ($home\Documents\WindowsPowerShell\Snippets) に "Comment-BasedHelp.snippets.ps1xml" という名前のファイルが作成されます。

例 2: 必須スニペットを作成する

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

この例では、Windows PowerShell ISE の必須スニペットを作成します。 最初のコマンドは、スニペット テキストを $M 変数に保存します。 2 番目のコマンドでは、 New-ISESnippet コマンドレットを使用してスニペットを作成します。 このコマンドは、 Force パラメーターを使用して、同じ名前の前のスニペットを上書きします。

例 3: 必須スニペットをフォルダからコピー先フォルダにコピーする

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

このコマンドでは、Copy-Item コマンドレットを使用して、 New-ISESnippet が配置されたフォルダーから Mandatory スニペットを Server\Share ファイル共有にコピーします。

New-ISESnippet によって作成される Snippets.ps1xml ファイルはテキスト (XML) ファイルであるため、Item コマンドレットを使用して、これらのファイルを取得、変更、移動、名前変更、およびコピーできます。

パラメーター

-Author

スニペットの作成者を指定します。 作成者フィールドはスニペット ファイルに表示されますが、Windows PowerShell ISE でスニペット名をクリックしても表示されません。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-CaretOffset

このコマンドレットがカーソルを置くスニペット テキストの文字を指定します。 カーソル位置を表す整数を入力します。「1」はテキストの最初の文字を表します。 デフォルト値の 0 (ゼロ) は、テキストの最初の文字の直前にカーソルを置きます。 このパラメーターは、スニペットのテキストをインデントしません。

パラメーターのプロパティ

型:Int32
規定値:0
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Description

スニペットの説明を指定します。 説明の値は、Windows PowerShell ISE でスニペット名をクリックすると表示されます。 このパラメーターは必須です。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:2
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Force

このコマンドレットが、同じ場所にある同じ名前のスニペット ファイルを上書きすることを示します。 デフォルトでは、 New-ISESnippet はファイルを上書きしません。

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Text

スニペットを選択したときに追加されるテキスト値を指定します。 スニペット テキストは、Windows PowerShell ISE でスニペット名をクリックすると表示されます。 このパラメーターは必須です。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:3
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Title

スニペットのタイトルまたは名前を指定します。 タイトルには、スニペット ファイルの名前も付けられています。 このパラメーターは必須です。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:1
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

入力

None

このコマンドレットは、パイプラインからの入力を受け取りません。

出力

None

このコマンドレットは出力を生成しません。

メモ

  • New-IseSnippet は、新しいユーザー作成スニペットを署名されていない .ps1xml ファイルに格納します。 そのため、Windows PowerShell は、実行ポリシーが AllSigned または制限付き セッションに追加することはできません。 制限付き または AllSigned セッション では、署名されていないユーザーが作成したスニペットを作成、取得、インポートできますが、セッションで使用することはできません。

RestrictedセッションまたはAllSignedセッションでNew-IseSnippetコマンドレットを使用すると、スニペットは作成されますが、Windows PowerShell新しく作成されたスニペットをセッションに追加しようとすると、エラーメッセージが表示されます。 新しいスニペット (およびその他の署名されていないユーザー作成スニペット) を使用するには、実行ポリシーを変更してから、Windows PowerShell ISE を再起動します。

Windows PowerShell 実行ポリシーの詳細については、「about_Execution_Policies」を参照してください。

  • スニペットを変更するには、スニペット ファイルを編集します。 スニペット ファイルは、Windows PowerShell ISE の [スクリプト] ウィンドウで編集できます。

  • 追加したスニペットを削除するには、スニペット ファイルを削除します。

  • 組み込みスニペットは削除できませんが、「$psise」を使用してすべての組み込みスニペットを非表示にすることができます。Options.ShowDefaultSnippets=$false" コマンドを実行します。

  • 組み込みスニペットと同じ名前のスニペットを作成できます。 どちらのスニペットも、Windows PowerShell ISE のスニペット メニューに表示されます。