CodeEvent Interface

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Models a code event element.

public interface class CodeEvent

public interface class CodeEvent

__interface CodeEvent

[System.Runtime.InteropServices.Guid("CE615BD2-8ED5-4F0C-A7B6-4A299D8801FD")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface CodeEvent

[<System.Runtime.InteropServices.Guid("CE615BD2-8ED5-4F0C-A7B6-4A299D8801FD")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type CodeEvent = interface

Public Interface CodeEvent

Attributes

GuidAttribute TypeLibTypeAttribute

Examples

The following example demonstrates how to use the CodeEvent object.

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

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.

Properties

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

Methods

AddAttribute(String, String, Object)	Creates a new attribute code construct and inserts the code in the correct location.
GetEndPoint(vsCMPart)	Gets a TextPoint object that marks the end of the code event element.
GetStartPoint(vsCMPart)	Gets a TextPoint object that marks the beginning of the code event element.