FileCodeModel.AddEnum Method

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

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
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

Parameters

• Name
  Type: System.String

  Required. The name of the enum to add.

• Position
  Type: System.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 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
  Type: System.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
  Type: EnvDTE.vsCMAccess

  Optional. A vsCMAccess constant.

Return Value

Type: EnvDTE.CodeEnum
A CodeEnum object.

Remarks

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

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

FileCodeModel Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples