CodeClass.Access Property

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets or gets the access attributes of the CodeClass object.

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

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

[System.Runtime.InteropServices.DispId(35)]
public EnvDTE.vsCMAccess Access { [System.Runtime.InteropServices.DispId(35)] get; [System.Runtime.InteropServices.DispId(35)] set; }

[<System.Runtime.InteropServices.DispId(35)>]
[<get: System.Runtime.InteropServices.DispId(35)>]
[<set: System.Runtime.InteropServices.DispId(35)>]
member this.Access : EnvDTE.vsCMAccess with get, set

Public Property Access As vsCMAccess

Property Value

vsCMAccess

A vsCMAccess value.

Attributes: DispIdAttribute

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);  
   }

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

Applies to

Compartilhar via