Gewusst wie: Erstellen eines neuen Ausschnitts mit Ersetzungen

Artikel
08/10/2011

In machen Fällen sollen Teile eines Codeausschnitts von der Person ersetzt werden, die den Ausschnitt einfügt. Dies ist hilfreich, wenn Sie auf eine bestimmte Variable oder ein bestimmtes Objekt verweisen möchten, und der Benutzer in der Lage sein soll, die Variable oder das Objekt durch ein Element aus seinem eigenen Projekt zu ersetzen. IntelliSense-Codeausschnitte ermöglichen dies mithilfe des Literal-Elements und des Object-Elements.

Nachdem ein Codeausschnitt eingefügt wurde, können Sie auf alle möglichen Ersetzungsobjekte im Code zugreifen, indem Sie auf die Ersetzung klicken und STRG+LEERTASTE drücken.

Erstellen einer literalen Ersetzung

Das Literal-Element wird verwendet, um eine Ersetzung für ein Codeelement zu kennzeichnen, das zwar vollständig im Ausschnitt enthalten ist, nach dem Einfügen in den Code jedoch wahrscheinlich geändert wird. Literalzeichenfolgen, numerische Werte und einige Variablennamen sollten beispielsweise als Literale deklariert werden.

In diesem Verfahren wird davon ausgegangen, dass Sie die im Thema Gewusst wie: Erstellen eines grundlegenden Codeausschnitts beschriebenen Verfahren ausgeführt haben.

So erstellen Sie eine literale Ersetzung

Suchen Sie das Snippet-Element des Codeausschnitts.
Fügen Sie ein Declarations-Element als untergeordnetes Element des Snippet-Elements hinzu. Das Declarations-Element wird verwendet, um Ersetzungsdeklarationen zu gruppieren.
Fügen Sie ein Literal-Element als untergeordnetes Element des Declarations-Elements hinzu. Das Literal-Element gibt ein einzelnes Literal an. Ein Codeausschnitt kann über mehrere literale Ersetzungen verfügen.
Fügen Sie ein ID-Element als untergeordnetes Element des Literal-Elements hinzu. Im Textwert dieses Element ist der Name angegeben, der verwendet wird, um im Code-Element auf das Literal zu verweisen.
Fügen Sie ein Default-Element als untergeordnetes Element des Literal-Elements hinzu. Im Textwert des Default-Elements wird beim Einfügen des Codeausschnitts der Standardwert des Literals angegeben.
Fügen Sie optional das Function-Element und/oder das ToolTip-Element hinzu.

Erstellen einer Objektersetzung

Das Object-Element wird zur Kennzeichnung eines vom Codeausschnitt benötigten Elements verwendet, das möglicherweise jedoch außerhalb des Codeausschnitts selbst definiert wird. Beispielsweise sollten Windows Forms-Steuerelemente, ASP.NET-Steuerelemente, Objektinstanzen und Typinstanzen als Objekte deklariert werden. Für Objektdeklarationen muss ein Typ angegeben werden.

In diesem Verfahren wird davon ausgegangen, dass Sie die im Thema Gewusst wie: Erstellen eines grundlegenden Codeausschnitts beschriebenen Verfahren ausgeführt haben.

So erstellen Sie eine Objektersetzung

Suchen Sie das Snippet-Element des Codeausschnitts.
Fügen Sie ein Declarations-Element als untergeordnetes Element des Snippet-Elements hinzu. Das Declarations-Element wird verwendet, um Ersetzungsdeklarationen zu gruppieren.
Fügen Sie ein Object-Element als untergeordnetes Element des Declarations-Elements hinzu. Das Object-Element gibt ein einzelnes Objekt an. Ein Codeausschnitt kann über mehrere Objektersetzungen verfügen.
Fügen Sie ein ID-Element als untergeordnetes Element des Object-Elements hinzu. Im Textwert dieses Element ist der Name angegeben, der verwendet wird, um im Code-Element auf das Objekt zu verweisen.
Fügen Sie ein Type-Element als untergeordnetes Element des Object-Elements hinzu. Im Textwert des Default-Elements ist der Objekttyp angegeben.
Fügen Sie ein Default-Element als untergeordnetes Element des Object-Elements hinzu. Im Textwert des Default-Elements wird beim Einfügen des Codeausschnitts der Standardwert des Objekts angegeben.
Fügen Sie optional das Function-Element und/oder das ToolTip-Element hinzu.

Verweisen auf Ersetzungen

Nachdem Sie Literale und Objekte erstellt haben, benötigen Sie eine Möglichkeit, sie in dem durch den Codeausschnitt eingefügten Code zu verwenden. Sie verweisen auf die im Declarations-Element deklarierten Literale und Objekte, indem Sie den Wert im ID-Element des Literals oder Objekts in $-Zeichen einschließen.

So verweisen Sie in einem Codeelement auf ein Literal oder ein Objekt

Schließen Sie den ID-Elementwert des Literals oder Objekts in $-Zeichen ein. Wenn ein Literal z. B. über ein ID-Element mit dem Wert MyID verfügt, würden Sie im Code-Element mit $MyID$ auf dieses Literal verweisen.

Beispiel

Im folgenden Codebeispiel wird ein Codeausschnitt sowohl mit dem Literal-Element als auch mit dem Object-Element veranschaulicht. Auf das SqlConnString-Literal wird im Code-Element mit $SqlConnString$ und auf das SqlConnection-Objekt mit $SqlConnection$ verwiesen.

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