CodeEvent.Name Property

  • Article

Gets or sets the name of the CodeEvent object.

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

Syntax

'Declaration
Default Property Name As String

string this { get; set; }

property String^ default {
    String^ get ();
    void set (String^ value);
}

abstract Name : string with get, set

function get Name () : String 
function set Name (value : String)

Property Value

Type: System.String
The name of the CodeEvent object.

Remarks

The object name does not include the name of the class that contains the event object.

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

The following example demonstrates how to use the Name property.

To test this property:

  1. Open the target project and select the code event element by placing the cursor on the event object.

  2. Run the add-in.

public static void Name(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nName property: " +
                    codeEvent.Name, "Testing CodeEvent");
}

.NET Framework Security

See Also

Reference

CodeEvent Interface

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