Object 要素 (IntelliSense コード スニペット)
編集が可能なコード スニペットのオブジェクトを定義します。
<Object Editable="true/false">
<ID>... </ID>
<Type>... </Type>
<ToolTip>... </ToolTip>
<Default>... </Default>
<Function>... </Function>
</Object>
属性および要素
以降のセクションでは、属性、子要素、および親要素について説明します。
属性
要素 |
説明 |
|---|---|
Editable |
省略可能な Boolean 型の属性です。 コード スニペットの挿入後、オブジェクトを編集できるようにするかどうかを指定します。 この属性の既定値は true です。 |
子要素
要素 |
説明 |
|---|---|
必須の要素 コード スニペットを挿入した時点でのオブジェクトの既定値を指定します。 Object 要素で使用できる Default 要素は 1 つだけです。 |
|
省略可能な要素 オブジェクトが Visual Studio でフォーカスを受け取ったときに実行される関数を指定します。 Object 要素に 0 個または 1 個の Function 要素があります。 |
|
必須の要素 オブジェクトの一意の識別子を指定します。 Object 要素で使用できる ID 要素は 1 つだけです。 |
|
省略可能な要素 オブジェクトに予想される値と使用法に関する説明文です。 Object 要素に 0 個または 1 個の Tooltip 要素があります。 |
|
必須の要素 オブジェクトの型を指定します。 Object 要素で使用できる Type 要素は 1 つだけです。 |
親要素
要素 |
説明 |
|---|---|
コード スニペットの中で編集可能な部分を表すリテラルおよびオブジェクトが格納されます。 |
解説
Object 要素は、コード スニペット自体には定義されておらず、外部で定義する必要のある項目を指定するときに使用します。 たとえば、Windows フォーム コントロール、ASP.NET コントロール、オブジェクトのインスタンス、型のインスタンスなどをオブジェクトとして宣言します。 オブジェクトの宣言では、Type 要素で型を指定する必要があります。
使用例
ID 要素に Connection という値を持つ SqlConnection オブジェクトを宣言する方法を次のコード例に示します。 Code 要素では、既定の区切り記号を使用してオブジェクトを参照しています。 この例では、$Connection$ を使ってオブジェクトが参照されています。
リテラルおよびオブジェクトに、end という値の ID 要素を使用することはできません。 $end$ という値は、コード スニペットの挿入後のカーソル位置をマーキングする目的で予約されています。
<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>