Freigeben über


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

Definition

Creates a new enumeration code construct and inserts the code in the correct location.

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(14)]
public EnvDTE.CodeEnum AddEnum (string Name, object Position, object Bases, EnvDTE.vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);
[<System.Runtime.InteropServices.DispId(14)>]
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 enum 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 data type, then AddEnum(String, Object, Object, vsCMAccess) 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 enumeration.

Access
vsCMAccess

Optional. A vsCMAccess constant.

Returns

A CodeEnum object.

Implements

Attributes

Examples

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

Remarks

The correctness of the arguments is determined by the language behind the code model. All languages ignore the Bases parameter.

Applies to