Literal 要素 (IntelliSense コード スニペット)

更新 : 2007 年 11 月

編集が可能なコード スニペットのリテラルを定義します。

<Literal Editable="true/false">
   <ID>... </ID>
   <ToolTip>... </ToolTip>
   <Default>... </Default>
   <Function>... </Function>
</Literal>

属性と要素

以降のセクションでは、属性、子要素、および親要素について説明します。

属性

属性	説明
Editable	省略可能な Boolean 型の属性です。 コード スニペットの挿入後、リテラルを編集できるようにするかどうかを指定します。この属性の既定値は true です。

子要素

要素	説明
Default	必須の要素 コード スニペットを挿入した場合に、既定で使用されるリテラルの値を指定します。Literal 要素で使用できる Default 要素は 1 つだけです。
Function	省略可能な要素 リテラルが Visual Studio でフォーカスを受け取ったときに実行される関数を指定します。Literal 要素に 0 個または 1 個の Function 要素があります。
ID	必須の要素 リテラルの一意の識別子を指定します。Literal 要素で使用できる ID 要素は 1 つだけです。
Tooltip	省略可能な要素 リテラルに予想される値と使用法に関する説明文です。Literal 要素に 0 個または 1 個の Tooltip 要素があります。

親要素

要素	説明
Declarations	編集が可能なコード スニペットのリテラルおよびオブジェクトを保持します。

解説

Literal 要素は、コード スニペットの中で置き換えて使用できる部分を識別する目的で使用されます。たとえば、リテラルな文字列、数値、一部の変数名などが、リテラルとして宣言されます。

リテラルおよびオブジェクトに、end という値の ID 要素を使用することはできません。$end$ という値は、コード スニペットの挿入後のカーソル位置をマーキングする目的で予約されています。

使用例

ID 要素に SQL という値を持つリテラルを宣言する方法を次のコード例に示します。Code 要素では、既定の区切り記号を使用してリテラルを参照しています。この例では、$SQL$ を使ってリテラルが参照されています。

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Create a data adapter</Title>
            <Description>Creates a SqlDataAdapter object.</Description>
            <Author>Microsoft Corporation</Author>
            <Shortcut>createadapter</Shortcut>
        </Header>
        <Snippet>
            <Declarations>
                <Literal>
                    <ID>SQL</ID>
                    <ToolTip>Replace with a SQL connection string.</ToolTip>
                    <Default>"SQL connection string"</Default>
                </Literal>
                <Object>
                    <ID>Connection</ID>
                    <Type>System.Data.SqlClient.SqlConnection</Type>
                    <ToolTip>Replace with a connection object in your application.</ToolTip>
                    <Default>dcConnection</Default>
                </Object>
            </Declarations>
            <Code Language="CSharp">
                <![CDATA[
                    daCustomers = new SqlClient.SqlDataAdapter();
                    selectCommand = new SqlClient.SqlCommand($SQL$);
                    daCustomers.SelectCommand = selectCommand;
                    daCustomers.SelectCommand.Connection = $Connection$;
                ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

参照

概念

コード スニペット スキーマ リファレンス