次の方法で共有

New-IseSnippet

  • リファレンス
モジュール:
ISE

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

構文

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 でスニペットを表示するには、 Edit メニューから Start Snippets を選択するか、 CTRL+J キーを押します。

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

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

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

例

例 1: コメントベースのヘルプ スニペットを作成する

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: 必須スニペットを作成する

$M = @'
Param
(
  [parameter(Mandatory=$true)]
  [String[]]
  $<ParameterName>
)
'@

New-ISESnippet -Text $M -Title Mandatory -Description "Adds a mandatory function parameter." -Author "Patti Fuller, Fabrikam Corp." -Force

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

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

Copy-Item "$HOME\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"

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

パラメーター

-Author

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

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CaretOffset

このコマンドレットがカーソルを置くスニペット テキストの文字を指定します。 カーソルの位置を表す整数を入力します。"1" は、テキストの最初の文字を表します。 既定値の 0 (ゼロ) の場合、テキストの最初の文字の直前にカーソルが配置されます。 このパラメーターは、スニペットのテキストをインデントする機能は提供しません。

型:Int32
配置:Named
規定値:0
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Description

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

型:String
配置:2
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Force

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

型:SwitchParameter
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Text

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

型:String
配置:3
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Title

スニペットのタイトルまたは名前を指定します。 このタイトルはスニペット ファイルの名前にも使用されます。 このパラメーターは必須です。

型:String
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

None

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

メモ

New-IseSnippet では、新しいユーザー作成スニペットが署名されていない .ps1xml ファイルに格納されます。 そのため、Windows PowerShell では、実行ポリシーが AllSigned または Restricted セッションに追加できません。 Restricted または 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 のスニペット メニューに表示されます。