Como: Criar um novo trecho com substituições

Artigo
08/25/2010

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 desejar que o usuário é possível substituir a variável ou o objeto com um em seu projeto.IntelliSense Code Snippets oferecer essa capacidade com o Literal e Object elementos.

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

Criando uma substituição de literal

The Literal elemento é usado para identificar um substituto para um trecho de código totalmente contido no trecho, mas que provavelmente será personalizado depois que ele é inserido no código. Por exemplo, cadeias de caracteres literal, valores numéricos e alguns nomes de variáveis devem ser declarados sistema autônomo literal.

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

Para criar uma substituição literal

localizar o Snippet elemento do trecho de código.
Adicione um elemento Declarations como um filho do elemento Snippet.The Declarations elemento é usado para agrupar declarações de substituição.
Adicione um elemento Literal como um filho do elemento Declarations.The Literal elemento especifica um literal individual. Um trecho de código pode ter mais de uma substituição literal.
Adicione um elemento ID como um filho do elemento Literal.O valor de texto desse elemento Especifica o nome que você usará para fazer referência a literal no Code elemento.
Adicione um elemento Default como um filho do elemento Literal.O valor de texto do Default elemento Especifica o valor padrão do literal quando você inserir o trecho de código.
Opcionalmente, adicione o Função and/or Dica de ferramenta elementos.

Criar um objeto Replacement

The Object elemento é usado para identificar um item que é necessária para o trecho de código, mas é provável que seja definida fora do trecho de código. Por exemplo, controles Windows Forms, ASP.NET controles, instâncias de objetos e tipos de instâncias devem ser declarados sistema autônomo objetos. Declarações de objeto requerem que seja especificado um tipo.

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

Para criar uma substituição de objeto

localizar o Snippet elemento do trecho de código.
Adicione um elemento Declarations como um filho do elemento Snippet.The Declarations elemento é usado para agrupar declarações de substituição.
Adicione um elemento Object como um filho do elemento Declarations.The Object elemento especifica um objeto individual. Um trecho de código pode ter mais de um objeto de substituição.
Adicione um elemento ID como um filho do elemento Object.O valor de texto desse elemento Especifica o nome que você usará para fazer referência ao objeto no Code elemento.
Adicionar um Type elemento sistema autônomo um filho do Object O valor de texto do elemento da Default elemento Especifica o tipo do objeto.
Adicione um elemento Default como um filho do elemento Object.O valor de texto do Default elemento Especifica o valor padrão do objeto quando você inserir o trecho de código.
Opcionalmente, adicione o Função and/or Dica de ferramenta elementos.

Substituições de referência

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

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

Coloque $ símbolos no início e participante do literal ou do objeto ID valor do elemento. Por exemplo, se um literal possui um ID elemento que contém o valor 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 o Literal e Object elementos. The SqlConnString literal é referenciada 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>