Metodo CodeModel.AddEnum

  • Articolo

Crea un nuovo costrutto di codice di un'enumerazione e inserisce il codice nella posizione corretta.

Spazio dei nomi:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Sintassi

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

Parametri

  • Name
    Tipo: System.String
    Obbligatorio.Il nome dell'enumerazione da aggiungere.
  • Location
    Tipo: System.Object
    Obbligatorio.Percorso e nome file per la definizione della nuova enumerazione.A seconda del linguaggio, il nome file può essere relativo o assoluto rispetto al file di progetto.Se non ne costituisce già un elemento, il file viene aggiunto al progetto.Se non è possibile creare il file e aggiungerlo al progetto, AddEnum avrà esito negativo.
  • Position
    Tipo: System.Object
    Facoltativo.Valore predefinito = 0.Elemento di codice dopo il quale deve essere aggiunto il nuovo elemento.Se il valore corrisponde a CodeElement, il nuovo elemento verrà aggiunto immediatamente dopo.
    Se il valore è un tipo di dati Long, il metodo AddEnum indicherà l'elemento dopo il quale deve essere aggiunto il nuovo elemento.
    Poiché negli insiemi il conteggio inizia da 1, il valore 0 indica che il nuovo elemento deve essere inserito all'inizio dell'insieme.Il valore -1 indica che l'elemento deve essere inserito alla fine.
  • Bases
    Tipo: System.Object
    Facoltativo.Il valore predefinito è Nothing.Tipo di dati Variant che contiene un elemento SafeArray di nomi di tipo completi o oggetti CodeType che specificano il tipo sottostante della nuova enumerazione.

Valore restituito

Tipo: EnvDTE.CodeEnum
Un oggetto CodeEnum.

Note

Il linguaggio alla base del modello di codice determina la correttezza degli argomenti. Tutti i linguaggi ignorano il parametro Bases.

Nota

I valori degli elementi del modello di codice, quali classi, strutture, funzioni, attributi, delegati e così via, possono non essere deterministici dopo alcuni tipi di modifiche. Ciò significa che non si può fare affidamento sulla stabilità di tali valori. Per ulteriori informazioni, vedere la sezione Possibile modifica dei valori degli elementi del modello di codice in Individuazione di codice mediante il modello di codice (Visual Basic).

Esempi

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);
    }
}

Sicurezza di .NET Framework

Vedere anche

Riferimenti

CodeModel Interfaccia

Spazio dei nomi EnvDTE

Altre risorse

Procedura: compilare ed eseguire gli esempi di codice del modello a oggetti di automazione

Individuazione di codice mediante il modello di codice (Visual Basic)

Individuazione di codice mediante il modello di codice (Visual C#)