VCCodeDelegate Interface

An object representing a delegate code element (declared with the __delegate keyword).

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

public interface VCCodeDelegate

The VCCodeDelegate type exposes the following members.

Public propertyAccessGets or sets the access attributes of this item.
Public propertyAttributesGets a collection of all of the attributes for the parent object.
Public propertyBaseClassGets the class from which this object inherits.
Public propertyBasesGets a collection of classes from which this item derives.
Public propertyChildrenGets a collection of objects contained within this code construct.
Public propertyCodeModelGets the VCCodeModel object 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 propertyDerivedTypesGets a collection of objects derived from this object.
Public propertyDisplayNameGets the full name of the parent object.
Public propertyDocCommentGets or sets the document comment for the current code model element.
Public propertyDTEGets the top-level extensibility object.
Public propertyEndPointGets the edit point that is the location of the end of the code item.
Public propertyEndPointOfReturns 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 VCCodeDelegate object is declared.
Public propertyFullNameGets the full path and name of the object's file.
Public propertyInfoLocationGets the capabilities of the code model.
Public propertyIsCaseSensitiveGets a value indicating whether a code element is case-sensitive.
Public propertyIsCodeTypeGets a value indicating whether a CodeType object can be obtained from this object.
Public propertyIsDerivedFromGets a value indicating whether an object has another object as a base.
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 VCCodeDelegate object is read-only.
Public propertyIsZombieGets a value indicating whether the VCCodeDelegate 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 parent object declaration.
Public propertyMembersGets a collection of items contained by this element.
Public propertyNameGets or sets the name of the object.
Public propertyNamespaceGets an object defining the parent namespace.
Public propertyParametersGets a collection of parameters for this item.
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 ProjectItem object associated with the given object.
Public propertyPrototypeReturns a string holding the stub definition of this object.
Public propertyStartPointGets a TextPoint object that defines the beginning of the code item.
Public propertyStartPointOfGets the start point of the parent object.
Public propertyTypeGets or sets an object representing the programmatic type.
Public propertyTypeStringGets or sets the type of the parent object using a string representation of the type.

Public methodAddAttributeCreates a new attribute code construct and inserts the code in the correct location.
Public methodAddBaseAdds an item to the list of inherited objects.
Public methodAddParameterCreates a new parameter 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 the parent code element.
Public methodRemoveBaseRemoves an object from the list of bases.
Public methodRemoveMemberRemoves a member code construct.
Public methodRemoveParameterRemoves a parameter from the argument list.

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


A large part of the functionality of this object is provided by the Visual Studio CodeDelegate object. For more information, see CodeDelegate object.

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 delegates of the parent object and displays each of their names.

[Visual Basic]

Sub GetAllDelegates()
    Dim vcCM As VCCodeModel
    Dim vcDelegate As VCCodeDelegate
    vcCM = DTE.Solution.Item(1).CodeModel
    For Each vcDelegate in vcCM.Delegates
End Sub

Community Additions