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

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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 & Location, winrt::Windows::Foundation::IInspectable const & Position, winrt::Windows::Foundation::IInspectable const & Bases, EnvDTE::vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);

[System.Runtime.InteropServices.DispId(12)]
public EnvDTE.CodeEnum AddEnum (string Name, object Location, object Position, object Bases, EnvDTE.vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);

[<System.Runtime.InteropServices.DispId(12)>]
abstract member AddEnum : string * obj * obj * obj * EnvDTE.vsCMAccess -> EnvDTE.CodeEnum

Public Function AddEnum (Name As String, Location As Object, 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.

Location: Object

Required. The path and file name for the new enum definition. Depending on the language, the file name is either relative or absolute to the project file. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddEnum(String, Object, Object, Object, vsCMAccess) fails.

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, 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 enum.

Access: vsCMAccess

Optional. A vsCMAccess constant.

Returns

CodeEnum

A CodeEnum object.

Implements

AddEnum(String, Object, Object, Object, vsCMAccess)

Attributes: DispIdAttribute

Examples

Sub AddEnumExample2(ByVal dte As DTE2)  

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

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

End Sub

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

        // Create a new enum.  
        cm.AddEnum("TestEnum", projItem.Name, -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.

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.

Applies to

Partager via