CodeModel.AddEnum (Método)

Artículo
05/17/2015

Crea una nueva construcción de código de enumeración e inserta el código en la ubicación adecuada.

Espacio de nombres: EnvDTE
Ensamblado: EnvDTE (en EnvDTE.dll)

Sintaxis

'Declaración
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

Parámetros

Name
Tipo: String

Obligatorio. Nombre de la enumeración que se va a agregar.

Location
Tipo: Object

Obligatorio. Ruta de acceso y nombre de archivo correspondientes a la nueva definición de enumeración. En función del lenguaje, el nombre de archivo será relativo o absoluto con respecto al archivo de proyecto. El archivo se agregará al proyecto si todavía no es un elemento del mismo. Si no es posible crear el archivo y agregarlo al proyecto, AddEnum producirá un error.

Position
Tipo: Object

Opcional. Valor predeterminado = 0. Elemento de código tras el que se agrega el elemento nuevo. Si el valor es un CodeElement, el nuevo elemento se agregará inmediatamente tras él.

Si el tipo de datos del valor es Long, AddEnum indicará el elemento detrás del cual se ha de agregar el nuevo elemento.

Como el recuento de los elementos de una colección comienza a partir de 1, pasar un valor de 0 indica que el nuevo elemento deberá colocarse al principio de la colección. Un valor de -1 indica que el elemento debe situarse al final.

Bases
Tipo: Object

Opcional. Valor predeterminado = Nothing. Variante que contiene un valor SafeArray de nombres de tipo completos u objetos CodeType que especifican el tipo subyacente de la nueva enumeración.

Access
Tipo: EnvDTE.vsCMAccess

Opcional. Constante vsCMAccess.

Valor devuelto

Tipo: EnvDTE.CodeEnum
Un objeto CodeEnum.

Comentarios

El lenguaje subyacente al modelo de código determina la exactitud de los argumentos. Todos los lenguajes omiten el parámetro Bases.

Nota

Los valores de los elementos de modelo de código como clases, structs, funciones, atributos, delegados, etc., pueden ser no deterministas una vez realizados determinados tipos de modificaciones; esto significa que no se puede confiar en que sus valores se mantengan siempre igual.Para obtener más información, vea la sección Los valores de elementos de modelo de código pueden cambiar, en Detectar código utilizando el modelo de código (Visual Basic).

Ejemplos

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

Seguridad de .NET Framework

Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.