CodeClass2.IsCodeType Property

  • Article

Gets a value indicating whether a CodeType object can be obtained from the code class.

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

Syntax

'Declaration
ReadOnly Property IsCodeType As Boolean

bool IsCodeType { get; }

property bool IsCodeType {
    bool get ();
}

abstract IsCodeType : bool with get

function get IsCodeType () : boolean

Property Value

Type: System.Boolean
A boolean value that is true if a CodeType object can be obtained, otherwise returns false.

Remarks

IsCodeType returns whether the code class is a code type. If it is, then you can query interface (QI) 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).

Examples

[C#]

public void CodeClass2IsCodeTypeExample(DTE2 dte2)
{
    // Before running this example, open a code document from a project
    // and place the insertion point within a class definition.
    try
    {   // Get the CodeClass2 at the insertion point.
        TextSelection sel = 
        (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls = (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Test if element is a code type.
        if (cls.IsCodeType)
        {
            MessageBox.Show("Element is a code type");
            // Test if element is a class.
            if (cls.Kind == vsCMElement.vsCMElementClass)
                MessageBox.Show("This element is a class");
        }
    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
    }
}

.NET Framework Security

See Also

Reference

CodeClass2 Interface

EnvDTE80 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#)