CodeElement.InfoLocation Property

  • Article

Gets the capabilities of the code model.

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

Syntax

'Declaration
ReadOnly Property InfoLocation As vsCMInfoLocation

vsCMInfoLocation InfoLocation { get; }

property vsCMInfoLocation InfoLocation {
    vsCMInfoLocation get ();
}

abstract InfoLocation : vsCMInfoLocation with get

function get InfoLocation () : vsCMInfoLocation

Property Value

Type: EnvDTE.vsCMInfoLocation
A vsCMInfoLocation constant value.

Remarks

If InfoLocation returns vsCMInfoLocationProject, then you can set properties, obtain a StartPoint, obtain an 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, inspecting a DLL, or from frozen sources. You may be able to obtain a StartPoint, obtain an 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 real, 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).

.NET Framework Security

See Also

Reference

CodeElement Interface

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