Share via

CodeClass.Kind Property

  • Article

Returns an enumeration indicating the type of object.

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

Syntax

'Declaration
ReadOnly Property Kind As vsCMElement

vsCMElement Kind { get; }

property vsCMElement Kind {
    vsCMElement get ();
}

abstract Kind : vsCMElement with get

function get Kind () : vsCMElement

Property Value

Type: EnvDTE.vsCMElement
A vsCMElement value.

Remarks

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).

Examples

Public Sub CodeClassExample(ByVal dte As DTE2) 
    ' Before running this example, open a code document from a
    ' project and place the insertion point inside a class definition
    Try
        Dim objTextSel As TextSelection
        Dim objCodeCls As CodeClass
        Dim objCodeType As CodeType
        Dim objCMElem As vsCMElement
        objTextSel = CType(dte.ActiveDocument.Selection, TextSelection)
        objCodeCls = CType(objTextSel.ActivePoint.CodeElement(vsCMElement.vsCMElementClass), CodeClass)
        ' Add DocComment to CodeClass objCodeClass.
        objCodeCls.DocComment = "<DOC>DocComment for the CodeClass object</DOC>"
        MessageBox.Show(objCodeCls.DocComment)
        ' Test if a CodeType object is obtainable from the CodeClass
        If objCodeCls.IsCodeType Then
            ' then we can cast the CodeClass to a CodeType.
            objCodeType = CType(objCodeCls, CodeType)
        Else
            ' The CodeClass object is not a CodeType but is
            ' some Kind of element.
            objCMElem = objCodeCls.Kind
        End If
    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
End Sub

public void CodeClassExample(DTE2 dte)
{ 
   // Before running this example, open a code document from a
   // project and place the insertion point inside a class definition.
   try
   {
      TextSelection objTextSel;
      CodeClass objCodeCls;
      CodeType objCodeType;
      vsCMElement objCMElem;
      objTextSel = (TextSelection)dte.ActiveDocument.Selection;
      objCodeCls = (CodeClass)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementClass);
      // Add DocComment to CodeClass objCodeClass.
      objCodeCls.DocComment = "<DOC>DocComment for the CodeClass object</DOC>";
      MessageBox.Show(objCodeCls.DocComment);
      // Test if a CodeType object is obtainable from the CodeClass
      if (objCodeCls.IsCodeType)
      { // then we can cast the CodeClass to a CodeType.
         objCodeType = (CodeType)objCodeCls;
      }
      else // The CodeClass object is not a CodeType but is
      {    // some Kind of element.
         objCMElem = objCodeCls.Kind;
      }
   }
   catch (Exception ex)
   { 
      MessageBox.Show(ex.Message);
   }
}

.NET Framework Security

See Also

Reference

CodeClass Interface

EnvDTE Namespace

Other Resources

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

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)