CodeModel.AddEnum, méthode

Article
11/15/2012

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

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

Syntaxe

'Déclaration
Function AddEnum ( _
    Name As String, _
    Location As Object, _
    Position As Object, _
    Bases As Object, _
    Access As vsCMAccess _
) As CodeEnum

CodeEnum AddEnum(
    string Name,
    Object Location,
    Object Position,
    Object Bases,
    vsCMAccess Access
)

CodeEnum^ AddEnum(
    String^ Name, 
    Object^ Location, 
    Object^ Position, 
    Object^ Bases, 
    vsCMAccess Access
)

abstract AddEnum : 
        Name:string * 
        Location:Object * 
        Position:Object * 
        Bases:Object * 
        Access:vsCMAccess -> CodeEnum

function AddEnum(
    Name : String, 
    Location : Object, 
    Position : Object, 
    Bases : Object, 
    Access : vsCMAccess
) : CodeEnum

Paramètres

Name
Type : System.String
Obligatoire.Nom de l'énumération à ajouter.

Location
Type : System.Object
Obligatoire.Chemin d'accès et nom de fichier de la nouvelle définition d'énumération.Selon le langage, le nom de fichier est relatif ou absolu par rapport au fichier projet.Le fichier est ajouté au projet s'il n'est pas déjà un élément de projet.Si vous ne pouvez pas créer et ajouter le fichier au projet, la méthode AddEnum échoue.

Position
Type : System.Object
Facultatif.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, AddEnum 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.

Bases
Type : System.Object
Facultatif.Par défaut = Nothing.Variant qui contient un SafeArray de noms de types qualifiés complets ou d'objets CodeType qui spécifient le type sous-jacent du nouvel enum.

Access
Type : EnvDTE.vsCMAccess
Facultatif.Constante vsCMAccess.

Valeur de retour

Type : EnvDTE.CodeEnum
Objet CodeEnum.

Notes

Le langage situé derrière le modèle de code détermine l'exactitude des arguments.Tous les langages ignorent le paramètre Bases.

[!REMARQUE]

Les valeurs d'éléments de modèle de code, tels que des classes, des structures, des fonctions, des attributs, des délégués, etc., peuvent être non déterminables après certains types de modifications, ce qui signifie qu'il n'est pas certain que leurs valeurs resteront inchangées.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 AddEnumExample2(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project.
    Try
        Dim projItem As ProjectItem = dte.ActiveDocument.ProjectItem
        Dim cm As CodeModel = projItem.ContainingProject.CodeModel

        ' Create a new enum.
        cm.AddEnum("TestEnum", projItem.Name)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AddEnumExample2(DTE2 dte)
{
    // Before running this example, open a code document from 
    // a project.
    try
    {
        ProjectItem projItem = dte.ActiveDocument.ProjectItem;
        CodeModel cm = projItem.ContainingProject.CodeModel;

        // Create a new enum.
        cm.AddEnum("TestEnum", projItem.Name, -1, null, 
            vsCMAccess.vsCMAccessPublic);
    }
    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, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.