Elemento de objeto (trechos de código de IntelliSense)

  • Artigo

Defines the objects of the code snippet that you can edit.

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

Atributos e elementos

The following sections describe attributes, child elements, and parent elements.

Atributos

Element

Description

Editable

Opcional Boolean atributo.

Especifica se o objeto pode ser editado depois de inserido o trecho de código. O valor padrão deste atributo é true.

Elementos filho

Element

Description

Default

Elemento necessário.

Especifica o valor padrão objeto quando o trecho de código é inserido. Deve haver exatamente um Default elemento em um Object elemento.

Function

Elemento opcional.

Especifica uma função a ser executada quando o objeto recebe o foco em Visual Studio. Pode haver zero ou um Function elementos em um Object elemento.

ID

Elemento necessário.

Especifica um identificador exclusivo para o objeto. Deve haver exatamente um ID elemento em um Object elemento.

Tooltip

Elemento opcional.

Descreve o valor esperado e o uso do objeto. Pode haver zero ou um Tooltip elementos em um Object elemento.

Type

Elemento necessário.

Especifica o tipo do objeto. Deve haver exatamente um Type elemento em um Object elemento.

Elementos pai

Element

Description

Declarations

Contém os literais e os objetos que compõem as partes de um trecho de código que pode ser editado.

Comentários

O Object elemento é usado para identificar um item que é necessária para o trecho de código, mas é provável que seja definido fora do trecho de código em si. Por exemplo, os controles Windows Forms, ASP.NET controles, instâncias de objeto e instâncias do tipo devem ser declaradas como objetos. Declarações de objeto requerem que um tipo seja especificado, que é feito com o Type elemento.

Exemplo

O exemplo de código a seguir mostra como declarar um SqlConnection de objeto com um ID o valor do elemento de Connection. O objeto é referenciado no Code elemento usando o delimitador padrão. Neste exemplo, o objeto é referenciado com $Connection$.

Literais e os objetos não podem conter um ID o elemento com um valor de end. O valor $end$ é reservado e é usado para marcar o local para colocar o cursor após o trecho de código é inserido.

<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>

Consulte também

Tarefas

Como: Criar um novo trecho com substituições

Conceitos

Referência de esquema de trechos de código