Share via

CodeModel2.AddNamespace Method

  • Article

Creates a new namespace code construct and inserts the code in the correct location.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
Function AddNamespace ( _
    Name As String, _
    Location As Object, _
    Position As Object _
) As CodeNamespace

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

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

abstract AddNamespace : 
        Name:string * 
        Location:Object * 
        Position:Object -> CodeNamespace

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

Parameters

  • Name
    Type: System.String

    Required. The name of the new namespace.

  • Location
    Type: System.Object

    Required. The path and file name for the new namespace definition. Depending on the language, the file name is either relative or absolute to the project file. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddNamespace fails.

  • Position
    Type: System.Object

    Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.

    If the value is a Long, then AddNamespace indicates the element after which to add the new element.

    Because collections begin their count at 1, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means the element should be placed at the end.

Return Value

Type: EnvDTE.CodeNamespace
A CodeNamespace object.

Remarks

Native Visual C++ requires the colon-separated (::) format for its fully qualified type names; all other languages support the period-separated format.

The correctness of the arguments is determined by the language behind the code model.

Note

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Examples

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);
    }
}

.NET Framework Security

See Also

Reference

CodeModel2 Interface

EnvDTE80 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)