FileCodeModel.AddEnum - метод

Статья
11/05/2008

Обновлен: Ноябрь 2007

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

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

Синтаксис

'Декларация
Function AddEnum ( _
    Name As String, _
    Position As Object, _
    Bases As Object, _
    Access As vsCMAccess _
) As CodeEnum
'Применение
Dim instance As FileCodeModel
Dim Name As String
Dim Position As Object
Dim Bases As Object
Dim Access As vsCMAccess
Dim returnValue As CodeEnum

returnValue = instance.AddEnum(Name, Position, _
    Bases, Access)

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

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

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

Параметры

Name
Тип: System.String
Обязательный. Имя добавляемого перечисления.

Position
Тип: System.Object
Необязательный. По умолчанию = 0. Элемент кода, после которого вставляется новый элемент. Если значение CodeElement, новый элемент добавляется непосредственно после него.
Если значение имеет тип данных Long, AddEnum указывает, после какого элемента следует добавить новый элемент.
Поскольку в коллекциях нумерация элементов начинается с 1, значение 0 означает, что новый элемент следует поместить в начало коллекции. Значение -1 означает, что элемент следует поместить в конец.

Bases
Тип: System.Object
Необязательный. По умолчанию = Nothing. Переменная типа variant, содержащая массив типа SafeArray полных имен типов или объектов CodeType, каждый из которых определяет базовый тип нового перечисления.

Access
Тип: EnvDTE.vsCMAccess
Необязательный. Константа vsCMAccess.

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

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

Заметки

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

Примеры

Sub AddEnumExample(ByVal dte As DTE2)

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

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

End Sub

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

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

Разрешения

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