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
	Access	Gets or sets the access attributes of this item.
	Attributes	Gets a collection of all of the attributes for the parent object.
	BaseClass	Gets the class from which this object inherits.
	Bases	Gets a collection of classes from which this item derives.
	Children	Gets a collection of objects contained within this code construct.
	CodeModel	Gets the VCCodeModel object 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.
	DerivedTypes	Gets a collection of objects derived from this object.
	DisplayName	Gets the full name of the parent object.
	DocComment	Gets or sets the document comment for the current code model element.
	DTE	Gets the top-level extensibility object.
	EndPoint	Gets the edit point that is the location of the end of the code item.
	EndPointOf	Returns the end point of the parent object.
	Extender	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 VCCodeDelegate object is declared.
	FullName	Gets the full path and name of the object's file.
	InfoLocation	Gets the capabilities of the code model.
	IsCaseSensitive	Gets a value indicating whether a code element is case-sensitive.
	IsCodeType	Gets a value indicating whether a CodeType object can be obtained from this object.
	IsDerivedFrom	Gets a value indicating whether an object has another object as a base.
	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 VCCodeDelegate object is read-only.
	IsZombie	Gets a value indicating whether the VCCodeDelegate object exists.
	Kind	Gets an enumeration indicating the type of object.
	Language	Gets the programming language used to author the code.
	Location	Gets the location of the parent object declaration.
	Members	Gets a collection of items contained by this element.
	Name	Gets or sets the name of the object.
	Namespace	Gets an object defining the parent namespace.
	Parameters	Gets a collection of parameters for this item.
	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 ProjectItem object associated with the given object.
	Prototype	Returns a string holding the stub definition of this object.
	StartPoint	Gets a TextPoint object that defines the beginning of the code item.
	StartPointOf	Gets the start point of the parent object.
	Type	Gets or sets an object representing the programmatic type.
	TypeString	Gets or sets the type of the parent object using a string representation of the type.

Top

Methods

	Name	Description
	AddAttribute	Creates a new attribute code construct and inserts the code in the correct location.
	AddBase	Adds an item to the list of inherited objects.
	AddParameter	Creates a new parameter code construct and inserts the code in the correct location.
	GetEndPoint	Gets a TextPoint object that marks the end of the code element definition.
	GetStartPoint	Gets a TextPoint object that defines the beginning of the code element definition.
	IsSelf	Determines if the specified code element is the same as the parent code element.
	RemoveBase	Removes an object from the list of bases.
	RemoveMember	Removes a member code construct.
	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