Share via


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)

Syntax

'Declaration
<GuidAttribute("7819C290-9D54-4C74-A3E7-5498B35E9F12")> _
Public Interface VCCodeDelegate
[GuidAttribute("7819C290-9D54-4C74-A3E7-5498B35E9F12")]
public interface VCCodeDelegate
[GuidAttribute(L"7819C290-9D54-4C74-A3E7-5498B35E9F12")]
public interface class VCCodeDelegate
[<GuidAttribute("7819C290-9D54-4C74-A3E7-5498B35E9F12")>]
type VCCodeDelegate =  interface end
public interface VCCodeDelegate

The VCCodeDelegate type exposes the following members.

Properties

  Name Description
Public property Access Gets or sets the access attributes of this item.
Public property Attributes Gets a collection of all of the attributes for the parent object.
Public property BaseClass Gets the class from which this object inherits.
Public property Bases Gets a collection of classes from which this item derives.
Public property Children Gets a collection of objects contained within this code construct.
Public property CodeModel Gets the VCCodeModel object 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 DerivedTypes Gets a collection of objects derived from this object.
Public property DisplayName Gets the full name of the parent object.
Public property DocComment Gets or sets the document comment for the current code model element.
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 Returns 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 VCCodeDelegate object is declared.
Public property FullName Gets the full path and name of the object's file.
Public property InfoLocation Gets the capabilities of the code model.
Public property IsCaseSensitive Gets a value indicating whether 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 IsDerivedFrom Gets a value indicating whether an object has another object as a base.
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 VCCodeDelegate object is read-only.
Public property IsZombie Gets a value indicating whether the VCCodeDelegate 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 parent object declaration.
Public property Members Gets a collection of items contained by this element.
Public property Name Gets or sets the name of the object.
Public property Namespace Gets an object defining the parent namespace.
Public property Parameters Gets a collection of parameters for this item.
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 ProjectItem object associated with the given object.
Public property Prototype Returns a string holding the stub definition of this 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 Type Gets or sets an object representing the programmatic type.
Public property TypeString Gets or sets the type of the parent 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 AddBase Adds an item to the list of inherited objects.
Public method AddParameter Creates a new parameter 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 the parent code element.
Public method RemoveBase Removes an object from the list of bases.
Public method RemoveMember Removes a member code construct.
Public method RemoveParameter Removes a parameter from the argument list.

Top

Remarks

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

Note

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.

Examples

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
        MsgBox(vcDelegate.DisplayName)
    Next
End Sub

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace