CodeClass2.InfoLocation - свойство

Статья
11/05/2008

Обновлен: Ноябрь 2007

Возвращает сведения о возможностях модели кода.

Пространство имен: EnvDTE80
Сборка: EnvDTE80 (в EnvDTE80.dll)

Синтаксис

'Декларация
ReadOnly Property InfoLocation As vsCMInfoLocation
'Применение
Dim instance As CodeClass2
Dim value As vsCMInfoLocation

value = instance.InfoLocation

vsCMInfoLocation InfoLocation { get; }

property vsCMInfoLocation InfoLocation {
    vsCMInfoLocation get ();
}

function get InfoLocation () : vsCMInfoLocation

Значение свойства

Тип: EnvDTE.vsCMInfoLocation
Значение константы vsCMInfoLocation.

Реализации

CodeClass.InfoLocation

Заметки

Если свойство InfoLocation возвращает значение vsCMInfoLocationProject, то можно задать свойства, получить StartPoint, EndPoint и т. д. При переходе от одного объекта модели кода (A) к другому (B) — например, от функции к ее типу или от класса к базовому классу — объект B может иметь тип vsCMInfoLocationExternal, если его определение находится в другом проекте. Размещение зависит от реализации модели кода, от того, реализованы ли проекты объектов A и B на одном языке, и т. д.

Если InfoLocation возвращает vsCMInfoLocationExternal, то сведения можно извлечь только из метаданных, из просмотра DLL-библиотек или из замороженных источников. При этом можно получить значения StartPoint и EditPoint, но невозможно редактировать документ; то есть нельзя задавать свойства или изменять текст, находящийся за элементом кода.

Если InfoLocation возвращает vsCMInfoLocationNone, то доступен только объект модели кода, имеющий имя. Кроме того, в зависимости от контекста исходного кода в некоторых случаях можно понять, должно ли имя быть именем класса или интерфейса. Однако в такой ситуации, поскольку модель кода не может разрешить данное имя, вернув какие бы то ни было полезные сведения, объект оказывается бесполезен.

Примечание.
Значения элементов модели кода, таких как классы, структуры, функции, атрибуты, делегаты и другие, после внесения некоторых изменений могут оказаться недетерминированными, другими словами, нельзя рассчитывать, что их значения будут всегда оставаться одинаковыми. Дополнительные сведения см. в разделе "Значения элементов модели кода могут изменяться" в разделе Практическое руководство. Поиск кода при помощи модели кода (Visual Basic).

Значения элементов модели кода, таких как классы, структуры, функции, атрибуты, делегаты и другие, после внесения некоторых изменений могут оказаться недетерминированными, другими словами, нельзя рассчитывать, что их значения будут всегда оставаться одинаковыми. Дополнительные сведения см. в разделе "Значения элементов модели кода могут изменяться" в разделе Практическое руководство. Поиск кода при помощи модели кода (Visual Basic).

Примеры

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

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.