FileCodeModel2.AddEnum 方法 (String, Object, Object, vsCMAccess)

2008-09-04

更新：2007 年 11 月

创建新的枚举代码构造，并将代码插入正确的位置。

命名空间： EnvDTE80
程序集： EnvDTE80（在 EnvDTE80.dll 中）

语法

声明
Function AddEnum ( _
    Name As String, _
    Position As Object, _
    Bases As Object, _
    Access As vsCMAccess _
) As CodeEnum
用法
Dim instance As FileCodeModel2
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。一个保存 SafeArray 的变量，该 SafeArray 包含用于指定新建枚举的基础类型的完全限定类型名或 CodeType 对象。

Access
类型：EnvDTE.vsCMAccess

可选。一个 vsCMAccess 常数。

返回值

类型：EnvDTE.CodeEnum

一个 CodeEnum 对象。

实现

FileCodeModel.AddEnum(String, Object, Object, vsCMAccess)

备注

参数正确与否由代码模型后面的语言决定。所有语言都忽略 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);
    }
}