VCCodeEvent Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCCodeModel

Assembly:: Microsoft.VisualStudio.VCCodeModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public interface class VCCodeEvent

public interface class VCCodeEvent

__interface VCCodeEvent

[System.Runtime.InteropServices.Guid("A359B58B-B2D2-49CE-990F-A2AD662B5635")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
public interface VCCodeEvent

[<System.Runtime.InteropServices.Guid("A359B58B-B2D2-49CE-990F-A2AD662B5635")>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
type VCCodeEvent = interface

Public Interface VCCodeEvent

Attributes: GuidAttribute TypeLibTypeAttribute

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

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.

Properties

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

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

Applies to

Partager via