Método CodeModel2.AddEnum (String, Object, Object, Object, vsCMAccess)

Artigo
10/26/2012

Cria uma nova construção de código de enumeração e insere o código no local correto.

Namespace: EnvDTE80
Assembly: EnvDTE80 (em EnvDTE80.dll)

Sintaxe

'Declaração
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: System.String
Obrigatório.O nome do enum para adicionar.

Location
Tipo: System.Object
Obrigatório.O nome de arquivo e caminho para a nova definição de enum.Dependendo do idioma, o nome do arquivo é relativo ou absoluto para o arquivo de projeto.O arquivo é adicionado ao projeto, se já não é um item de projeto.Se o arquivo não pode ser criado e adicionado ao projeto, em seguida, AddEnum falhar.

Position
Tipo: System.Object
Opcional.Padrão = 0.O elemento de código após o qual você deseja adicionar o novo elemento.Se o valor for um CodeElement, e em seguida, o novo elemento é adicionado imediatamente após ele.
Se o valor é um tipo de dados longos, em seguida, AddEnum indica o elemento após o qual você deseja adicionar o novo elemento.
Porque coleções começam sua contagem em 1, passando de 0 indica que o novo elemento deve ser colocado no início da coleção.O valor-1 significa que o elemento deve ser colocado no final.

Bases
Tipo: System.Object
Opcional.Padrão = Nothing.Uma variante que mantém um SafeArray de nomes de tipo totalmente qualificado ou CodeType objetos que especificam o tipo subjacente de nova enum.

Access
Tipo: EnvDTE.vsCMAccess
Opcional.A vsCMAccess constante.

Valor de retorno

Tipo: EnvDTE.CodeEnum
A CodeEnum object.

Comentários

A correção dos argumentos é determinada pelo idioma atrás o modelo de código.Todos os idiomas ignorar o Bases parâmetro.

Observação
Os valores de elementos de modelo de código, como classes, estruturas, funções, atributos, delegados e assim por diante podem ser não-determinísticos depois de fazer determinados tipos de edições, o que significa que seus valores não confie sempre permanecer o mesmo.Para obter mais informações, consulte a seção valores de elemento de modelo de código podem ser alterada de Descobrindo o código usando o modelo de código (Visual Basic).

Os valores de elementos de modelo de código, como classes, estruturas, funções, atributos, delegados e assim por diante podem ser não-determinísticos depois de fazer determinados tipos de edições, o que significa que seus valores não confie sempre permanecer o mesmo.Para obter mais informações, consulte a seção valores de elemento de modelo de código podem ser alterada de Descobrindo o código usando o modelo de código (Visual Basic).

Exemplos

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

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.