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

Статья
11/05/2008

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

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

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

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

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

Атрибуты

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

Editable

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

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

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

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

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

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

Заметки

Элемент Object используется для определения элемента, который необходим во фрагменте кода, но с большой долей вероятности будет определен вне самого фрагмента. Например, элементы управления Windows Forms, элементы управления ASP.NET, экземпляры объектов и экземпляры типов должны объявляться как объекты. Для объявлений объектов необходимо указать тип, что делается при помощи элемента Type.

Пример

В следующем примере кода показано, как объявить объект SqlConnection, элемент ID которого имеет значение Connection. Для ссылки на объект в элементе Code используется разделитель по умолчанию. В данном примере для ссылки на объект используется $Connection$.

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

См. также

Задачи

Практическое руководство. Создание нового фрагмента кода с подстановочными параметрами

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

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

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