CodeAttribute2.ProjectItem Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the ProjectItem associated with the code attribute.

public:
 property EnvDTE::ProjectItem ^ ProjectItem { EnvDTE::ProjectItem ^ get(); };

public:
 property EnvDTE::ProjectItem ^ ProjectItem { EnvDTE::ProjectItem ^ get(); };

[System.Runtime.InteropServices.DispId(4)]
public EnvDTE.ProjectItem ProjectItem { [System.Runtime.InteropServices.DispId(4)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; }

[<System.Runtime.InteropServices.DispId(4)>]
[<get: System.Runtime.InteropServices.DispId(4)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.ProjectItem : EnvDTE.ProjectItem

Public ReadOnly Property ProjectItem As ProjectItem

Property Value

ProjectItem

Returns a ProjectItem object.

Implements

ProjectItem

Attributes

DispIdAttribute TypeLibFuncAttribute

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 += "Project Item Name: " +   
                cmAttribute.ProjectItem.Name + Environment.NewLine;  
                msg += "Startpoint DisplayColumn: " +   
                cmAttribute.StartPoint.DisplayColumn +   
                Environment.NewLine;  
                msg += "Target: " + cmAttribute.Target +   
                Environment.NewLine;  
                msg += "Value: " + cmAttribute.Value +   
                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;  
}  

Remarks

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).