CodeClass.Access Property

Sets or gets the access attributes of the CodeClass object.

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

Syntax

'Declaration
Property Access As vsCMAccess

vsCMAccess Access { get; set; }

property vsCMAccess Access {
    vsCMAccess get ();
    void set (vsCMAccess value);
}

abstract Access : vsCMAccess with get, set

function get Access () : vsCMAccess
function set Access (value : vsCMAccess)

Property Value

Type: EnvDTE.vsCMAccess
A vsCMAccess value.

Remarks

Access returns the actual access and how other code may access this code element.

Note

This property is read-only for code elements from Visual Basic source code.

Also, 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

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

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