CodeModel.AddNamespace - метод

Статья
05/17/2015

Создает новую конструкцию кода пространства имен и вставляет код в нужное место.

Пространство имен: EnvDTE
Сборка: EnvDTE (в EnvDTE.dll)

Синтаксис

'Декларация
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

Параметры

Name
Тип: String

Обязательный. Имя нового пространства имен.

Location
Тип: Object

Обязательный. Путь и имя файла для нового определения пространства имен. В зависимости от языка имя файла может быть либо относительным, либо абсолютным по отношению к файлу проекта. Файл добавляется к проекту, если он не является его частью. Если файл не может быть создан и добавлен к проекту, метод AddNamespace дает сбой.

Position
Тип: Object

Необязательно. Значение по умолчанию: 0 Элемент кода, после которого добавляется новый элемент. Если значением является CodeElement, новый элемент добавляется непосредственно после него.

Если значение имеет тип данных Long, AddNamespace указывает, после какого элемента следует добавить новый элемент.

Поскольку в коллекциях нумерация элементов начинается с 1, значение 0 означает, что новый элемент следует поместить в начало коллекции. Значение -1 означает, что элемент следует поместить в конец.

Возвращаемое значение

Тип: EnvDTE.CodeNamespace
Объект CodeNamespace.

Заметки

Для полностью уточненных имен типов в Visual C++ необходимо использовать формат с разделителем в виде двух двоеточий (::). Все остальные языки поддерживают формат с разделителем-точкой.

Правильность аргументов определяется языком, на котором основана модель кода.

Примечание

Значения элементов модели кода, таких как классы, структуры, функции, атрибуты, делегаты и другие, после внесения некоторых изменений могут оказаться недетерминированными, другими словами, нельзя рассчитывать, что их значения будут всегда оставаться одинаковыми.Дополнительные сведения см. в разделе "Значения элементов модели кода могут изменяться" в разделе Практическое руководство. Поиск кода при помощи модели кода (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);
    }
}

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Для получения дополнительной информации см. Использование библиотек из не вполне надежного кода.