Procedura: creare un nuovo frammento con sostituzioni

Articolo
08/11/2011

A volte si preferisce che alcune parti dei frammenti di codice vengano sostituite da chi ne fa uso. Questa peculiarità è utile se si desidera fare riferimento a una specifica variabile o a uno specifico oggetto e si vuole che l'utente sia in grado di sostituirli con variabili o oggetti del proprio progetto. I frammenti di codice IntelliSense offrono questa possibilità grazie agli elementi Literal e Object.

Una volta inserito un frammento di codice, è possibile accedere a tutti i possibili oggetti di sostituzione presenti nel codice facendo clic sulla sostituzione e premendo CTRL+SPAZIO.

Creazione di una sostituzione di valore letterale

L'elemento Literal viene utilizzato per identificare una sostituzione per una parte di codice che è interamente contenuta nel frammento, ma verrà probabilmente personalizzata dopo l'inserimento nel codice. È ad esempio opportuno dichiarare come valori letterali le stringhe letterali, i valori numerici e alcuni nomi di variabili.

In questa procedura si presume che siano state seguite le procedure descritte nell'argomento Procedura: creare un frammento di codice di base.

Per creare una sostituzione di valore letterale

Individuare l'elemento Snippet del frammento di codice.
Aggiungere un elemento Declarations come figlio dell'elemento Snippet. L'elemento Declarations verrà utilizzato per raggruppare le dichiarazioni di sostituzione.
Aggiungere un elemento Literal come figlio dell'elemento Declarations. L'elemento Literal specifica un singolo valore letterale. Un frammento di codice può disporre di più sostituzioni di valori letterali.
Aggiungere un elemento ID come figlio dell'elemento Literal. Il valore di testo di questo elemento specifica il nome che verrà utilizzato per fare riferimento al valore letterale nell'elemento Code.
Aggiungere un elemento Default come figlio dell'elemento Literal. Il valore di testo dell'elemento Default specifica il valore predefinito del valore letterale nel momento in cui si inserisce il frammento di codice.
Facoltativamente, aggiungere gli elementi Function e/o ToolTip.

Creazione di una sostituzione di oggetto

L'elemento Object viene utilizzato per identificare un elemento richiesto dal frammento di codice ma che viene probabilmente definito al di fuori del frammento stesso. È ad esempio opportuno dichiarare come oggetti i controlli Windows Form, i controlli ASP.NET, le istanze di oggetti e le istanze di tipi. Per dichiarare oggetti è necessario specificare un tipo.

In questa procedura si presume che siano state seguite le procedure descritte nell'argomento Procedura: creare un frammento di codice di base.

Per creare una sostituzione di oggetto

Individuare l'elemento Snippet del frammento di codice.
Aggiungere un elemento Declarations come figlio dell'elemento Snippet. L'elemento Declarations verrà utilizzato per raggruppare le dichiarazioni di sostituzione.
Aggiungere un elemento Object come figlio dell'elemento Declarations. L'elemento Object specifica un singolo oggetto. Un frammento di codice può disporre di più sostituzioni di oggetti.
Aggiungere un elemento ID come figlio dell'elemento Object. Il valore di testo di questo elemento specifica il nome che verrà utilizzato per fare riferimento all'oggetto nell'elemento Code.
Aggiungere un elemento Type come figlio dell'elemento Object. Il valore di testo dell'elemento Default specifica il tipo di oggetto.
Aggiungere un elemento Default come figlio dell'elemento Object. Il valore di testo dell'elemento Default specifica il valore predefinito dell'oggetto nel momento in cui si inserisce il frammento di codice.
Facoltativamente, aggiungere gli elementi Function e/o ToolTip.

Riferimento a sostituzioni

Una volta creati valori letterali e oggetti, è necessario un modo per utilizzarli nel codice che verrà inserito dal frammento. Per fare riferimento ai valori letterali e agli oggetti dichiarati nell'elemento Declarations, è necessario posizionare i simboli $ all'inizio e alla fine del valore nell'elemento ID del valore letterale o dell'oggetto.

Per fare riferimento a un valore letterale o un oggetto in un elemento Code

Posizionare i simboli $ all'inizio e alla fine del valore dell'elemento ID del valore letterale o dell'oggetto. Se ad esempio un valore letterale dispone di un elemento ID contenente il valore MyID, il riferimento a tale valore letterale nell'elemento Code verrà creato con $MyID$.

Esempio

Nell'esempio di codice riportato di seguito viene illustrato un frammento di codice con entrambi gli elementi Literal e Object. Il riferimento al valore letterale SqlConnString viene creato nell'elemento Code con $SqlConnString$, mentre il riferimento all'oggetto SqlConnection viene creato 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>