Object 元素(IntelliSense 代码段)

更新:2007 年 11 月

定义代码段的可编辑对象。

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

属性和元素

以下几节描述了属性、子元素和父元素。

属性

元素

说明

Editable

可选的 Boolean 属性。

指定在代码段插入后是否可以编辑对象。此属性的默认值为 true。

子元素

元素

说明

Default

必需的元素。

指定在插入代码段时对象的默认值。Object 元素中必须有且仅有一个 Default 元素。

Function

可选的元素。

指定当对象在 Visual Studio 中获得焦点时要执行的函数。Object 元素中可能有零个或一个 Function 元素。

ID

必需的元素。

指定对象的唯一标识符。Object 元素中必须有且仅有一个 ID 元素。

Tooltip

可选的元素。

描述对象所需的值和用法。Object 元素中可能有零个或一个 Tooltip 元素。

Type

必需的元素。

指定对象的类型。Object 元素中必须有且仅有一个 Type 元素。

父元素

元素

说明

Declarations

包含构成代码段可编辑部分的文本和对象。

备注

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>

请参见

任务

如何:通过替换创建新的代码段

概念

代码段架构参考