Freigeben über


CodeClass2.AddEnum(String, Object, Object, vsCMAccess) Method

Definition

Creates a new enumeration in the class.

EnvDTE::CodeEnum AddEnum(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Position, winrt::Windows::Foundation::IInspectable const & Bases, EnvDTE::vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);
[System.Runtime.InteropServices.DispId(69)]
public EnvDTE.CodeEnum AddEnum (string Name, object Position, object Bases, EnvDTE.vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);
[<System.Runtime.InteropServices.DispId(69)>]
abstract member AddEnum : string * obj * obj * EnvDTE.vsCMAccess -> EnvDTE.CodeEnum
Public Function AddEnum (Name As String, Optional Position As Object, Optional Bases As Object, Optional Access As vsCMAccess = EnvDTE.vsCMAccess.vsCMAccessDefault) As CodeEnum

Parameters

Name
String

Required. The name of the enumeration to add.

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, then Position 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.

Bases
Object

Optional. Default = Nothing. A variant that holds a SafeArray of fully qualified type names or CodeType objects that specify the underlying type of the new enum.

Access
vsCMAccess

Optional. A vsCMAccess constant specifying the enumeration's access type.

Returns

A CodeEnum object.

Implements

Attributes

Examples

[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);  
    }  
}  

Remarks

The correctness of the arguments is determined by the language behind the code model.

Note

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Applies to