CodeVariable.Access Property

Defines the access modifier of this item.

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

Sub AccessExample(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project
    ' and place the insertion point inside a variable definition.
    Try
        ' Retrieve the CodeVariable at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim var As CodeVariable = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementVariable), CodeVariable)

        ' Display the CodeVariable's accessibility.
        Dim access As String
        Dim varAccess As vsCMAccess = var.Access
        Dim val As vsCMAccess
        For Each val In [Enum].GetValues(varAccess.GetType())
            If (val And varAccess) <> 0 Then
                access &= val.ToString() & vbCrLf
            End If
        Next

        MsgBox(var.Name & " has the following accessibility:" & _
            vbCrLf & vbCrLf & access)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AccessExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a variable definition.
    try
    {
        // Retrieve the CodeVariable at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeVariable var = 
            (CodeVariable)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementVariable);

        // Display the CodeVariable's accessibility.
        string access = "";
        vsCMAccess varAccess = var.Access;

        foreach (vsCMAccess val in Enum.GetValues(varAccess.GetType()))
        {
            if ((val & varAccess) != 0)
                access += val.ToString() + "\r\n";
        }

        MessageBox.Show(var.Name + 
            " has the following accessibility:\r\n\r\n" + access);
    }
    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

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