通过

Literal 元素（IntelliSense 代码段）

  • 项目

定义代码段的可编辑文本。

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

特性和元素

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

特性

特性

说明

可编辑

可选的 Boolean 特性。

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

子元素

元素

说明

默认

必需的元素。

指定插入代码段时文本的默认值。 Literal 元素中必须有且仅有一个 Default 元素。

功能

可选元素。

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

ID

必需的元素。

指定文本的唯一标识符。 Literal 元素中必须有且仅有一个 ID 元素。

工具提示

可选元素。

描述文本所需的值和用法。 Literal 元素中可能有零个或一个 Tooltip 元素。

父元素

元素

说明

声明

包含代码段的可编辑文本和对象。

备注

Literal 元素用于标识整体包含在代码段中、但在插入到代码中后可能会进行自定义的代码部分的替换对象。 例如，字符串、数字值以及应声明为文本的一些变量名。

文本和对象不能包含具有 selected 或 end 值的 ID 元素。 值 $selected$ 表示在文档中选择的要在调用时插入代码段的文本。 $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>

请参见

概念

代码段架构参考