Método CodeClass2.AddEnum

Artigo
05/17/2015

Cria uma nova enumeração na classe.

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

Sintaxe

'Declaração
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

Necessário. O nome da enumeração a ser adicionado.

Position
Tipo: Object

Opcional. Padrão = 0. O elemento de código depois do qual adicionar o novo elemento. Se o valor for CodeElement, o novo elemento é adicionado imediatamente após ele.

Se o valor for um longo, então Position indica o elemento depois do qual adicionar o novo elemento.

Como as coleções começam a contagem em 1, passar 0 indica que o novo elemento deve ser colocado no topo da coleção. Um valor de -1 significa que o elemento deve ser colocado no final.

Bases
Tipo: Object

Opcional. Padrão = nada. Uma variante para manterem que um SafeArray de nomes totalmente qualificados do tipo ou os objetos de CodeType que especificam o tipo subjacente do novo enum.

Access
Tipo: vsCMAccess

Opcional. Uma constante de vsCMAccess que especifica o tipo de acesso da enumeração.

Valor de retorno

Tipo: CodeEnum
Um objeto CodeEnum.

Comentários

A exatidão dos argumentos é determinada pelo idioma atrás do modelo de código.

Dica

Os valores de código de modelagem elementos como classes, estruturas, funções, atributos, representantes, e assim por diante podem ser não determinísticas depois de fazer determinados tipos as edições do, o que significa que seus valores não podem ser confiáveis em para permanecer sempre os mesmos.Para obter mais informações, veja que os valores do elemento do modelo de código da seção podem ser alteradas em Descobrindo código usando o modelo de código (Visual Basic).

Exemplos

[C#]

public void CodeClass2AddEnumExample(DTE2 dte2)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel =
            (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass cls =
            (CodeClass)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        object pos = -1; // Place enum at end of members collection
        // Add enum.
        CodeEnum cenum = cls.AddEnum("TestEnum", pos, 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ável.