CodeEnum.AddMember, méthode

Article
05/16/2015

Crée une construction de code de membre et insère le code à l'emplacement approprié.

Espace de noms : EnvDTE
Assembly : EnvDTE (dans EnvDTE.dll)

Syntaxe

'Déclaration
Function AddMember ( _
    Name As String, _
    Value As Object, _
    Position As Object _
) As CodeVariable

CodeVariable AddMember(
    string Name,
    Object Value,
    Object Position
)

CodeVariable^ AddMember(
    String^ Name, 
    Object^ Value, 
    Object^ Position
)

abstract AddMember : 
        Name:string * 
        Value:Object * 
        Position:Object -> CodeVariable

function AddMember(
    Name : String, 
    Value : Object, 
    Position : Object
) : CodeVariable

Paramètres

Name
Type : String

Obligatoire. Nom du nouveau membre.

Value
Type : Object

Optionnel. InitExpression de l'objet CodeVariable retourné. Il peut être passé sous la forme d'une chaîne ou d'un objet d'expression.

Position
Type : Object

Optionnel. Valeur par défaut = 0. Élément de code après lequel le nouvel élément doit être ajouté. Si la valeur est CodeElement, le nouvel élément est ajouté directement après.

Si la valeur est un type de données Long, AddMember indique l'élément après lequel le nouvel élément doit être ajouté.

Comme la comptabilisation des collections commence à 1, passer la valeur 0 indique que le nouvel élément doit être placé au début de la collection. La valeur -1 signifie que l'élément doit être placé à la fin.

Valeur de retour

Type : EnvDTE.CodeVariable
Objet CodeVariable.

Notes

AddMember ajoute un membre à l'énumération et retourne un objet CodeVariable avec IsConstant dont la valeur est true.

Lorsque vous définissez Value pour une chaîne, la méthode AddMember insère la syntaxe éventuellement nécessaire, telle que des signes égal ou des points-virgules, si la variable ne possède pas encore d'expression d'initialisation. Selon le langage et les vérifications syntaxiques ou sémantiques qu'il exécute sur la chaîne passée, la définition de cet argument peut échouer. Les langages ne sont pas obligés de vérifier la chaîne et comme celle-ci dépend nécessairement du langage, la définition de cet argument peut entraîner un comportement non défini si le contenu de la chaîne est mal formé.

Lors de la définition de la valeur Value à CodeElement, la création récente de CodeElement dépend de l'implémentation de langage du modèle de code. Certains langages peuvent implémenter la copie de la sémantique si vous passez un élément de code déjà présent dans un fichier source.

L'exactitude des arguments est déterminée par le langage, au-delà du modèle de code.

Notes

Les valeurs des éléments de modèle de code, tels que les classes, les structures, les fonctions, les attributs et les délégués ne peuvent pas toujours rester identiques.Pour plus d'informations, consultez la section Les valeurs d'élément de modèle de code peuvent être modifiées de la rubrique Découverte de code à l'aide du modèle de code (Visual Basic).

Exemples

Sub AddMemberExample(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project
    ' and place the insertion point inside an enumeration.
    Try
        ' Retrieve the CodeEnum at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim enm As CodeEnum = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementEnum), CodeEnum)

        ' Add a member to the enumeration.
        enm.AddMember("TestMember")
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AddMemberExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside an enumeration.
    try
    {
        // Retrieve the CodeEnum at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeEnum enm = 
            (CodeEnum)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementEnum);

        // Add a member to the enumeration.
        enm.AddMember("TestMember", null, -1);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.