CodeModel.AddNamespace メソッド

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

新しい名前空間コード構成を作成し、適切な位置にコードを挿入します。

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

構文

'宣言
Function AddNamespace ( _
    Name As String, _
    Location As Object, _
    Position As Object _
) As CodeNamespace
'使用
Dim instance As CodeModel
Dim Name As String
Dim Location As Object
Dim Position As Object
Dim returnValue As CodeNamespace

returnValue = instance.AddNamespace(Name, _
    Location, Position)

CodeNamespace AddNamespace(
    string Name,
    Object Location,
    Object Position
)

CodeNamespace^ AddNamespace(
    String^ Name, 
    Object^ Location, 
    Object^ Position
)

function AddNamespace(
    Name : String, 
    Location : Object, 
    Position : Object
) : CodeNamespace

パラメータ

Name
型 : System.String

必ず指定します。新しい名前空間の名前。

Location
型 : System.Object

必ず指定します。新しい名前空間定義のパスとファイル名。ファイル名は、言語に応じて、プロジェクトファイルへの相対パスまたは絶対パスで表されます。ファイルが既にプロジェクト項目になっていない場合は、ファイルがプロジェクトに追加されます。ファイルを作成してプロジェクトに追加できない場合、AddNamespace は失敗します。

Position
型 : System.Object

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

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

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

戻り値

型 : EnvDTE.CodeNamespace

CodeNamespace オブジェクト。

解説

ネイティブな Visual C++ では、コロン区切り形式 (::) で完全修飾型名を指定する必要があります。他のすべての言語では、ピリオド区切りの書式がサポートされます。

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

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

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

例

Sub AddNamespaceCodeModel(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project.
    Try
        ' Create a new namespace.
        Dim projItem As ProjectItem = dte.ActiveDocument.ProjectItem
        Dim cm As CodeModel = projItem.ContainingProject.CodeModel
        cm.AddNamespace("TestNamespace", projItem.Name)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AddNamespaceCodeModel(DTE2 dte)
{
    // Before running this example, open a code document from 
    // a project.
    try
    {
        // Create a new namespace.
        ProjectItem projItem = dte.ActiveDocument.ProjectItem;
        CodeModel cm = projItem.ContainingProject.CodeModel;
        cm.AddNamespace("TestNamespace", projItem.Name, -1);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}