Método CodeClass2.AddAttribute

Artigo
05/17/2015

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

Namespace: EnvDTE80
Assembly: EnvDTE80 (em EnvDTE80.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: String

Necessário. O nome do novo atributo.

Value
Tipo: String

Necessá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: 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 tipo de dados 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.

Valor de retorno

Tipo: CodeAttribute
Um objeto CodeAttribute.

Comentários

Se o atributo já existir, o método de AddAttribute adiciona outro. Isso pode estar incorreto para o atributo ou o 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

[Visual Basic]

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

[C#]

 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ável.