CodeClass.AddAttribute メソッド

新しい属性コード コンストラクターを作成して、正しい位置にコードを挿入します。

名前空間:  EnvDTE
アセンブリ:  EnvDTE (EnvDTE.dll 内)

構文

'宣言
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

パラメーター

• Name
  型 : String

  必須。 新しい属性の名前です。

• Value
  型 : String

  必須。 属性の値でパラメーター化したプロパティのパラメーターのリストをコンマで区切って指定することもできます。

• Position
  型 : Object

  省略可能。 既定値は 0 です。 ここで指定したコード要素の後に、新しい要素を追加します。 値が CodeElement の場合は、その値の直後に新しい要素が追加されます。

  値が long 型の場合は、後ろに新しい要素を追加する要素が AddAttribute によって示されます。

  コレクションのカウントは 1 から始まるため、0 を指定すると新しい要素がコレクションの最初に配置されます。 値 -1 は要素を末尾に配置することを示します。

戻り値

型 : EnvDTE.CodeAttribute
CodeAttribute オブジェクト。

解説

AddAttribute では、属性が既に存在する場合にも属性が追加されます。 属性や、コード モデルの背後にある言語によっては、このことが問題になる場合もあります。

例

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

.NET Framework セキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。

参照

関連項目

CodeClass インターフェイス

EnvDTE 名前空間

その他の技術情報

方法 : オートメーション オブジェクト モデルのコード例をコンパイルおよび実行する

コード モデルを使用したコードの調査 (Visual Basic)

コード モデルを使用したコードの調査 (Visual C#)