Método CodeClass.AddAttribute

Artigo
10/26/2012

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

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

Sintaxe

'Declaração
Function AddAttribute ( _
    Name As String, _
    Value As String, _
    Position As Object _
) As CodeAttribute

CodeAttribute AddAttribute(
    string Name,
    string Value,
    Object Position
)

CodeAttribute^ AddAttribute(
    String^ Name, 
    String^ Value, 
    Object^ Position
)

abstract AddAttribute : 
        Name:string * 
        Value:string * 
        Position:Object -> CodeAttribute

function AddAttribute(
    Name : String, 
    Value : String, 
    Position : Object
) : CodeAttribute

Parâmetros

Name
Tipo: System.String
Obrigatório.O nome do novo atributo.

Value
Tipo: System.String
Obrigatório.O valor do atributo, que pode ser uma lista de parâmetros para uma propriedade com parâmetros, separados por vírgulas.

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 for um longo, em seguida, AddAttribute 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.

Valor de retorno

Tipo: EnvDTE.CodeAttribute
A CodeAttribute object.

Comentários

Se o atributo já existir, AddAttribute adiciona outro.Isso pode ser incorreto para o atributo ou a linguagem do modelo de código.

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 AddAttributeExample(ByVal dte As 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.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim cls As CodeClass = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementClass), CodeClass)

        ' Add an attribute to the class.
        cls.AddAttribute("TestAttribute", "TestValue")
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AddAttributeExample(DTE2 dte)
{
    // 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)dte.ActiveDocument.Selection;
        CodeClass cls = 
            (CodeClass)sel.ActivePoint.get_CodeElement(
             vsCMElement.vsCMElementClass);

        // Add an attribute to the class.
        cls.AddAttribute("TestAttribute", "TestValue", -1);
    }
    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.