VCCodeDelegate Interface
Definition
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 a delegate code element (declared with the __delegate keyword).
public interface class VCCodeDelegate
public interface class VCCodeDelegate
__interface VCCodeDelegate
[System.Runtime.InteropServices.Guid("0B9C4234-6CA5-41C6-A44D-B0ED2B14FD5F")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
public interface VCCodeDelegate
[<System.Runtime.InteropServices.Guid("0B9C4234-6CA5-41C6-A44D-B0ED2B14FD5F")>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
type VCCodeDelegate = interface
Public Interface VCCodeDelegate
- Attributes
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
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.
Properties
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[vsCMPart, vsCMWhere] |
Returns 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 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[String] |
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[vsCMWhere] |
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[Int32] |
Returns a string holding the stub definition of this 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. |
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. |
Methods
AddAttribute(String, String, Object) |
Creates a new attribute code construct and inserts the code in the correct location. |
AddBase(Object, Object) |
Adds an item to the list of inherited objects. |
AddParameter(String, Object, Object) |
Creates a new parameter 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 the parent code element. |
RemoveBase(Object) |
Removes an object from the list of bases. |
RemoveMember(Object) |
Removes a member code construct. |
RemoveParameter(Object) |
Removes a parameter from the argument list. |