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

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

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

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

構文

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

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

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

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

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

パラメーター

Name
型: System.String
必須。追加する列挙型の名前。

Location
型: System.Object
必須。新しい列挙型定義のパスとファイル名。言語に応じて、ファイル名はプロジェクトファイルへの相対パスまたは絶対パスで表されます。ファイルが既にプロジェクト項目になっていない場合は、ファイルがプロジェクトに追加されます。ファイルを作成してプロジェクトに追加できない場合は、AddEnum が失敗します。

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

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

Access
型: EnvDTE.vsCMAccess
省略可能です。定数 vsCMAccess。

戻り値

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

実装

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

解説

引数が正しいかどうかは、コードモデルの背後にある言語によって決まります。 Bases パラメーターはすべての言語で無視されます。

注意

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

例

Sub AddEnumExample2(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project.
    Try
        Dim projItem As ProjectItem = dte.ActiveDocument.ProjectItem
        Dim cm As CodeModel = projItem.ContainingProject.CodeModel

        ' Create a new enum.
        cm.AddEnum("TestEnum", projItem.Name)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AddEnumExample2(DTE2 dte)
{
    // Before running this example, open a code document from 
    // a project.
    try
    {
        ProjectItem projItem = dte.ActiveDocument.ProjectItem;
        CodeModel cm = projItem.ContainingProject.CodeModel;

        // Create a new enum.
        cm.AddEnum("TestEnum", projItem.Name, -1, null, 
            vsCMAccess.vsCMAccessPublic);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}