Compartir a través de


VCCodeEvent Interface

An object representing an event code element (declared with the __event keyword).

Namespace:  Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

Syntax

'Declaración
<GuidAttribute("A3CED7F0-B8E6-4440-939A-6FF66BCD6801")> _
Public Interface VCCodeEvent
[GuidAttribute("A3CED7F0-B8E6-4440-939A-6FF66BCD6801")]
public interface VCCodeEvent
[GuidAttribute(L"A3CED7F0-B8E6-4440-939A-6FF66BCD6801")]
public interface class VCCodeEvent
[<GuidAttribute("A3CED7F0-B8E6-4440-939A-6FF66BCD6801")>]
type VCCodeEvent =  interface end
public interface VCCodeEvent

The VCCodeEvent type exposes the following members.

Properties

  Name Description
Public property Attributes Gets a collection of all of the attributes for the parent object.
Public property Children Gets a collection of objects contained within this code construct.
Public property CodeModel Gets the VCCodeModel for the project.
Public property Collection Gets the collection containing the object supporting this property or contained within this code construct.
Public property Comment Gets or sets the comment associated with the code element.
Public property DeclarationText Gets or sets the declaration of the parent object.
Public property DisplayName Gets the full name of the parent object.
Public property DTE Gets the top-level extensibility object.
Public property EndPoint Gets the edit point that is the location of the end of the code item.
Public property EndPointOf Gets the end point of the parent object.
Public property Extender Gets the requested Extender object if it is available for this 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 File Gets the file in which the object is declared.
Public property FullName Gets the full path and name of the object's file.
Public property Functions Gets the collection of implemented child methods of an event (e.g. ‘Add’, ‘Throw’, ‘Remove’, ‘Raise’).
Public property InfoLocation Gets the capabilities of the code model.
Public property IsCaseSensitive Gets a value indicating if a code element is case-sensitive.
Public property IsCodeType Gets a value indicating whether a CodeType object can be obtained from this object.
Public property IsInjected Gets a value indicating whether a code element has been injected by an attribute or macro expansion.
Public property IsReadOnly Gets a value indicating whether the file containing the object is read-only.
Public property IsShared IsShared is true if the event was declared with the static keyword.
Public property IsVirtual IsVirtual is true if the event was declared with the virtual keyword.
Public property IsZombie Gets a value indicating whether the object exists.
Public property Kind Gets an enumeration indicating the type of object.
Public property Language Gets the programming language used to author the code.
Public property Location Gets the location of the object declaration.
Public property Name Gets or sets the name of the object.
Public property Namespace Gets an object defining the namespace.
Public property Parent Gets the immediate parent object of a given object.
Public property Picture Gets a picture automation object to be used as an icon in the user interface.
Public property Project Gets the Project object associated with the object.
Public property ProjectItem Gets the ProjectItem object associated with the given object.
Public property StartPoint Gets a TextPoint object that defines the beginning of the code item.
Public property StartPointOf Gets the start point of the parent object.
Public property TypeString Gets or sets the type of the object using a string representation of the type.

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 element definition.
Public method GetStartPoint Gets a TextPoint object that defines the beginning of the code element definition.
Public method IsSelf Determines if the specified code element is the same as another code element.

Top

Remarks

The VCCodeEvent object represents an event code element in a source file, allowing modification or access to information about that specific code element.

See How to: Compile Example Code for Visual C++ Code Model Extensibility for information on how to compile and run this sample.

Examples

This example retrieves all events of the first class and displays their names in a message box.

Sub GetEvents()
    Dim vcCM As VCCodeModel
    Dim vcClass As VCCodeClass
    Dim vcEvent as VCCodeEvent
    vcCM = DTE.Solution.Item(1).CodeModel
    vcClass = vcCM.Classes.Item(1)
    For Each vcEvent in vcClass.Events
        MsgBox(vcEvent.DisplayName)
    Next
End Sub

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace