CodeClass2.AddEnum 方法

在类中创建一个新枚举。

命名空间:  EnvDTE80
程序集:  EnvDTE80(在 EnvDTE80.dll 中)

语法

声明
Function AddEnum ( _
    Name As String, _
    Position As Object, _
    Bases As Object, _
    Access As vsCMAccess _
) As CodeEnum
CodeEnum AddEnum(
    string Name,
    Object Position,
    Object Bases,
    vsCMAccess Access
)
CodeEnum^ AddEnum(
    String^ Name, 
    Object^ Position, 
    Object^ Bases, 
    vsCMAccess Access
)
abstract AddEnum : 
        Name:string * 
        Position:Object * 
        Bases:Object * 
        Access:vsCMAccess -> CodeEnum
function AddEnum(
    Name : String, 
    Position : Object, 
    Bases : Object, 
    Access : vsCMAccess
) : CodeEnum

参数

  • Name
    类型:String

    必选。 要添加的枚举的名称。

  • Position
    类型:Object

    可选。 默认值 = 0。 将在其后添加新元素的代码元素。 如果该值为 CodeElement,则紧跟在其后添加新元素。

    如果该值为 Long,则 Position 指示在哪个元素的后面添加新元素。

    因为集合从 1 开始计数,所以传递 0 指示应将新元素放置在集合的开始处。 值为 -1 表示应将元素放在结尾处。

  • Bases
    类型:Object

    可选。 默认为 Nothing。 一个保存 SafeArray 的变量,该 SafeArray 包含用于指定新建枚举的基础类型的完全限定类型名或 CodeType 对象。

  • Access
    类型:vsCMAccess

    可选。 一个指定枚举的访问类型的 vsCMAccess 常数。

返回值

类型:CodeEnum
一个 CodeEnum 对象。

备注

参数正确与否由代码模型后面的语言决定。

备注

在进行某些类型的编辑之后,代码模型元素(如类、结构、函数、特性、委托等)的值可能是非确定性的,这意味着不能指望它们的值总是保持不变。有关更多信息,请参见 使用代码模型查找代码 (Visual Basic) 中的“代码模型元素的值可能会更改”一节。

示例

[C#]

public void CodeClass2AddEnumExample(DTE2 dte2)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel =
            (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass cls =
            (CodeClass)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        object pos = -1; // Place enum at end of members collection
        // Add enum.
        CodeEnum cenum = cls.AddEnum("TestEnum", pos, null, 
            vsCMAccess.vsCMAccessPublic);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

.NET Framework 安全性

请参阅

参考

CodeClass2 接口

EnvDTE80 命名空间

其他资源

如何:编译和运行自动化对象模型代码示例

使用代码模型查找代码 (Visual Basic)

使用代码模型查找代码 (Visual C#)