FileCodeModel.AddNamespace(String, Object) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

EnvDTE::CodeNamespace AddNamespace(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Position);

[System.Runtime.InteropServices.DispId(7)]
public EnvDTE.CodeNamespace AddNamespace (string Name, object Position);

[<System.Runtime.InteropServices.DispId(7)>]
abstract member AddNamespace : string * obj -> EnvDTE.CodeNamespace

Public Function AddNamespace (Name As String, Optional Position As Object) As CodeNamespace

Parameters

Name: String

Required. The name of the new namespace.

Position: 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 data type, then AddNamespace(String, Object) 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.

Returns

CodeNamespace

A CodeNamespace object.

Attributes: DispIdAttribute

Examples

Sub AddNamespaceExample(ByVal dte As DTE2)  

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

End Sub

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

Remarks

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.

Applies to

Partager via