CodeClass2.DataTypeKind Property

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.

Sets of gets the relationship of this class with other classes.

public:
 property EnvDTE80::vsCMDataTypeKind DataTypeKind { EnvDTE80::vsCMDataTypeKind get(); void set(EnvDTE80::vsCMDataTypeKind value); };

public:
 property EnvDTE80::vsCMDataTypeKind DataTypeKind { EnvDTE80::vsCMDataTypeKind get(); void set(EnvDTE80::vsCMDataTypeKind value); };

[System.Runtime.InteropServices.DispId(205)]
public EnvDTE80.vsCMDataTypeKind DataTypeKind { [System.Runtime.InteropServices.DispId(205)] get; [System.Runtime.InteropServices.DispId(205)] set; }

[<System.Runtime.InteropServices.DispId(205)>]
[<get: System.Runtime.InteropServices.DispId(205)>]
[<set: System.Runtime.InteropServices.DispId(205)>]
member this.DataTypeKind : EnvDTE80.vsCMDataTypeKind with get, set

Public Property DataTypeKind As vsCMDataTypeKind

Property Value

vsCMDataTypeKind

Returns value from the vsCMDataTypeKind enumeration.

Attributes: DispIdAttribute

Examples

[Visual Basic]

Sub DataTypeKindExample(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  
        ' Retrieve the CodeClass at the insertion point.  
        Dim sel As TextSelection = _  
          CType(dte.ActiveDocument.Selection, TextSelection)  
        Dim cls As CodeClass2 = _  
          CType(sel.ActivePoint.CodeElement( _  
        vsCMElement.vsCMElementClass), CodeClass2)  

        ' Displays the data type kind of the class.  
        Select Case cls.DataTypeKind  
            Case vsCMDataTypeKind.vsCMDataTypeKindBlueprint  
                MsgBox("Class data type: Blueprint")  
            Case vsCMDataTypeKind.vsCMDataTypeKindMain  
                MsgBox("Class data type: Main")  
            Case vsCMDataTypeKind.vsCMDataTypeKindModule  
                MsgBox("Class data type: Module")  
            Case vsCMDataTypeKind.vsCMDataTypeKindPartial  
                MsgBox("Class data type: Partial")  
        End Select  

    Catch ex As System.Exception  
        MsgBox(ex.ToString)  
    End Try  
End Sub

[C#]

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

        // Display the data type kind of the class.  
        MessageBox.Show("Class data type kind: " + cls.DataTypeKind);  
    }  
    catch (System.Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}

Remarks

For example, if this is the main class of a partial, this call returns vsCMDataTypeKindMain. If it is a partial class, it returns vsCMDataTypeKindPartial.

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