CodeClass.IsCodeType Property

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.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.

Gets whether a CodeType object can be obtained from this object.

public:
 property bool IsCodeType { bool get(); };

public:
 property bool IsCodeType { bool get(); };

[System.Runtime.InteropServices.DispId(6)]
public bool IsCodeType { [System.Runtime.InteropServices.DispId(6)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; }

[<System.Runtime.InteropServices.DispId(6)>]
[<get: System.Runtime.InteropServices.DispId(6)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.IsCodeType : bool

Public ReadOnly Property IsCodeType As Boolean

Property Value

Boolean

A Boolean value indicating true if a CodeType object can be obtained, otherwise returns false.

Attributes: DispIdAttribute TypeLibFuncAttribute

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

Remarks

Returns whether the code element is a code type. If it is, then you can query interface or cast it to a CodeType object. This is true when Kind is vsCMElementClass, vsCMElementInterface, vsCMElementDelegate, vsCMElementStruct, or vsCMElementEnum.

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

Partager via