Compartir a través de

FileCodeModel.AddEnum (Método)

  • Artículo

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, _
    Position As Object, _
    Bases As Object, _
    Access As vsCMAccess _
) As CodeEnum

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

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

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

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

Parámetros

  • Name
    Tipo: String

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

  • 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 deberá situarse al final de la colección.

  • Bases
    Tipo: Object

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

Valor devuelto

Tipo: EnvDTE.CodeEnum
Un objeto CodeEnum.

Comentarios

La corrección de los argumentos vendrá determinada por el lenguaje que subyace al modelo de código. Todos los lenguajes omiten el parámetro Bases.

Ejemplos

Sub AddEnumExample(ByVal dte As DTE2)

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

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

End Sub

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

        // Create a new enum.
        projItem.FileCodeModel.AddEnum("TestEnum", -1, null, 
            vsCMAccess.vsCMAccessPublic);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

Seguridad de .NET Framework

Vea también

Referencia

FileCodeModel Interfaz

EnvDTE (Espacio de nombres)

Otros recursos

Cómo: Compilar y ejecutar los ejemplos de código del modelo de objetos de automatización