Partager via

CodeEvent Interface

  • Article

Models a code event element.

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

Syntax

'Declaration
<GuidAttribute("CE615BD2-8ED5-4F0C-A7B6-4A299D8801FD")> _
Public Interface CodeEvent

[GuidAttribute("CE615BD2-8ED5-4F0C-A7B6-4A299D8801FD")]
public interface CodeEvent

[GuidAttribute(L"CE615BD2-8ED5-4F0C-A7B6-4A299D8801FD")]
public interface class CodeEvent

[<GuidAttribute("CE615BD2-8ED5-4F0C-A7B6-4A299D8801FD")>]
type CodeEvent =  interface end

public interface CodeEvent

The CodeEvent type exposes the following members.

Properties

  Name Description
Public property Access Gets or sets a value that determines how a code event element may be accessed by other code.
Public property Adder Gets or sets the event listeners.
Public property Attributes Gets a CodeElements collection of attributes for this code event element.
Public property Children Gets a collection of objects contained within this CodeEvent.
Public property Collection Gets a CodeElements collection.
Public property Comment Gets or sets a header comment associated with the code event element.
Public property DocComment Gets or sets a documentation comment associated with the code event element.
Public property DTE Gets the top-level extensibility object.
Public property EndPoint Gets the location in the source file marked as an end of the code event element.
Public property Extender Gets the requested Extender if it is available for this CodeElement object.
Public property ExtenderCATID Gets the Extender category ID (CATID) for the object.
Public property ExtenderNames Gets a list of available Extenders for the object.
Public property FullName Gets a fully-qualified name of the specified CodeEvent object.
Public property InfoLocation Gets the capabilities of the code model.
Public property IsCodeType Gets whether the CodeEvent is a CodeType.
Public property IsPropertyStyleEvent Gets a value indicating whether the event has separate methods for adding/ removing events and throwing exceptions.
Public property IsShared Gets of sets the shared (static) status of the event.
Public property Kind Gets the type of the code element.
Public property Language Gets the programming language used to author the code.
Public property Name Gets or sets the name of the CodeEvent object.
Public property OverrideKind Gets of sets the override modifiers on a code event.
Public property Parent Gets the immediate parent object of the CodeEvent object.
Public property ProjectItem Gets the ProjectItem object associated with the CodeEvent object.
Public property Prototype Gets a string containing the description of a code event element.
Public property Remover Gets or sets the event listeners.
Public property StartPoint Gets the location in the source file marked as a beginning of the code event element.
Public property Thrower Gets or sets CodeFunction object.
Public property Type Gets or sets the type of the CodeTypeReference object.

Top

Methods

  Name Description
Public method AddAttribute Creates a new attribute code construct and inserts the code in the correct location.
Public method GetEndPoint Gets a TextPoint object that marks the end of the code event element.
Public method GetStartPoint Gets a TextPoint object that marks the beginning of the code event element.

Top

Remarks

This object is derived from the CodeElement 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 CodeEvent object.

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 CodeEventExample(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel. _
      ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

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

See Also

Reference

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