Export (0) Print
Expand All

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)

[GuidAttribute("CACF9C31-B76A-4E34-A15A-C6E20C5BFD28")]
public interface VCCodeEvent

The VCCodeEvent type exposes the following members.

  NameDescription
Public propertyAttributesGets a collection of all of the attributes for the parent object.
Public propertyChildrenGets a collection of objects contained within this code construct.
Public propertyCodeModelGets the VCCodeModel for the project.
Public propertyCollectionGets the collection containing the object supporting this property or contained within this code construct.
Public propertyCommentGets or sets the comment associated with the code element.
Public propertyDeclarationTextGets or sets the declaration of the parent object.
Public propertyDisplayNameGets the full name of the parent object.
Public propertyDTEGets the top-level extensibility object.
Public propertyEndPointGets the edit point that is the location of the end of the code item.
Public propertyEndPointOfGets the end point of the parent object.
Public propertyExtenderGets the requested Extender object if it is available for this object.
Public propertyExtenderCATIDGets the Extender category ID (CATID) for the object.
Public propertyExtenderNamesGets a list of available Extenders for the object.
Public propertyFileGets the file in which the object is declared.
Public propertyFullNameGets the full path and name of the object's file.
Public propertyFunctionsGets the collection of implemented child methods of an event (e.g. ‘Add’, ‘Throw’, ‘Remove’, ‘Raise’).
Public propertyInfoLocationGets the capabilities of the code model.
Public propertyIsCaseSensitiveGets a value indicating if a code element is case-sensitive.
Public propertyIsCodeTypeGets a value indicating whether a CodeType object can be obtained from this object.
Public propertyIsInjectedGets a value indicating whether a code element has been injected by an attribute or macro expansion.
Public propertyIsReadOnlyGets a value indicating whether the file containing the object is read-only.
Public propertyIsSharedIsShared is true if the event was declared with the static keyword.
Public propertyIsVirtualIsVirtual is true if the event was declared with the virtual keyword.
Public propertyIsZombieGets a value indicating whether the object exists.
Public propertyKindGets an enumeration indicating the type of object.
Public propertyLanguageGets the programming language used to author the code.
Public propertyLocationGets the location of the object declaration.
Public propertyNameGets or sets the name of the object.
Public propertyNamespaceGets an object defining the namespace.
Public propertyParentGets the immediate parent object of a given object.
Public propertyPictureGets a picture automation object to be used as an icon in the user interface.
Public propertyProjectGets the Project object associated with the object.
Public propertyProjectItemGets the ProjectItem object associated with the given object.
Public propertyStartPointGets a TextPoint object that defines the beginning of the code item.
Public propertyStartPointOfGets the start point of the parent object.
Public propertyTypeStringGets or sets the type of the object using a string representation of the type.
Top

  NameDescription
Public methodAddAttributeCreates a new attribute code construct and inserts the code in the correct location.
Public methodGetEndPointGets a TextPoint object that marks the end of the code element definition.
Public methodGetStartPointGets a TextPoint object that defines the beginning of the code element definition.
Public methodIsSelfDetermines if the specified code element is the same as another code element.
Top

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.

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
Show:
© 2014 Microsoft