Cómo: Crear un nuevo fragmento de código con sustituciones

Artículo
08/10/2011

Es posible que existan partes de fragmentos de código que deba reemplazar la persona que los ha insertado. Esto resulta de gran utilidad si desea hacer referencia a una variable o un objeto concreto y desea, además, que el usuario pueda reemplazar la variable o el objeto por otro de su proyecto. Los fragmentos de código de IntelliSense permiten hacerlo gracias a los elementos Literal y Object.

Una vez insertado un fragmento de código, puede tener acceso a todos los objetos de reemplazo posibles del código; para ello, haga clic en el reemplazo y presione CTRL+Barra espaciadora.

Crear un reemplazo literal

El elemento Literal se utiliza para identificar el reemplazo de una pieza de código que está incluida completamente en el fragmento, pero que es probable que se personalice tras insertarla en el código. Por ejemplo, las cadenas literales, los valores numéricos y algunos nombres de variable se deberían declarar como elementos literal.

Este procedimiento da por hecho que se han seguido los procedimientos explicados en el tema Cómo: Crear un fragmento de código básico.

Para crear un reemplazo literal

Localice el elemento Snippet del fragmento de código.
Agregue un elemento Declarations como elemento secundario del elemento Snippet. El elemento Declarations se utiliza para agrupar las declaraciones de reemplazo.
Agregue un elemento Literal como elemento secundario del elemento Declarations. El elemento Literal especifica un literal individual. Un fragmento de código puede tener más de un reemplazo literal.
Agregue un elemento ID como elemento secundario del elemento Literal. El valor de texto de este elemento especifica el nombre que se utilizará para hacer referencia al literal en el elemento Code.
Agregue un elemento Default como elemento secundario del elemento Literal. El valor de texto del elemento Default especifica el valor predeterminado del literal cuando se inserta el fragmento de código.
Opcionalmente, agregue los elementos Function y/o ToolTip.

Crear un reemplazo de objeto

El elemento Object se utiliza para identificar un elemento necesario para el fragmento de código, pero que probablemente se defina fuera del propio fragmento. Por ejemplo, los controles de Windows Forms, los controles de ASP.NET, las instancias de objeto y las instancias de tipo se deberían declarar como objetos. Las declaraciones de objetos requieren que se especifique un tipo.

Este procedimiento da por hecho que se han seguido los procedimientos explicados en el tema Cómo: Crear un fragmento de código básico.

Para crear un reemplazo de objeto

Localice el elemento Snippet del fragmento de código.
Agregue un elemento Declarations como elemento secundario del elemento Snippet. El elemento Declarations se utiliza para agrupar las declaraciones de reemplazo.
Agregue un elemento Object como elemento secundario del elemento Declarations. El elemento Object especifica un objeto individual. Un fragmento de código puede tener más de un reemplazo de objeto.
Agregue un elemento ID como elemento secundario del elemento Object. El valor de texto de este elemento especifica el nombre que se utilizará para hacer referencia al objeto en el elemento Code.
Agregue un elemento Type como elemento secundario del elemento Object. El valor de texto del elemento Default especifica el tipo del objeto.
Agregue un elemento Default como elemento secundario del elemento Object. El valor de texto del elemento Default especifica el valor predeterminado del objeto cuando se inserta el fragmento de código.
Opcionalmente, agregue los elementos Function y/o ToolTip.

Hacer referencia a los reemplazos

Ahora que ha creado literales y objetos, se necesita un modo de utilizarlos en el código insertado por el fragmento de código. Para hacer referencia a los literales y objetos declarados en el elemento Declarations, coloque símbolos $ al comienzo y al final del valor del elemento ID del literal o del objeto.

Para hacer referencia a un literal u objeto en un elemento Code

Coloque los símbolos $ al principio y al final del valor del elemento ID del literal o del objeto. Por ejemplo, si el literal tiene un elemento ID que contiene el valor MyID, para hacer referencia a este literal en el elemento Code se utiliza $MyID$.

Ejemplo

El ejemplo de código siguiente muestra un fragmento de código con los elementos Literal y Object. Se hace referencia al literal SqlConnString en el elemento Code con $SqlConnString$, y al objeto SqlConnection con $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>