Элемент Literal (фрагменты кода IntelliSense)

Статья
11/05/2008

Обновлен: Ноябрь 2007

Определяет литералы фрагмента кода, доступные для редактирования.

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

Атрибуты и элементы

В следующих разделах описаны атрибуты, дочерние и родительские элементы.

Атрибуты

Атрибут	Описание
Editable	Необязательный атрибут Boolean. Задает, доступен ли литерал для редактирования после вставки фрагмента кода. По умолчанию данный атрибут имеет значение true.

Editable

Необязательный атрибут Boolean.

Задает, доступен ли литерал для редактирования после вставки фрагмента кода. По умолчанию данный атрибут имеет значение true.

Дочерние элементы

Элемент	Описание
Default	Обязательный элемент. Задает значение по умолчанию литерала при вставке фрагмента кода. Элемент Literal должен содержать только один элемент Default.
Function	Необязательный элемент. Задает функцию для выполнения при получении литералом фокуса в Visual Studio. Элемент Literal может содержать один элемент Function или ни одного такого элемента.
ID	Обязательный элемент. Задает уникальный идентификатор для литерала. Элемент Literal должен содержать только один элемент ID.
Tooltip	Необязательный элемент. Описывает прогнозируемое значение и использование литерала. Элемент Literal может содержать один элемент Tooltip или ни одного такого элемента.

Родительские элементы

Элемент	Описание
Объявления	Содержит литералы и объекты фрагмента кода, доступные для редактирования.

Заметки

Элемент Literal используется для определения замещающего элемента для отрывка кода, который полностью заключен во фрагмент, но с большой долей вероятности будет изменен после вставки в код. Например, строковые литералы, числовые значения и некоторые имена переменных должны объявляться как литералы.

Литералы и объекты не могут содержать элемент ID со значением end. Значение $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>

См. также

Основные понятия

Справочник по схеме фрагментов кода

Поделиться через