CodeEnum.AddMember メソッド

[アーティクル]
08/09/2011

新しいメンバーコード構成を作成し、適切な位置にコードを挿入します。

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

構文

'宣言
Function AddMember ( _
    Name As String, _
    Value As Object, _
    Position As Object _
) As CodeVariable

CodeVariable AddMember(
    string Name,
    Object Value,
    Object Position
)

CodeVariable^ AddMember(
    String^ Name, 
    Object^ Value, 
    Object^ Position
)

abstract AddMember : 
        Name:string * 
        Value:Object * 
        Position:Object -> CodeVariable

function AddMember(
    Name : String, 
    Value : Object, 
    Position : Object
) : CodeVariable

パラメーター

Name
型: System.String
必須。新しいメンバーの名前。

Value
型: System.Object
省略可能です。返された CodeVariable オブジェクトの InitExpression。文字列として渡すことも、式オブジェクトとして渡すこともできます。

Position
型: System.Object
省略可能です。既定値は 0 です。ここで指定したコード要素の後に、新しい要素を追加します。値が CodeElement の場合は、その値の直後に新しい要素が追加されます。
値が long 型の場合は、後ろに新しい要素を追加する要素が AddMember によって示されます。
コレクションのカウントは 1 から始まるため、0 を指定すると新しい要素がコレクションの最初に配置されます。値 -1 は要素を末尾に配置することを示します。

戻り値

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

解説

AddMember は列挙体にメンバーを追加し、IsConstant が true に設定された CodeVariable オブジェクトを返します。

変数が初期化式を持たない場合、Value を文字列に設定すると、AddMember は、等号やセミコロンなど、必要な構文を挿入します。この引数を設定すると、言語によっては、渡した文字列に対する構文チェックまたは意味のチェックによってエラーになる場合があります。言語による文字列のチェックは必ず行われるわけではなく、この文字列は必然的に言語に依存するため、この引数を設定した場合に文字列に誤った形式の内容が含まれていると、未定義の動作を引き起こす可能性があります。

Value を CodeElement に設定した場合、CodeElement を新しく作成する必要があるかどうかは、コードモデルの言語の実装によって決まります。一部の言語では、既にソースファイルにあるコード要素を渡すと、コピーの意味が実装される場合があります。

引数が正しいかどうかは、コードモデルの背後にある言語によって決まります。

注意

クラス、構造体、関数、属性、デリゲートなどのコードモデル要素の値が常に同じであると信頼することはできません。詳細については、「コードモデルを使用したコードの調査 (Visual Basic)」で、コードモデル要素値を変更する方法についての説明を参照してください。

例

Sub AddMemberExample(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project
    ' and place the insertion point inside an enumeration.
    Try
        ' Retrieve the CodeEnum at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim enm As CodeEnum = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementEnum), CodeEnum)

        ' Add a member to the enumeration.
        enm.AddMember("TestMember")
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AddMemberExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside an enumeration.
    try
    {
        // Retrieve the CodeEnum at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeEnum enm = 
            (CodeEnum)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementEnum);

        // Add a member to the enumeration.
        enm.AddMember("TestMember", null, -1);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}