CodeClass2.AddEnum メソッド (String, Object, Object, vsCMAccess)

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

クラスに新しい列挙体を作成します。

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

構文

'宣言
Function AddEnum ( _
    Name As String, _
    Position As Object, _
    Bases As Object, _
    Access As vsCMAccess _
) As CodeEnum

CodeEnum AddEnum(
    string Name,
    Object Position,
    Object Bases,
    vsCMAccess Access
)

CodeEnum^ AddEnum(
    String^ Name, 
    Object^ Position, 
    Object^ Bases, 
    vsCMAccess Access
)

abstract AddEnum : 
        Name:string * 
        Position:Object * 
        Bases:Object * 
        Access:vsCMAccess -> CodeEnum

function AddEnum(
    Name : String, 
    Position : Object, 
    Bases : Object, 
    Access : vsCMAccess
) : CodeEnum

パラメーター

Name
型: System.String
必須。追加する列挙体の名前を指定します。

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

Bases
型: System.Object
省略可能です。既定値は Nothing です。完全修飾型名の SafeArray、または新しい列挙型の基になる型を指定する CodeType オブジェクトの SafeArray を保持するバリアントになります。

Access
型: EnvDTE.vsCMAccess
省略できます。列挙体のアクセスの種類を指定する vsCMAccess 定数を指定します。

戻り値

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

実装

CodeClass.AddEnum(String, Object, Object, vsCMAccess)

解説

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

注意

特定の種類の編集を行うと、クラス、構造体、関数、属性、デリゲートなどのコードモデル要素が非確定的な値になる場合があります。つまり、これらの要素の値は、常に同じ値になるとは限りません。詳細については、「コードモデルを使用したコードの調査 (Visual Basic)」で、コードモデル要素値を変更する方法についての説明を参照してください。

例

[C#]

public void CodeClass2AddEnumExample(DTE2 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.
        TextSelection sel =
            (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass cls =
            (CodeClass)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        object pos = -1; // Place enum at end of members collection
        // Add enum.
        CodeEnum cenum = cls.AddEnum("TestEnum", pos, null, 
            vsCMAccess.vsCMAccessPublic);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}