チュートリアル: コードスニペットを実装する

[アーティクル]
06/19/2023

コードスニペットを作成してエディター拡張機能に含めると、拡張機能のユーザーがそれらを自分のコードに追加できるようになります。

コードスニペットは、ファイルに組み込むことができるコードまたはその他のテキストの断片です。特定のプログラミング言語用に登録されているすべてのスニペットを表示するには、[ツール] メニューの [コードスニペットマネージャー] をクリックします。スニペットをファイルに挿入するには、スニペットを配置する場所を右クリックし、[スニペットの挿入] または [ブロックの挿入] をクリックして、目的のスニペットを見つけてダブルクリックします。 Tab キーまたは Shift+Tab キーを押して、スニペットの関連部分を変更した後、Enter キーまたは Esc キーを押して変更を受け入れます。詳しくは、「コードスニペット」をご覧ください。

コードスニペットは、.snippet* というファイル名拡張子を持つ XML ファイルに格納されます。スニペットには、スニペットの挿入後に強調表示されるフィールドを含めることができます。これにより、ユーザーはそれらを見つけて変更できるようになります。スニペットファイルでは、コードスニペットマネージャー用の情報も提供されます。これにより、スニペット名が正しいカテゴリに表示されるようになります。スニペットスキーマについて詳しくは、「コードスニペットスキーマリファレンス」をご覧ください。

このチュートリアルでは、次のタスクを実行する方法を説明します。

特定の言語用のコードスニペットを作成して登録します。
[スニペットの挿入] コマンドをショートカットメニューに追加します。
スニペット拡張を実装します。

このチュートリアルは、「チュートリアル: 入力候補の表示」に基づいています。

コードスニペットを作成して登録する

通常、コードスニペットは、登録されている言語サービスに関連付けられます。ただし、コードスニペットを登録するために LanguageService を実装する必要はありません。代わりに、スニペットのインデックスファイルで GUID を指定し、プロジェクトに追加する ProvideLanguageCodeExpansionAttribute で同じ GUID を使用します。

次の手順では、コードスニペットを作成し、特定の GUID に関連付ける方法を示します。

次のディレクトリ構造を作成します。

%InstallDir%\TestSnippets\Snippets\1033\

ここで、%InstallDir% は Visual Studio のインストールフォルダーです (通常は、このパスがコードスニペットのインストールに使用されますが、任意のパスを指定することもできます)。

\1033\ フォルダーで、.xml ファイルを作成し、名前を TestSnippets.xml と指定します。 (通常は、この名前がスニペットのインデックスファイルに使用されますが、ファイル名拡張子が .xml であれば、任意の名前を指定することもできます)。次のテキストを追加し、プレースホルダー GUID を削除して、独自の GUID を追加します。

<?xml version="1.0" encoding="utf-8" ?>
<SnippetCollection>
    <Language Lang="TestSnippets" Guid="{00000000-0000-0000-0000-000000000000}">
        <SnippetDir>
            <OnOff>On</OnOff>
            <Installed>true</Installed>
            <Locale>1033</Locale>
            <DirPath>%InstallRoot%\TestSnippets\Snippets\%LCID%\</DirPath>
            <LocalizedName>Snippets</LocalizedName>
        </SnippetDir>
    </Language>
</SnippetCollection>

スニペットフォルダー内にファイルを作成し、名前を test.snippet と指定して、次のテキストを追加します。

<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Test replacement fields</Title>
            <Shortcut>test</Shortcut>
            <Description>Code snippet for testing replacement fields</Description>
            <Author>MSIT</Author>
            <SnippetTypes>
                <SnippetType>Expansion</SnippetType>
            </SnippetTypes>
        </Header>
        <Snippet>
            <Declarations>
                <Literal>
                  <ID>param1</ID>
                    <ToolTip>First field</ToolTip>
                    <Default>first</Default>
                </Literal>
                <Literal>
                    <ID>param2</ID>
                    <ToolTip>Second field</ToolTip>
                    <Default>second</Default>
                </Literal>
            </Declarations>
            <References>
               <Reference>
                   <Assembly>System.Windows.Forms.dll</Assembly>
               </Reference>
            </References>
            <Code Language="TestSnippets">
                <![CDATA[MessageBox.Show("$param1$");
     MessageBox.Show("$param2$");]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

次の手順は、コードスニペットの登録方法を示しています。

特定の GUID のコードスニペットを登録するには

CompletionTest プロジェクトを開きます。このプロジェクトの作成方法について詳しくは、「チュートリアル: 入力候補の表示」をご覧ください。
プロジェクトで、次のアセンブリへの参照を追加します。
- Microsoft.VisualStudio.TextManager.Interop
- Microsoft.VisualStudio.TextManager.Interop.8.0
- microsoft.msxml
プロジェクトで、source.extension.vsixmanifest ファイルを開きます。
[アセット] タブに VsPackage コンテンツタイプが含まれていて、その [プロジェクト] がプロジェクトの名前に設定されていることを確認します。
CompletionTest プロジェクトを選択し、プロパティウィンドウで [Pkgdef ファイルの生成] を true に設定します。プロジェクトを保存します。
静的 SnippetUtilities クラスをプロジェクトに追加します。
- C#
- VB
```
static class SnippetUtilities
```
```
Module SnippetUtilities
```

SnippetUtilities クラスで、GUID を定義し、SnippetsIndex.xml ファイルで使用した値を指定します。

internal const string LanguageServiceGuidStr = "00000000-0000-0000-0000-00000000";

Friend Const LanguageServiceGuidStr As String = "00000000-0000-0000-0000-00000000"

ProvideLanguageCodeExpansionAttribute を TestCompletionHandler クラスに追加します。この属性は、プロジェクト内の任意のパブリックまたは内部 (非静的) クラスに追加できます (場合によっては、Microsoft.VisualStudio.Shell 名前空間用の using ディレクティブを追加する必要があります)。

[ProvideLanguageCodeExpansion(
SnippetUtilities.LanguageServiceGuidStr,
"TestSnippets", //the language name
0,              //the resource id of the language
"TestSnippets", //the language ID used in the .snippet files
@"%InstallRoot%\TestSnippets\Snippets\%LCID%\TestSnippets.xml",
    //the path of the index file
SearchPaths = @"%InstallRoot%\TestSnippets\Snippets\%LCID%\",
ForceCreateDirs = @"%InstallRoot%\TestSnippets\Snippets\%LCID%\")]
internal class TestCompletionCommandHandler : IOleCommandTarget

<ProvideLanguageCodeExpansion(
SnippetUtilities.LanguageServiceGuidStr,
"TestSnippets",
0,
"TestSnippets",
"%InstallRoot%\TestSnippets\Snippets\%LCID%\SnippetsIndex.xml",
SearchPaths:="%InstallRoot%\TestSnippets\Snippets\%LCID%\",
ForceCreateDirs:="%InstallRoot%\TestSnippets\Snippets\%LCID%\")>
Friend Class TestCompletionCommandHandler
    Implements IOleCommandTarget

プロジェクトをビルドして実行します。プロジェクトの実行時に起動される Visual Studio の実験用インスタンスで、先ほど登録したスニペットが TestSnippets 言語の下のコードスニペットマネージャーに表示されます。

[スニペットの挿入] コマンドは、テキストファイル用のショートカットメニューには含まれません。そのため、コマンドを有効にする必要があります。

クラスファイルを TestCompletionCommandHandler 開きます。

このクラスは IOleCommandTarget を実装しているため、QueryStatus メソッドで [スニペットの挿入] コマンドをアクティブにすることができます。コマンドを有効にする前に、このメソッドがオートメーション関数の内部で呼び出されないことを確認してください。これは、[スニペットの挿入] コマンドをクリックしたときに、スニペットピッカーユーザーインターフェイス (UI) が表示されるためです。

public int QueryStatus(ref Guid pguidCmdGroup, uint cCmds, OLECMD[] prgCmds, IntPtr pCmdText)
{
    if (!VsShellUtilities.IsInAutomationFunction(m_provider.ServiceProvider))
    {
        if (pguidCmdGroup == VSConstants.VSStd2K && cCmds > 0)
        {
            // make the Insert Snippet command appear on the context menu 
            if ((uint)prgCmds[0].cmdID == (uint)VSConstants.VSStd2KCmdID.INSERTSNIPPET)
            {
                prgCmds[0].cmdf = (int)Constants.MSOCMDF_ENABLED | (int)Constants.MSOCMDF_SUPPORTED;
                return VSConstants.S_OK;
            }
        }
    }

    return m_nextCommandHandler.QueryStatus(ref pguidCmdGroup, cCmds, prgCmds, pCmdText);
}

Public Function QueryStatus(ByRef pguidCmdGroup As Guid, ByVal cCmds As UInteger, ByVal prgCmds As OLECMD(), ByVal pCmdText As IntPtr) As Integer Implements IOleCommandTarget.QueryStatus
    If Not VsShellUtilities.IsInAutomationFunction(m_provider.ServiceProvider) Then
        If pguidCmdGroup = VSConstants.VSStd2K AndAlso cCmds > 0 Then
            ' make the Insert Snippet command appear on the context menu 
            If CUInt(prgCmds(0).cmdID) = CUInt(VSConstants.VSStd2KCmdID.INSERTSNIPPET) Then
                prgCmds(0).cmdf = CInt(Constants.MSOCMDF_ENABLED) Or CInt(Constants.MSOCMDF_SUPPORTED)
                Return VSConstants.S_OK
            End If
        End If
    End If

    Return m_nextCommandHandler.QueryStatus(pguidCmdGroup, cCmds, prgCmds, pCmdText)
End Function

プロジェクトをビルドして実行します。実験用インスタンスで、ファイル名拡張子が .zzz のファイルを開き、その中の任意の場所を右クリックします。ショートカットメニューに [スニペットの挿入] コマンドが表示されます。

スニペットピッカー UI でスニペット拡張を実装する

このセクションでは、コードスニペット拡張を実装して、ショートカットメニューの [スニペットの挿入] をクリックしたときに、スニペットピッカー UI が表示されるようにする方法について説明します。コードスニペットは、ユーザーがコードスニペットのショートカットを入力し、Tab キーを押したときにも展開されます。

スニペットピッカー UI を表示し、ナビゲーションと挿入後のスニペットの受け入れを有効にするには、Exec メソッドを使用します。挿入自体は、OnItemChosen メソッドによって処理されます。

コードスニペット拡張の実装では、レガシの Microsoft.VisualStudio.TextManager.Interop インターフェイスが使用されます。現在のエディタークラスからレガシコードに変換する場合、レガシインターフェイスでは、行番号と列番号の組み合わせを使用してテキストバッファー内の場所が指定されますが、現在のクラスでは、1 つのインデックスが使用されることに注意してください。したがって、バッファー内に、それぞれ 10 文字 (および 1 文字としてカウントされる改行) を含む 3 つの行がある場合、3 行目の 4 番目の文字は、現在の実装では 27 の位置になりますが、以前の実装では、2 行目の 3 の位置になります。

スニペット拡張を実装するには

TestCompletionCommandHandler クラスを含むファイルに、次の using ディレクティブを追加します。

using Microsoft.VisualStudio.Text.Operations;
using MSXML;
using System.ComponentModel.Composition;

Imports Microsoft.VisualStudio.Text.Operations
Imports MSXML

TestCompletionCommandHandler クラスに IVsExpansionClient インターフェイスを実装させます。

internal class TestCompletionCommandHandler : IOleCommandTarget, IVsExpansionClient

<ProvideLanguageCodeExpansion(
SnippetUtilities.LanguageServiceGuidStr,
"TestSnippets",
0,
"TestSnippets",
"%InstallRoot%\TestSnippets\Snippets\%LCID%\SnippetsIndex.xml",
SearchPaths:="%InstallRoot%\TestSnippets\Snippets\%LCID%\",
ForceCreateDirs:="%InstallRoot%\TestSnippets\Snippets\%LCID%\")>
Friend Class TestCompletionCommandHandler
    Implements IOleCommandTarget
    Implements IVsExpansionClient

TestCompletionCommandHandlerProvider クラスで、ITextStructureNavigatorSelectorService をインポートします。

[Import]
internal ITextStructureNavigatorSelectorService NavigatorService { get; set; }

<Import()>
Friend Property NavigatorService As ITextStructureNavigatorSelectorService

コード拡張インターフェイスと IVsTextView 用のプライベートフィールドを追加します。

IVsTextView m_vsTextView;
IVsExpansionManager m_exManager;
IVsExpansionSession m_exSession;

Dim m_vsTextView As IVsTextView
Dim m_exManager As IVsExpansionManager
Dim m_exSession As IVsExpansionSession

TestCompletionCommandHandler クラスのコンストラクターで、次のフィールドを設定します。

internal TestCompletionCommandHandler(IVsTextView textViewAdapter, ITextView textView, TestCompletionHandlerProvider provider)
{
    this.m_textView = textView;
    m_vsTextView = textViewAdapter;
    m_provider = provider;
    //get the text manager from the service provider
    IVsTextManager2 textManager = (IVsTextManager2)m_provider.ServiceProvider.GetService(typeof(SVsTextManager));
    textManager.GetExpansionManager(out m_exManager);
    m_exSession = null;

    //add the command to the command chain
    textViewAdapter.AddCommandFilter(this, out m_nextCommandHandler);
}

Friend Sub New(ByVal textViewAdapter As IVsTextView, ByVal textView As ITextView, ByVal provider As TestCompletionHandlerProvider)
    Me.m_textView = textView
    Me.m_provider = provider
    Me.m_vsTextView = textViewAdapter

    Dim textManager As IVsTextManager2 = DirectCast(m_provider.ServiceProvider.GetService(GetType(SVsTextManager)), IVsTextManager2)
    textManager.GetExpansionManager(m_exManager)
    m_exSession = Nothing

    'add the command to the command chain
    textViewAdapter.AddCommandFilter(Me, m_nextCommandHandler)
End Sub

ユーザーが [スニペットの挿入] コマンドをクリックしたときにスニペットピッカーを表示するには、Exec メソッドに次のコードを追加します (ここでは、説明を読みやすくするために、ステートメント入力候補に使用される Exec() コードは表示しません。代わりに、既存のメソッドにコードのブロックが追加されます)。文字をチェックするコードの後に、次のコードブロックを追加します。

//code previously written for Exec
if (pguidCmdGroup == VSConstants.VSStd2K && nCmdID == (uint)VSConstants.VSStd2KCmdID.TYPECHAR)
{
    typedChar = (char)(ushort)Marshal.GetObjectForNativeVariant(pvaIn);
}
//the snippet picker code starts here
if (nCmdID == (uint)VSConstants.VSStd2KCmdID.INSERTSNIPPET)
{
    IVsTextManager2 textManager = (IVsTextManager2)m_provider.ServiceProvider.GetService(typeof(SVsTextManager));

    textManager.GetExpansionManager(out m_exManager);

    m_exManager.InvokeInsertionUI(
        m_vsTextView,
        this,      //the expansion client
        new Guid(SnippetUtilities.LanguageServiceGuidStr),
        null,       //use all snippet types
        0,          //number of types (0 for all)
        0,          //ignored if iCountTypes == 0
        null,       //use all snippet kinds
        0,          //use all snippet kinds
        0,          //ignored if iCountTypes == 0
        "TestSnippets", //the text to show in the prompt
        string.Empty);  //only the ENTER key causes insert 

    return VSConstants.S_OK;
}

'code previously written for Exec
If pguidCmdGroup = VSConstants.VSStd2K AndAlso nCmdID = CUInt(VSConstants.VSStd2KCmdID.TYPECHAR) Then
    typedChar = ChrW(CUShort(Marshal.GetObjectForNativeVariant(pvaIn)))
End If
'the snippet picker code starts here
If nCmdID = CUInt(VSConstants.VSStd2KCmdID.INSERTSNIPPET) Then
    Dim textManager As IVsTextManager2 = DirectCast(m_provider.ServiceProvider.GetService(GetType(SVsTextManager)), IVsTextManager2)

    textManager.GetExpansionManager(m_exManager)
    m_exManager.InvokeInsertionUI(
        m_vsTextView,
        Me,
        New Guid(SnippetUtilities.LanguageServiceGuidStr),
        Nothing,
        0,
        0,
        Nothing,
        0,
        0,
        "TestSnippets",
        String.Empty)
    Return VSConstants.S_OK
End If

移動できるフィールドがスニペットにある場合、拡張が明示的に許可されるまで、拡張セッションは開いたままになります。スニペットにフィールドがない場合、セッションは閉じられ、InvokeInsertionUI メソッドによって null として返されます。 Exec メソッドで、前の手順で追加したスニペットピッカー UI コードの後に、スニペットナビゲーションを処理する次のコードを追加します (ユーザーがスニペットの挿入後に Tab または Shift+Tab キーを押した場合)。

//the expansion insertion is handled in OnItemChosen
//if the expansion session is still active, handle tab/backtab/return/cancel
if (m_exSession != null)
{
    if (nCmdID == (uint)VSConstants.VSStd2KCmdID.BACKTAB)
    {
        m_exSession.GoToPreviousExpansionField();
        return VSConstants.S_OK;
    }
    else if (nCmdID == (uint)VSConstants.VSStd2KCmdID.TAB)
    {

        m_exSession.GoToNextExpansionField(0); //false to support cycling through all the fields
        return VSConstants.S_OK;
    }
    else if (nCmdID == (uint)VSConstants.VSStd2KCmdID.RETURN || nCmdID == (uint)VSConstants.VSStd2KCmdID.CANCEL)
    {
        if (m_exSession.EndCurrentExpansion(0) == VSConstants.S_OK)
        {
            m_exSession = null;
            return VSConstants.S_OK;
        }
    }
}

'the expansion insertion is handled in OnItemChosen
'if the expansion session is still active, handle tab/backtab/return/cancel
If m_exSession IsNot Nothing Then
    If nCmdID = CUInt(VSConstants.VSStd2KCmdID.BACKTAB) Then
        m_exSession.GoToPreviousExpansionField()
        Return VSConstants.S_OK
    ElseIf nCmdID = CUInt(VSConstants.VSStd2KCmdID.TAB) Then
        m_exSession.GoToNextExpansionField(0)
        'false to support cycling through all the fields
        Return VSConstants.S_OK
    ElseIf nCmdID = CUInt(VSConstants.VSStd2KCmdID.[RETURN]) OrElse nCmdID = CUInt(VSConstants.VSStd2KCmdID.CANCEL) Then
        If m_exSession.EndCurrentExpansion(0) = VSConstants.S_OK Then
            m_exSession = Nothing
            Return VSConstants.S_OK
        End If
    End If
End If

ユーザーが対応するショートカットを入力し、Tab キーを押したときにコードスニペットを挿入するには、Exec メソッドにコードを追加します。スニペットを挿入するプライベートメソッドは、後の手順で示します。前の手順で追加したナビゲーションコードの後に、次のコードを追加します。

//neither an expansion session nor a completion session is open, but we got a tab, so check whether the last word typed is a snippet shortcut 
if (m_session == null && m_exSession == null && nCmdID == (uint)VSConstants.VSStd2KCmdID.TAB)
{
    //get the word that was just added 
    CaretPosition pos = m_textView.Caret.Position;
    TextExtent word = m_provider.NavigatorService.GetTextStructureNavigator(m_textView.TextBuffer).GetExtentOfWord(pos.BufferPosition - 1); //use the position 1 space back
    string textString = word.Span.GetText(); //the word that was just added
    //if it is a code snippet, insert it, otherwise carry on
    if (InsertAnyExpansion(textString, null, null))
        return VSConstants.S_OK;
}

'neither an expansion session nor a completion session is open, but we got a tab, so check whether the last word typed is a snippet shortcut 
If m_session Is Nothing AndAlso m_exSession Is Nothing AndAlso nCmdID = CUInt(VSConstants.VSStd2KCmdID.TAB) Then
    'get the word that was just added 
    Dim pos As CaretPosition = m_textView.Caret.Position
    Dim word As TextExtent = m_provider.NavigatorService.GetTextStructureNavigator(m_textView.TextBuffer).GetExtentOfWord(pos.BufferPosition - 1)
    Dim textString As String = word.Span.GetText()
    'if it is a code snippet, insert it, otherwise carry on
    If InsertAnyExpansion(textString, Nothing, Nothing) Then
        Return VSConstants.S_OK
    End If
End If

IVsExpansionClient インターフェイスのメソッドを実装します。この実装では、目的のメソッドは EndExpansion と OnItemChosen だけです。他のメソッドは S_OK を返すだけです。

public int EndExpansion()
{
    m_exSession = null;
    return VSConstants.S_OK;
}

public int FormatSpan(IVsTextLines pBuffer, TextSpan[] ts)
{
    return VSConstants.S_OK;
}

public int GetExpansionFunction(IXMLDOMNode xmlFunctionNode, string bstrFieldName, out IVsExpansionFunction pFunc)
{
    pFunc = null;
    return VSConstants.S_OK;
}

public int IsValidKind(IVsTextLines pBuffer, TextSpan[] ts, string bstrKind, out int pfIsValidKind)
{
    pfIsValidKind = 1;
    return VSConstants.S_OK;
}

public int IsValidType(IVsTextLines pBuffer, TextSpan[] ts, string[] rgTypes, int iCountTypes, out int pfIsValidType)
{
    pfIsValidType = 1;
    return VSConstants.S_OK;
}

public int OnAfterInsertion(IVsExpansionSession pSession)
{
    return VSConstants.S_OK;
}

public int OnBeforeInsertion(IVsExpansionSession pSession)
{
    return VSConstants.S_OK;
}

public int PositionCaretForEditing(IVsTextLines pBuffer, TextSpan[] ts)
{
    return VSConstants.S_OK;
}

Public Function EndExpansion() As Integer Implements IVsExpansionClient.EndExpansion
    m_exSession = Nothing
    Return VSConstants.S_OK
End Function

Public Function FormatSpan(ByVal pBuffer As IVsTextLines, ByVal ts As TextSpan()) As Integer Implements IVsExpansionClient.FormatSpan
    Return VSConstants.S_OK
End Function

Public Function GetExpansionFunction(ByVal xmlFunctionNode As IXMLDOMNode, ByVal bstrFieldName As String, ByRef pFunc As IVsExpansionFunction) As Integer Implements IVsExpansionClient.GetExpansionFunction
    pFunc = Nothing
    Return VSConstants.S_OK
End Function

Public Function IsValidKind(ByVal pBuffer As IVsTextLines, ByVal ts As TextSpan(), ByVal bstrKind As String, ByRef pfIsValidKind As Integer) As Integer Implements IVsExpansionClient.IsValidKind
    pfIsValidKind = 1
    Return VSConstants.S_OK
End Function

Public Function IsValidType(ByVal pBuffer As IVsTextLines, ByVal ts() As TextSpan, ByVal rgTypes() As String, ByVal iCountTypes As Integer, ByRef pfIsValidType As Integer) As Integer Implements IVsExpansionClient.IsValidType
    pfIsValidType = 1
    Return VSConstants.S_OK
End Function

Public Function OnAfterInsertion(ByVal pSession As IVsExpansionSession) As Integer Implements IVsExpansionClient.OnAfterInsertion
    Return VSConstants.S_OK
End Function

Public Function OnBeforeInsertion(ByVal pSession As IVsExpansionSession) As Integer Implements IVsExpansionClient.OnBeforeInsertion
    Return VSConstants.S_OK
End Function

Public Function PositionCaretForEditing(ByVal pBuffer As IVsTextLines, ByVal ts As TextSpan()) As Integer Implements IVsExpansionClient.PositionCaretForEditing
    Return VSConstants.S_OK
End Function

OnItemChosen メソッドを実装します。拡張を実際に挿入するヘルパーメソッドについては、後の手順で説明します。 TextSpan は行と列の情報を提供します。この情報は IVsTextView から取得できます。

public int OnItemChosen(string pszTitle, string pszPath)
{
    InsertAnyExpansion(null, pszTitle, pszPath);
    return VSConstants.S_OK;
}

Public Function OnItemChosen(ByVal pszTitle As String, ByVal pszPath As String) As Integer Implements IVsExpansionClient.OnItemChosen
    InsertAnyExpansion(Nothing, pszTitle, pszPath)
    Return VSConstants.S_OK
End Function

次のプライベートメソッドでは、ショートカットまたはタイトルとパスに基づいて、コードスニペットが挿入されます。その後、スニペットを使って InsertNamedExpansion メソッドが呼び出されます。

private bool InsertAnyExpansion(string shortcut, string title, string path)
{
    //first get the location of the caret, and set up a TextSpan
    int endColumn, startLine;
    //get the column number from  the IVsTextView, not the ITextView
    m_vsTextView.GetCaretPos(out startLine, out endColumn);

    TextSpan addSpan = new TextSpan();
    addSpan.iStartIndex = endColumn;
    addSpan.iEndIndex = endColumn;
    addSpan.iStartLine = startLine;
    addSpan.iEndLine = startLine;

    if (shortcut != null) //get the expansion from the shortcut
    {
        //reset the TextSpan to the width of the shortcut, 
        //because we're going to replace the shortcut with the expansion
        addSpan.iStartIndex = addSpan.iEndIndex - shortcut.Length;

        m_exManager.GetExpansionByShortcut(
            this,
            new Guid(SnippetUtilities.LanguageServiceGuidStr),
            shortcut,
            m_vsTextView,
            new TextSpan[] { addSpan },
            0,
            out path,
            out title);

    }
    if (title != null && path != null)
    {
        IVsTextLines textLines;
        m_vsTextView.GetBuffer(out textLines);
        IVsExpansion bufferExpansion = (IVsExpansion)textLines;

        if (bufferExpansion != null)
        {
            int hr = bufferExpansion.InsertNamedExpansion(
                title,
                path,
                addSpan,
                this,
                new Guid(SnippetUtilities.LanguageServiceGuidStr),
                0,
               out m_exSession);
            if (VSConstants.S_OK == hr)
            {
                return true;
            }
        }
    }
    return false;
}

Private Function InsertAnyExpansion(ByVal shortcut As String, ByVal title As String, ByVal path As String) As Boolean
    Dim endColumn As Integer, startLine As Integer
    'get the column number from  the IVsTextView, not the ITextView
    m_vsTextView.GetCaretPos(startLine, endColumn)

    Dim addSpan As New TextSpan()
    addSpan.iStartIndex = endColumn
    addSpan.iEndIndex = endColumn
    addSpan.iStartLine = startLine
    addSpan.iEndLine = startLine

    'get the expansion from the shortcut
    If shortcut IsNot Nothing Then
        'reset the TextSpan to the width of the shortcut, because we're going to replace the shortcut with the expansion
        addSpan.iStartIndex = addSpan.iEndIndex - shortcut.Length

        m_exManager.GetExpansionByShortcut(
            Me,
            New Guid(SnippetUtilities.LanguageServiceGuidStr),
            shortcut,
            m_vsTextView,
            New TextSpan() {addSpan},
            0,
            path,
            title)
    End If
    If title IsNot Nothing AndAlso path IsNot Nothing Then
        Dim textLines As IVsTextLines = Nothing
        m_vsTextView.GetBuffer(textLines)
        Dim bufferExpansion As IVsExpansion = DirectCast(textLines, IVsExpansion)

        If bufferExpansion IsNot Nothing Then
            Dim hr As Integer = bufferExpansion.InsertNamedExpansion(
                title,
                path,
                addSpan,
                Me,
                New Guid(SnippetUtilities.LanguageServiceGuidStr),
                0,
                m_exSession)
            If VSConstants.S_OK = hr Then
                Return True
            End If
        End If
    End If
    Return False
End Function

コードスニペット拡張をビルドしてテストする

プロジェクトでスニペット拡張が機能するかどうかをテストできます。

ソリューションをビルドします。デバッガーでこのプロジェクトを実行すると、Visual Studio の 2 つ目のインスタンスが起動されます。
テキストファイルを開き、いくつかのテキストを入力します。
テキスト内の任意の場所を右クリックし、[スニペットの挿入] をクリックします。
スニペットピッカー UI が表示され、「Test replacement fields」という文字列ポップアップが表示されます。ポップアップをダブルクリックします。

次のスニペットが挿入されます。
```
MessageBox.Show("first");
MessageBox.Show("second");
```
Enter キーや Esc キーは押さないでください。
Tab キーまたは Shift+Tab キーを押して、"first" と "second" を切り替えます。
Enter キーまたは Esc キーを押して、挿入を受け入れます。
テキストの別の部分に「test」と入力し、Tab キーを押します。"test" はコードスニペットのショートカットなので、スニペットが再び挿入されます。

次の方法で共有

チュートリアル: コードスニペットを実装する

コードスニペットを作成して登録する

特定の GUID のコードスニペットを登録するには

[スニペットの挿入] コマンドをショートカットメニューに追加する

[スニペットの挿入] コマンドをショートカットメニューに追加するには

スニペットピッカー UI でスニペット拡張を実装する

スニペット拡張を実装するには

コードスニペット拡張をビルドしてテストする

その他のリソース

次の方法で共有

チュートリアル: コード スニペットを実装する

コードスニペットを作成して登録する

特定の GUID のコード スニペットを登録するには

[スニペットの挿入] コマンドをショートカット メニューに追加する

[スニペットの挿入] コマンドをショートカット メニューに追加するには

スニペット ピッカー UI でスニペット拡張を実装する

スニペット拡張を実装するには

コード スニペット拡張をビルドしてテストする

その他のリソース

チュートリアル: コードスニペットを実装する

特定の GUID のコードスニペットを登録するには

[スニペットの挿入] コマンドをショートカットメニューに追加する

[スニペットの挿入] コマンドをショートカットメニューに追加するには

スニペットピッカー UI でスニペット拡張を実装する

コードスニペット拡張をビルドしてテストする