Freigeben über

CodeClass2.AddAttribute-Methode (String, String, Object)

  • Artikel

Erstellt ein neues Attributcodekonstrukt und fügt die Klasse an der korrekten Position ein.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
Function AddAttribute ( _
    Name As String, _
    Value As String, _
    Position As Object _
) As CodeAttribute

CodeAttribute AddAttribute(
    string Name,
    string Value,
    Object Position
)

CodeAttribute^ AddAttribute(
    String^ Name, 
    String^ Value, 
    Object^ Position
)

abstract AddAttribute : 
        Name:string * 
        Value:string * 
        Position:Object -> CodeAttribute 

function AddAttribute(
    Name : String, 
    Value : String, 
    Position : Object
) : CodeAttribute

Parameter

  • Name
    Typ: System.String
    Erforderlich.Der Name des neuen Attributs.
  • Value
    Typ: System.String
    Erforderlich.Der Wert des Attributs. Hierbei kann es sich um eine kommagetrennte Liste von Parametern für eine parametrisierte Eigenschaft handeln.
  • Position
    Typ: System.Object
    Optional.Standardwert = 0.Das Codeelement, hinter dem das neue Element hinzugefügt werden soll.Wenn der Wert ein CodeElement ist, wird das neue Element unmittelbar im Anschluss hinzugefügt.
    Wenn der Wert ein Long-Datentyp ist, gibt Position das Element an, nach dem das neue Element hinzugefügt werden soll.
    Da die Zählung bei Auflistungen mit 1 beginnt, wird mit dem Wert 0 angegeben, dass das neue Element am Anfang der Auflistung eingefügt werden soll.Bei dem Wert -1 wird das Element am Ende eingefügt.

Rückgabewert

Typ: EnvDTE.CodeAttribute
Ein CodeAttribute-Objekt.

Hinweise

Wenn das Attribut bereits vorhanden ist, fügt die AddAttribute-Methode ein weiteres hinzu.Dies ist ggf. für das Attribut oder die Sprache des Codemodells nicht zutreffend.

HinweisHinweis

Die Werte von Codemodellelementen wie Klassen, Strukturen, Funktionen, Attributen, Delegaten usw. können nach bestimmten Bearbeitungsvorgängen nicht deterministisch sein, d. h., dass nicht mehr davon ausgegangen werden kann, dass ihre Werte immer unverändert bleiben.Weitere Informationen finden Sie im Abschnitt zum Änderungsverhalten von Codemodellelementwerten unter Ermitteln von Code über das Codemodell (Visual Basic).

Beispiele

[Visual Basic]

Sub AddAttributeExample(ByVal dte As DTE2)
    ' Before running this example, open a code document from a project
    ' and place the insertion point inside a class definition.
    Try
        ' Retrieve the CodeClass at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim cls As CodeClass = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementClass), CodeClass)

        ' Add an attribute to the class.
        cls.AddAttribute("TestAttribute", "TestValue")
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try
End Sub

[C#]

 public void AddAttributeExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeClass cls = 
            (CodeClass)sel.ActivePoint.get_CodeElement(
             vsCMElement.vsCMElementClass);

        // Add an attribute to the class.
        cls.AddAttribute("TestAttribute", "TestValue", -1);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

.NET Framework-Sicherheit

Siehe auch

Referenz

CodeClass2 Schnittstelle

AddAttribute-Überladung

EnvDTE80-Namespace

Weitere Ressourcen

Gewusst wie: Kompilieren und Ausführen der Codebeispiele für das Automatisierungsobjektmodell

Ermitteln von Code über das Codemodell (Visual Basic)

Ermitteln von Code über das Codemodell (Visual C#)