CodeClass.FullName Property

  • Article

Gets the full path and name of the CodeClass object's source file.

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

Syntax

'Declaration
ReadOnly Property FullName As String

string FullName { get; }

property String^ FullName {
    String^ get ();
}

abstract FullName : string with get

function get FullName () : String

Property Value

Type: System.String
A string representing the full path and name of the CodeClass object's source file.

Remarks

The FullName property is known as the FileName property in some versions of Visual Studio.

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

Public Sub CodeClassExample(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
        Dim objTextSel As TextSelection
        Dim objCodeCls As CodeClass
        Dim objCodeElem As CodeElement
        objTextSel = CType(dte.ActiveDocument.Selection, TextSelection)
        objCodeCls = CType(objTextSel.ActivePoint.CodeElement(vsCMElement.vsCMElementClass), CodeClass)
        ' Display the fullname of CodeClass object.
        MessageBox.Show(objCodeCls.FullName)
        ' Prove that the parent object of a CodeClass is a CodeElement.
        objCodeElem = CType(objCodeCls.Parent, CodeElement)
        ' Get access privilege for CodeClass.
        MessageBox.Show(objCodeCls.Access.ToString())
        ' Change access privilege for CodeClass objCodeCls.
        ' Note the change in access keyword in your code document.
        objCodeCls.Access = vsCMAccess.vsCMAccessPublic
    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
End Sub

public void CodeClassExample(DTE2 dte)
{ 
   // Before running this example, open a code document from a
   // project and place the insertion point inside a class definition.
   try
   {
      TextSelection objTextSel;
      CodeClass objCodeCls;
      CodeElement objCodeElem;
      objTextSel = (TextSelection)dte.ActiveDocument.Selection;
      objCodeCls = (CodeClass)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementClass);
      // Display the fullname of CodeClass object.
      MessageBox.Show(objCodeCls.FullName);
      // Prove that the parent object of a CodeClass is a CodeElement.
      objCodeElem = (CodeElement)objCodeCls.Parent;
      // Get access privilege for CodeClass.
      MessageBox.Show(objCodeCls.Access.ToString());
      // Change access privilege for CodeClass objCodeCls.
      // Note the change in access keyword in your code document.
      objCodeCls.Access = vsCMAccess.vsCMAccessPublic;
   }
   catch (Exception ex)
   { 
      MessageBox.Show(ex.Message);
   }

.NET Framework Security

See Also

Reference

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