VCCodeIDLCoClass Interface

An object defining a CoClass element in a .idl file.

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

Syntax

'Declaration
<GuidAttribute("CB6BF98D-A9A5-4795-B9AD-4BB310528001")> _
Public Interface VCCodeIDLCoClass

[GuidAttribute("CB6BF98D-A9A5-4795-B9AD-4BB310528001")]
public interface VCCodeIDLCoClass

[GuidAttribute(L"CB6BF98D-A9A5-4795-B9AD-4BB310528001")]
public interface class VCCodeIDLCoClass

[<GuidAttribute("CB6BF98D-A9A5-4795-B9AD-4BB310528001")>]
type VCCodeIDLCoClass =  interface end

public interface VCCodeIDLCoClass

The VCCodeIDLCoClass type exposes the following members.

Properties

	Name	Description
	Attributes	Gets a collection of all of the attributes for the object.
	BodyText	Gets or sets the body text of the object.
	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.
	DeclarationText	Gets or sets the declaration of the object.
	DisplayName	Gets the full name of the 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	Gets 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 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.
	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.
	IsZombie	Gets a value indicating whether the parent 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 object declaration.
	Name	Gets or sets the name of the object.
	Parent	Gets the immediate parent object of a VCCodeIDLCoClass object.
	Picture	Gets a picture automation object to be used as an icon in the user interface.
	Project	Gets the Project 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	Gets the start point of the object.

Top

Methods

	Name	Description
	AddAttribute	Creates a new attribute 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 another code element.

Top

Remarks

The VCCodeIDLCoClass object represents a CoClass code element from the .idl file of the parent solution. Primarily, this object is used to access the elements of an existing CoClass code element.

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 the first CoClass code statement and displays it in a message box.

Sub GetFirstCoClass()
    Dim vcCM As VCCodeModel
    Dim vcIDLCoClass As VCCodeIDLCoClass
    vcCM = DTE.Solution.Item(1).CodeModel
    vcIDLCoClass = vcCM.IDLLibraries.Item(1).IDLCoClasses.Item(1)
    MsgBox(vcIDLCoClass.DisplayName)
End Sub

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace