Metodo CodeModel.AddEnum

Articolo
10/30/2012

Crea un nuovo costrutto di codice di 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.Il 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.Il file verrà aggiunto al progetto se non è già un elemento di progetto.Se il file non può essere creato e aggiungerlo al progetto, quindi AddEnum ha 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, quindi il nuovo elemento verrà aggiunto immediatamente dopo.
Se il valore è di tipo long, quindi AddEnum indica l'elemento dopo il quale deve essere aggiunto il nuovo elemento.
Poiché nelle raccolte il conteggio inizia da 1, un valore 0 indica che il nuovo elemento deve essere inserito all'inizio della raccolta.Il valore -1 indica che l'elemento deve essere inserito alla fine.

Bases
Tipo: System.Object
facoltativo.Valore predefinito = alcuna operazione.Variant contenente un elemento SafeArray di nomi di tipi completi o CodeType oggetti che specificano il tipo sottostante della nuova enumerazione.

Access
Tipo: EnvDTE.vsCMAccess
facoltativo.In vsCMAccess costante.

Valore restituito

Tipo: EnvDTE.CodeEnum
In CodeEnum oggetto.

Note

Il linguaggio del modello di codice determina la precisione degli argomenti.Tutti i linguaggi ignorano Bases parametro.

[!NOTA]

I valori degli elementi del modello di codice come classi, strutture, le funzioni, gli attributi, delegati, e così via possono non essere deterministici dopo l'inserimento di determinati tipi di modifiche, pertanto i relativi valori non possono essere basati su per rimanere sempre gli stessi.Per ulteriori informazioni, vedere i valori degli elementi del modello di codice della sezione può cambiare 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

Attendibilità totale per il chiamante immediato. Impossibile utilizzare questo membro in codice parzialmente attendibile. Per ulteriori informazioni, vedere Utilizzo di librerie da codice parzialmente attendibile.