Como: Criar um novo trecho com substituições

Artigo
08/01/2011

Você pode ter partes de trechos de código que você deseja ser substituído pela pessoa que inseri-los. Isso é útil se você deseja fazer referência a uma variável específica ou um objeto e o usuário poderá substituir a variável ou um objeto com um projeto dele. Trechos de código do IntelliSense fornecer essa capacidade com o Literal e Object elementos.

Depois de um trecho de código é inserido, você pode acessar todos os objetos possível substituição em seu código clicando-se a substituição e pressionando CTRL + espaço.

Criando uma substituição Literal

O Literal elemento é usado para identificar um substituto para um trecho de código que está inteiramente contido no trecho, mas provavelmente será personalizado depois que ele é inserido no código. Por exemplo, seqüências de caracteres literais, valores numéricos e alguns nomes de variáveis devem ser declarados como literais.

Este procedimento considera que você seguiu os procedimentos explicados na Como: Criar um trecho de código básico tópico.

Para criar uma substituição literal

Localize o Snippet o elemento do trecho de código.
Add a Declarations element as a child of the Snippet element. O Declarations elemento é usado para declarações de substituição de grupo.
Add a Literal element as a child of the Declarations element. O Literal elemento especifica literal individuais. Um trecho de código pode ter mais de uma substituição de literal.
Add an ID element as a child of the Literal element. O valor de texto desse elemento Especifica o nome que você usará para fazer referência a literal na Code elemento.
Add a Default element as a child of the Literal element. O valor do texto de Default elemento Especifica o valor padrão do literal quando você inserir o trecho de código.
Opcionalmente, adicione a função e/ou ToolTip elementos.

Criando uma substituição de objeto

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.

Este procedimento considera que você seguiu os procedimentos explicados na Como: Criar um trecho de código básico tópico.

Para criar uma substituição de objeto

Localize o Snippet o elemento do trecho de código.
Add a Declarations element as a child of the Snippet element. O Declarations elemento é usado para declarações de substituição de grupo.
Add an Object element as a child of the Declarations element. O Object elemento Especifica um objeto individual. Um trecho de código pode ter mais de uma substituição do objeto.
Add an ID element as a child of the Object element. O valor de texto desse elemento Especifica o nome que você usará para fazer referência o objeto do Code elemento.
Adicionar um Type elemento como um filho a Object o valor de texto do elemento da Default elemento Especifica o tipo de objeto.
Add a Default element as a child of the Object element. O valor do texto de Default elemento Especifica o valor padrão do objeto quando você inserir o trecho de código.
Opcionalmente, adicione a função e/ou ToolTip elementos.

Substituições de referência

Agora que você criou literais e os objetos, você precisa de uma maneira de usá-los no código que será inserido pelo trecho de código. Fazer referência a literais e os objetos que você tenha declarado na Declarations elemento colocando $ símbolos no início e no final do valor literal ou do objeto ID elemento

Para fazer referência a um literal ou um objeto em um elemento de código

Local $ símbolos no início e fim do literal ou do objeto ID valor de elemento. Por exemplo, se um literal tem um ID que contém o valor do elemento MyID, você faria referência ou literal na Code elemento com $MyID$.

Exemplo

O exemplo de código a seguir mostra um trecho de código com ambos os Literal e Object elementos. O SqlConnString literal é referenciado na Code elemento com $SqlConnString$e o SqlConnection o objeto é referenciado com $SqlConnection$.

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/CodeSnippet">
    <CodeSnippet>
        <Header>

            <!-- Add Header information here -->

        </Header>
        <Snippet>

            <!-- Add additional Snippet information here -->

            <Declarations>
                <Literal>
                    <ID>SqlConnString</ID>
                    <ToolTip>Replace with a SQL connection string.</ToolTip>
                    <Default>"SQL connection string"</Default>
                </Literal>
                <Object>
                    <ID>SqlConnection</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($SqlConnString$);
                    daCustomers.SelectCommand = selectCommand;
                    daCustomers.SelectCommand.Connection = $SqlConnection$;
                ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>