CodeClass.InfoLocation Property

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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 the capabilities of the code model.

public:
 property EnvDTE::vsCMInfoLocation InfoLocation { EnvDTE::vsCMInfoLocation get(); };

public:
 property EnvDTE::vsCMInfoLocation InfoLocation { EnvDTE::vsCMInfoLocation get(); };

[System.Runtime.InteropServices.DispId(7)]
public EnvDTE.vsCMInfoLocation InfoLocation { [System.Runtime.InteropServices.DispId(7)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; }

[<System.Runtime.InteropServices.DispId(7)>]
[<get: System.Runtime.InteropServices.DispId(7)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.InfoLocation : EnvDTE.vsCMInfoLocation

Public ReadOnly Property InfoLocation As vsCMInfoLocation

Property Value

vsCMInfoLocation

A vsCMInfoLocation constant value.

Attributes: DispIdAttribute TypeLibFuncAttribute

Examples

 Sub InfoLocationExample(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 CodeClass = _  
            CType(sel.ActivePoint.CodeElement( _  
            vsCMElement.vsCMElementClass), CodeClass)  

        ' Display the class's location.  
        MsgBox(cls.Name & "'s InfoLocation value is " & _  
            cls.InfoLocation.ToString())  

        Dim cm As CodeModel = _  
            cls.ProjectItem.ContainingProject.CodeModel  
        Dim name As String = ConvertFullName(cm, "System.Object")  
        Dim obj As CodeType = cm.CodeTypeFromFullName(name)  

        ' Display System.Object's location.  
        MsgBox(obj.FullName & "'s InfoLocation value is " & _  
            obj.InfoLocation.ToString())  
    Catch ex As Exception  
        MsgBox(ex.Message)  
    End Try  

End Sub  

Function ConvertFullName(ByVal cm As CodeModel, _  
    ByVal fullName As String) As String  

    ' Convert a .NET type name into a C++ type name.  
    If (cm.Language = CodeModelLanguageConstants.vsCMLanguageVC) Or _  
        (cm.Language = CodeModelLanguageConstants.vsCMLanguageMC) Then  
        Return fullName.Replace(".", "::")  
    Else  
        Return fullName  
    End If  

End Function

public void InfoLocationExample(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;  
        CodeClass cls =   
            (CodeClass)sel.ActivePoint.get_CodeElement(  
            vsCMElement.vsCMElementClass);  

        // Display the class's location.  
        MessageBox.Show(cls.Name + "'s InfoLocation value is " +   
            cls.InfoLocation.ToString());  

        CodeModel cm = cls.ProjectItem.ContainingProject.CodeModel;  
        string name = ConvertFullName(cm, "System.Object");  
        CodeType obj = cm.CodeTypeFromFullName(name);  

        // Display System.Object's location.  
        MessageBox.Show(obj.FullName + "'s InfoLocation value is " +   
            obj.InfoLocation.ToString());  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}  

string ConvertFullName(CodeModel cm, string fullName)  
{  
    // Convert a .NET type name into a C++ type name.  
    if ((cm.Language == CodeModelLanguageConstants.vsCMLanguageVC) ||   
        (cm.Language == CodeModelLanguageConstants.vsCMLanguageMC))  
        return fullName.Replace(".", "::");  
    else  
        return fullName;  
}

Remarks

If InfoLocation returns vsCMInfoLocationProject, then you can set properties, obtain a StartPoint, obtain a EndPoint, and so forth. When you go from one code model object (A) to another (B) — such as from a function to its type or from a class to its base class — B may be of type vsCMInfoLocationExternal if its definition is in another project. The disposition depends on the code model implementation, whether object B's project is implemented in the same language as object A's, and so forth.

If InfoLocation returns vsCMInfoLocationExternal, then information is available only from metadata, from inspecting a DLL, or from frozen sources. You may be able to obtain a StartPoint and EditPoint, but you cannot edit the document. That is, you cannot set properties or modify the text behind the code element.

If InfoLocation returns vsCMInfoLocationNone, then all that is available is a code model object that has a name. Also, based on the context of the source code, in some cases you can tell whether the name should be a class or an interface. In this situation, however, because the code model could not resolve the name to any useful information, the object is otherwise useless.

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

Compartilhar via