Object-Element (IntelliSense-Codeausschnitte)

Aktualisiert: November 2007

Definiert die Objekte des Codeausschnitts, die Sie bearbeiten können.

<Object Editable="true/false">
    <ID>... </ID>
    <Type>... </Type>
    <ToolTip>... </ToolTip>
    <Default>... </Default>
    <Function>... </Function>
</Object>

Attribute und Elemente

In den folgenden Abschnitten werden Attribute, untergeordnete Elemente und übergeordnete Elemente beschrieben.

Attribute

Element	Beschreibung
Editable	Optionales Boolean-Attribut. Gibt an, ob das Objekt bearbeitet werden kann, nachdem der Codeausschnitt eingefügt wurde. Der Standardwert dieses Attributs ist true.

Untergeordnete Elemente

Element	Beschreibung
Default	Erforderliches Element. Gibt den Standardwert des Objekts an, wenn der Codeausschnitt eingefügt wird. Es muss genau ein Default-Element in einem Object-Element vorhanden sein.
Function	Optionales Element. Gibt eine Funktion an, die ausgeführt werden soll, wenn das Objekt in Visual Studio den Fokus erhält. Ein Object-Element kann kein oder ein Function-Element enthalten.
ID	Erforderliches Element. Gibt einen eindeutigen Bezeichner für das Objekt an. Es muss genau ein ID-Element in einem Object-Element vorhanden sein.
Tooltip	Optionales Element. Beschreibt den erwarteten Wert sowie die Verwendungsweise des Objekts. Ein Object-Element kann kein oder ein Tooltip-Element enthalten.
Type	Erforderliches Element. Gibt den Typ des Objekts an. Es muss genau ein Type-Element in einem Object-Element vorhanden sein.

Übergeordnete Elemente

Element	Beschreibung
Deklarationen	Enthält die Literale und Objekte, die die Bestandteile eines Codeausschnitts darstellen, die Sie bearbeiten können.

Hinweise

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. Zu diesem Zweck wird das Type-Element verwendet.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie ein SqlConnection-Objekt mit dem ID-Elementwert Connection deklariert wird. Auf das Objekt wird unter Verwendung des Standardtrennzeichens im Code-Element verwiesen. In diesem Beispiel wird mit $Connection$ auf das Objekt verwiesen.

Literale und Objekte dürfen kein ID-Element mit dem Wert end enthalten. Der Wert $end$ ist reserviert. Mit diesem Wert wird die Stelle gekennzeichnet, an der der Cursor nach dem Einfügen des Codeausschnitts positioniert wird.

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Create a data adapter</Title>
            <Description>Creates a SqlDataAdapter object.</Description>
            <Author>Microsoft Corporation</Author>
            <Shortcut>createadapter</Shortcut>
        </Header>
        <Snippet>
            <Declarations>
                <Literal>
                    <ID>SQL</ID>
                    <ToolTip>Replace with a SQL connection string.</ToolTip>
                    <Default>"SQL connection string"</Default>
                </Literal>
                <Object>
                    <ID>Connection</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($SQL$);
                    daCustomers.SelectCommand = selectCommand;
                    daCustomers.SelectCommand.Connection = $Connection$;
                ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Siehe auch

Aufgaben

Gewusst wie: Erstellen eines neuen Ausschnitts mit Ersetzungen

Konzepte

Schemareferenz für Codeausschnitte