CodeFunction.IsShared Property

  • Article

Sets or gets whether or not the item is statically defined, that is, whether the item is common to all instances of this object type or only to this object specifically.

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

Syntax

'Declaration
Property IsShared As Boolean

bool IsShared { get; set; }

property bool IsShared {
    bool get ();
    void set (bool value);
}

abstract IsShared : bool with get, set

function get IsShared () : boolean
function set IsShared (value : boolean)

Property Value

Type: System.Boolean
A Boolean value indicating true if the method is shared; false if otherwise.

Remarks

IsShared returns or sets whether the method is associated with a class or with instances of a class. Note that setting this might yield language-dependent errors. Although IsShared returns successfully, it does not mean the resulting code change compiles successfully.

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

 Sub IsSharedExample(ByVal dte As DTE2)

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

        If fun.IsShared Then
            MsgBox(fun.Name & " is an instance method.")
        Else
            MsgBox(fun.Name & " is not an instance method.")
        End If
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

 public void IsSharedExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a function.
    try
    {
        // Retrieve the CodeFunction at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeFunction fun = 
            (CodeFunction)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementFunction);

        if (fun.IsShared)
            MessageBox.Show(fun.Name + " is an instance method.");
        else
            MessageBox.Show(fun.Name + " is not an instance method.");
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

.NET Framework Security

See Also

Reference

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