Share via

CodeAttribute2.InfoLocation Property

  • Article

Gets the code model.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.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 the InfoLocation property returns vsCMInfoLocationProject, then you can set properties, obtain a StartPoint, and 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 the InfoLocation property returns vsCMInfoLocationExternal, then information is available only from metadata in a DLL or from frozen sources. You may be able to obtain a StartPoint and EditPoint, but you cannot edit the document. In other words, 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 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).

Examples

The following example creates a new namespace and attribute in the current class and lists some of the attribute's properties.

public void CreateClassAndAttrib(DTE2 applicationObject)
{
    // Before running, load or create a project.
    FileCodeModel2 fcm2 = GetFileCodeModel(applicationObject);
    CodeAttribute2 cmAttribute;
    CodeClass2 cmClass;
    String msg = null;

    if (fcm2 != null)
    {
        CodeNamespace cmNamespace;
        // Try to create a new namespace.
        try
        {
            cmNamespace = fcm2.AddNamespace("CMNamespace", -1);
            // If successful, create the other code elements.
            if (cmNamespace != null)
            {
                cmClass = (CodeClass2)cmNamespace.AddClass("ANewClass", 
                -1, null, null, vsCMAccess.vsCMAccessPrivate);
                cmAttribute = (CodeAttribute2)cmClass.AddAttribute
                ("NewAttribute", "AttributeValue", -1);
                msg += "InfoLocation: " + cmAttribute.InfoLocation + 
                Environment.NewLine;
                msg += "IsCodeType?: " + cmAttribute.IsCodeType + 
                Environment.NewLine;
                msg += "Kind: " + cmAttribute.Kind + 
                Environment.NewLine;
                MessageBox.Show(msg);                       
            }
            else
            {
                MessageBox.Show("Cannot continue - no filecodemodel 
                available.");
            }
        }
        catch (Exception ex)
        {
            MessageBox.Show("ERROR: " + ex);
        }
    }
}

public FileCodeModel2 GetFileCodeModel(DTE2 applicationObject)
{
    // Returns the FileCodeModel object of the active 
    // window.
    TextWindow txtWin = 
    (TextWindow)applicationObject.ActiveWindow.Object;
    FileCodeModel2 fcm2;
    if (txtWin != null)
    {
        try
        {
             fcm2 = (FileCodeModel2)txtWin.Parent.
             ProjectItem.FileCodeModel;
             return fcm2;
        }
        catch (Exception ex)
        {
             MessageBox.Show("ERROR: " + ex);
             return null;
        }
    }
    else
        return null;
}

.NET Framework Security

See Also

Reference

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