CodeEvent CodeEvent CodeEvent CodeEvent CodeEvent CodeEvent Interface

Definition

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
type CodeEvent = interface
Public Interface CodeEvent
Attributes

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 Access Access Access Access Access

Gets or sets a value that determines how a code event element may be accessed by other code.

Adder Adder Adder Adder Adder Adder

Gets or sets the event listeners.

Attributes Attributes Attributes Attributes Attributes Attributes

Gets a CodeElements collection of attributes for this code event element.

Children Children Children Children Children Children

Gets a collection of objects contained within this CodeEvent.

Collection Collection Collection Collection Collection Collection

Gets a CodeElements collection.

Comment Comment Comment Comment Comment Comment

Gets or sets a header comment associated with the code event element.

DocComment DocComment DocComment DocComment DocComment DocComment

Gets or sets a documentation comment associated with the code event element.

DTE DTE DTE DTE DTE DTE

Gets the top-level extensibility object.

EndPoint EndPoint EndPoint EndPoint EndPoint EndPoint

Gets the location in the source file marked as an end of the code event element.

Extender[String] Extender[String] Extender[String] Extender[String] Extender[String] Extender[String]

Gets the requested Extender if it is available for this CodeElement object.

ExtenderCATID ExtenderCATID ExtenderCATID ExtenderCATID ExtenderCATID ExtenderCATID

Gets the Extender category ID (CATID) for the object.

ExtenderNames ExtenderNames ExtenderNames ExtenderNames ExtenderNames ExtenderNames

Gets a list of available Extenders for the object.

FullName FullName FullName FullName FullName FullName

Gets a fully-qualified name of the specified CodeEvent object.

InfoLocation InfoLocation InfoLocation InfoLocation InfoLocation InfoLocation

Gets the capabilities of the code model.

IsCodeType IsCodeType IsCodeType IsCodeType IsCodeType IsCodeType

Gets whether the CodeEvent is a CodeType.

IsPropertyStyleEvent IsPropertyStyleEvent IsPropertyStyleEvent IsPropertyStyleEvent IsPropertyStyleEvent IsPropertyStyleEvent

Gets a value indicating whether the event has separate methods for adding/ removing events and throwing exceptions.

IsShared IsShared IsShared IsShared IsShared IsShared

Gets of sets the shared (static) status of the event.

Kind Kind Kind Kind Kind Kind

Gets the type of the code element.

Language Language Language Language Language Language

Gets the programming language used to author the code.

Name Name Name Name Name Name

Gets or sets the name of the CodeEvent object.

OverrideKind OverrideKind OverrideKind OverrideKind OverrideKind OverrideKind

Gets of sets the override modifiers on a code event.

Parent Parent Parent Parent Parent Parent

Gets the immediate parent object of the CodeEvent object.

ProjectItem ProjectItem ProjectItem ProjectItem ProjectItem ProjectItem

Gets the ProjectItem object associated with the CodeEvent object.

Prototype[Int32] Prototype[Int32] Prototype[Int32] Prototype[Int32] Prototype[Int32] Prototype[Int32]

Gets a string containing the description of a code event element.

Remover Remover Remover Remover Remover Remover

Gets or sets the event listeners.

StartPoint StartPoint StartPoint StartPoint StartPoint StartPoint

Gets the location in the source file marked as a beginning of the code event element.

Thrower Thrower Thrower Thrower Thrower Thrower

Gets or sets CodeFunction object.

Type Type Type Type Type Type

Gets or sets the type of the CodeTypeReference object.

Methods

AddAttribute(String, String, Object) AddAttribute(String, String, Object) AddAttribute(String, String, Object) AddAttribute(String, String, Object) AddAttribute(String, String, Object) AddAttribute(String, String, Object)

Creates a new attribute code construct and inserts the code in the correct location.

GetEndPoint(vsCMPart) GetEndPoint(vsCMPart) GetEndPoint(vsCMPart) GetEndPoint(vsCMPart) GetEndPoint(vsCMPart) GetEndPoint(vsCMPart)

Gets a TextPoint object that marks the end of the code event element.

GetStartPoint(vsCMPart) GetStartPoint(vsCMPart) GetStartPoint(vsCMPart) GetStartPoint(vsCMPart) GetStartPoint(vsCMPart) GetStartPoint(vsCMPart)

Gets a TextPoint object that marks the beginning of the code event element.

Applies to