CodeEnum.AddMember 方法

發行項
08/12/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，則會緊接在其後加入新項目。
如果這個值是長資料型別，那麼 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);
    }
}