VCCodeClass VCCodeClass VCCodeClass VCCodeClass VCCodeClass VCCodeClass Interface

Definition

An object providing access to any class element collected in a VCCodeModel object.

public interface class VCCodeClass
public interface class VCCodeClass
__interface VCCodeClass
[System.Runtime.InteropServices.Guid("2AC93578-8330-4AA5-AEB5-33811D47255F")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDual | System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable)]
public interface VCCodeClass
type VCCodeClass = interface
Public Interface VCCodeClass
Attributes

Examples

Sub GetClass()  
    Dim vcCM as VCCodeModel  
    Dim vcClass as VCCodeClass  
    vcCM = DTE.Solution.Item(1).CodeModel  
    vcClass = vcCM.Classes.Find("CAboutDlg")  
End Sub  

Remarks

The VCCodeClass object provides code model functionality to existing Visual C++ IDE solutions at the class level. Primarily, this object is used to modify any class element accessible within a project.

Note

A large part of the functionality of this object is provided by the Visual Studio CodeClass object. For more information, see CodeClass 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 Access Access Access Access Access

Sets or gets the access attributes of this item.

Attributes Attributes Attributes Attributes Attributes Attributes

Gets a collection of all of the attributes for the parent object.

Bases Bases Bases Bases Bases Bases

Gets a collection of classes from which this item derives.

BodyText BodyText BodyText BodyText BodyText BodyText

Gets or sets the body text of the parent object.

Children Children Children Children Children Children

Gets a collection of objects contained within this code construct.

Classes Classes Classes Classes Classes Classes

Gets a collection of classes for the parent object.

CodeModel CodeModel CodeModel CodeModel CodeModel CodeModel

Gets the VCCodeModel object for the project.

Collection Collection Collection Collection Collection Collection

Gets the collection containing the object supporting this property or contained within this code construct.

Comment Comment Comment Comment Comment Comment

Gets or sets the comment associated with the VCCodeClass.

DataTypeKind DataTypeKind DataTypeKind DataTypeKind DataTypeKind DataTypeKind
DeclarationText DeclarationText DeclarationText DeclarationText DeclarationText DeclarationText

Gets or sets the declaration of the parent object.

DerivedTypes DerivedTypes DerivedTypes DerivedTypes DerivedTypes DerivedTypes

Gets a collection of objects derived from this object.

DisplayName DisplayName DisplayName DisplayName DisplayName DisplayName

Gets the full name of the parent object.

DocComment DocComment DocComment DocComment DocComment DocComment

Gets or sets the document comment for the current code model element.

DTE DTE DTE DTE DTE DTE

Gets the top-level extensibility object.

EndPoint EndPoint EndPoint EndPoint EndPoint EndPoint

Gets the edit point that is the location of the end of the code item.

EndPointOf[vsCMPart, vsCMWhere] EndPointOf[vsCMPart, vsCMWhere] EndPointOf[vsCMPart, vsCMWhere] EndPointOf[vsCMPart, vsCMWhere] EndPointOf[vsCMPart, vsCMWhere] EndPointOf[vsCMPart, vsCMWhere]

Gets the end point of the parent object.

Enums Enums Enums Enums Enums Enums

Gets a collection of enumerations for the parent object.

Events Events Events Events Events Events

Gets a collection of events for the parent object.

Extender[String] Extender[String] Extender[String] Extender[String] Extender[String] Extender[String]

Gets the requested Extender object if it is available for this object.

ExtenderCATID ExtenderCATID ExtenderCATID ExtenderCATID ExtenderCATID ExtenderCATID

Gets the Extender category ID (CATID) for the object.

ExtenderNames ExtenderNames ExtenderNames ExtenderNames ExtenderNames ExtenderNames

Gets a list of available Extenders for the object.

File File File File File File

Gets the file in which the VCCodeClass is declared.

FullName FullName FullName FullName FullName FullName

Gets the full path and name of the object's file.

Functions Functions Functions Functions Functions Functions

Gets a collection of functions for the parent object.

ImplementedInterfaces ImplementedInterfaces ImplementedInterfaces ImplementedInterfaces ImplementedInterfaces ImplementedInterfaces

Gets a collection of interfaces implemented by this object.

InfoLocation InfoLocation InfoLocation InfoLocation InfoLocation InfoLocation

Gets the capabilities of the code model.

IsAbstract IsAbstract IsAbstract IsAbstract IsAbstract IsAbstract

Gets or sets a value indicating whether or not an item is declared as abstract.

IsCaseSensitive IsCaseSensitive IsCaseSensitive IsCaseSensitive IsCaseSensitive IsCaseSensitive

Gets a value indicating whether a code element is case-sensitive.

IsCodeType IsCodeType IsCodeType IsCodeType IsCodeType IsCodeType

Gets a value indicating whether a CodeType object can be obtained from this object.

IsDerivedFrom[String] IsDerivedFrom[String] IsDerivedFrom[String] IsDerivedFrom[String] IsDerivedFrom[String] IsDerivedFrom[String]

Gets a value indicating whether an object has another object as a base.

IsFinal IsFinal IsFinal IsFinal IsFinal IsFinal
IsInjected IsInjected IsInjected IsInjected IsInjected IsInjected

Gets a value indicating whether a code element has been injected by an attribute or macro expansion.

IsManaged IsManaged IsManaged IsManaged IsManaged IsManaged

Gets or sets a value indicating whether the VCCodeClass object is managed.

IsReadOnly IsReadOnly IsReadOnly IsReadOnly IsReadOnly IsReadOnly

Gets a value indicating whether the file containing the VCCodeClass object is read-only.

IsSealed IsSealed IsSealed IsSealed IsSealed IsSealed

Gets or sets a value indicating whether the __sealed keyword is applied to the parent object.

IsTemplate IsTemplate IsTemplate IsTemplate IsTemplate IsTemplate

Gets a value indicating whether the VCCodeClass object is a template.

IsValue IsValue IsValue IsValue IsValue IsValue

Gets or sets a value indicating whether the __value keyword is applied to the VCCodeClass object.

IsZombie IsZombie IsZombie IsZombie IsZombie IsZombie

Gets a value indicating whether the VCCodeClass object exists.

Kind Kind Kind Kind Kind Kind

Gets an enumeration indicating the type of object.

Language Language Language Language Language Language

Gets the programming language used to author the code.

Location[vsCMWhere] Location[vsCMWhere] Location[vsCMWhere] Location[vsCMWhere] Location[vsCMWhere] Location[vsCMWhere]

Gets the location of the VCCodeClass object declaration.

Maps Maps Maps Maps Maps Maps

Gets the collection of maps for the VCCodeClass object.

Members Members Members Members Members Members

Gets a collection of items contained by this element.

Name Name Name Name Name Name

Gets or sets the name of the object.

Namespace Namespace Namespace Namespace Namespace Namespace

Gets an object defining the parent namespace.

Parent Parent Parent Parent Parent Parent

Gets the immediate parent object of a given object.

Parts Parts Parts Parts Parts Parts
Picture Picture Picture Picture Picture Picture

Gets a picture automation object to be used as an icon in the user interface.

Project Project Project Project Project Project

Gets the Project associated with the object.

ProjectItem ProjectItem ProjectItem ProjectItem ProjectItem ProjectItem

Gets the ProjectItem object associated with the given object.

Properties Properties Properties Properties Properties Properties

Gets the collection of properties for the parent object.

References References References References References References

Not currently implemented.

StartPoint StartPoint StartPoint StartPoint StartPoint StartPoint

Gets a TextPoint object that defines the beginning of the code item.

StartPointOf[vsCMPart, vsCMWhere] StartPointOf[vsCMPart, vsCMWhere] StartPointOf[vsCMPart, vsCMWhere] StartPointOf[vsCMPart, vsCMWhere] StartPointOf[vsCMPart, vsCMWhere] StartPointOf[vsCMPart, vsCMWhere]

Returns the start point of the parent object.

Structs Structs Structs Structs Structs Structs

Gets the collection of structure elements for the VCCodeClass object.

TemplateParameters TemplateParameters TemplateParameters TemplateParameters TemplateParameters TemplateParameters

Gets a collection of parameters contained in a class template.

Templatizations Templatizations Templatizations Templatizations Templatizations Templatizations

Microsoft Internal Use Only.

Typedefs Typedefs Typedefs Typedefs Typedefs Typedefs

Gets the collection of VCCodeTypedef elements for the parent object.

Unions Unions Unions Unions Unions Unions

Gets the collection of VCCodeUnion elements for the VCCodeClass object.

UsingAliases UsingAliases UsingAliases UsingAliases UsingAliases UsingAliases
Variables Variables Variables Variables Variables Variables

Gets the collection of variables for the VCCodeClass object.

Methods

AddAttribute(String, String, Object) AddAttribute(String, String, Object) AddAttribute(String, String, Object) AddAttribute(String, String, Object) AddAttribute(String, String, Object) AddAttribute(String, String, Object)

Creates a new attribute code construct and inserts the code in the correct location.

AddBase(Object, Object) AddBase(Object, Object) AddBase(Object, Object) AddBase(Object, Object) AddBase(Object, Object) AddBase(Object, Object)

Adds an item to the list of inherited objects.

AddClass(String, Object, Object, Object, vsCMAccess) AddClass(String, Object, Object, Object, vsCMAccess) AddClass(String, Object, Object, Object, vsCMAccess) AddClass(String, Object, Object, Object, vsCMAccess) AddClass(String, Object, Object, Object, vsCMAccess) AddClass(String, Object, Object, Object, vsCMAccess)

Creates a new class code construct and inserts the code in the correct location.

AddDelegate(String, Object, Object, vsCMAccess) AddDelegate(String, Object, Object, vsCMAccess) AddDelegate(String, Object, Object, vsCMAccess) AddDelegate(String, Object, Object, vsCMAccess) AddDelegate(String, Object, Object, vsCMAccess) AddDelegate(String, Object, Object, vsCMAccess)

Creates a new delegate code construct and inserts the code in the correct location.

AddEnum(String, Object, Object, vsCMAccess) AddEnum(String, Object, Object, vsCMAccess) AddEnum(String, Object, Object, vsCMAccess) AddEnum(String, Object, Object, vsCMAccess) AddEnum(String, Object, Object, vsCMAccess) AddEnum(String, Object, Object, vsCMAccess)

Creates a new enumeration code construct and inserts the code in the correct location.

AddEvent(String, Object, Object, vsCMAccess) AddEvent(String, Object, Object, vsCMAccess) AddEvent(String, Object, Object, vsCMAccess) AddEvent(String, Object, Object, vsCMAccess) AddEvent(String, Object, Object, vsCMAccess) AddEvent(String, Object, Object, vsCMAccess)

Microsoft Internal Use Only.

AddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object) AddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object) AddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object) AddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object) AddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object) AddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object)

Creates a new function code construct and inserts the code in the correct location.

AddImplementedInterface(Object, Object) AddImplementedInterface(Object, Object) AddImplementedInterface(Object, Object) AddImplementedInterface(Object, Object) AddImplementedInterface(Object, Object) AddImplementedInterface(Object, Object)

Adds an interface to the list of inherited objects.

AddMap(String, String, Object, Object) AddMap(String, String, Object, Object) AddMap(String, String, Object, Object) AddMap(String, String, Object, Object) AddMap(String, String, Object, Object) AddMap(String, String, Object, Object)

Adds a map entry to the parent object.

AddProperty(String, String, Object, Object, vsCMAccess, Object) AddProperty(String, String, Object, Object, vsCMAccess, Object) AddProperty(String, String, Object, Object, vsCMAccess, Object) AddProperty(String, String, Object, Object, vsCMAccess, Object) AddProperty(String, String, Object, Object, vsCMAccess, Object) AddProperty(String, String, Object, Object, vsCMAccess, Object)

Creates a new property code construct and inserts the code in the correct location.

AddStruct(String, Object, Object, Object, vsCMAccess) AddStruct(String, Object, Object, Object, vsCMAccess) AddStruct(String, Object, Object, Object, vsCMAccess) AddStruct(String, Object, Object, Object, vsCMAccess) AddStruct(String, Object, Object, Object, vsCMAccess) AddStruct(String, Object, Object, Object, vsCMAccess)

Creates a new structure code construct and inserts the code in the correct location.

AddTemplateParameter(String, Object, Object) AddTemplateParameter(String, Object, Object) AddTemplateParameter(String, Object, Object) AddTemplateParameter(String, Object, Object) AddTemplateParameter(String, Object, Object) AddTemplateParameter(String, Object, Object)

Adds a parameter to a template definition.

AddTypedef(String, Object, Object, vsCMAccess) AddTypedef(String, Object, Object, vsCMAccess) AddTypedef(String, Object, Object, vsCMAccess) AddTypedef(String, Object, Object, vsCMAccess) AddTypedef(String, Object, Object, vsCMAccess) AddTypedef(String, Object, Object, vsCMAccess)

Adds a Typedef statement to the parent object.

AddUnion(String, Object, vsCMAccess) AddUnion(String, Object, vsCMAccess) AddUnion(String, Object, vsCMAccess) AddUnion(String, Object, vsCMAccess) AddUnion(String, Object, vsCMAccess) AddUnion(String, Object, vsCMAccess)

Adds a union statement to the parent object.

AddUsingAlias(String, Object, Object, vsCMAccess) AddUsingAlias(String, Object, Object, vsCMAccess) AddUsingAlias(String, Object, Object, vsCMAccess) AddUsingAlias(String, Object, Object, vsCMAccess) AddUsingAlias(String, Object, Object, vsCMAccess) AddUsingAlias(String, Object, Object, vsCMAccess)
AddVariable(String, Object, Object, vsCMAccess, Object) AddVariable(String, Object, Object, vsCMAccess, Object) AddVariable(String, Object, Object, vsCMAccess, Object) AddVariable(String, Object, Object, vsCMAccess, Object) AddVariable(String, Object, Object, vsCMAccess, Object) AddVariable(String, Object, Object, vsCMAccess, Object)

Creates a new variable code construct and inserts the code in the correct location.

GetEndPoint(vsCMPart) GetEndPoint(vsCMPart) GetEndPoint(vsCMPart) GetEndPoint(vsCMPart) GetEndPoint(vsCMPart) GetEndPoint(vsCMPart)

Returns a TextPoint object that marks the end of the code element definition.

GetStartPoint(vsCMPart) GetStartPoint(vsCMPart) GetStartPoint(vsCMPart) GetStartPoint(vsCMPart) GetStartPoint(vsCMPart) GetStartPoint(vsCMPart)

Returns a TextPoint object that defines the beginning of the code element definition.

IsSelf(Object) IsSelf(Object) IsSelf(Object) IsSelf(Object) IsSelf(Object) IsSelf(Object)

Determines if the specified code element is the same as the parent code element.

RemoveBase(Object) RemoveBase(Object) RemoveBase(Object) RemoveBase(Object) RemoveBase(Object) RemoveBase(Object)

Removes an object from the list of bases.

RemoveInterface(Object) RemoveInterface(Object) RemoveInterface(Object) RemoveInterface(Object) RemoveInterface(Object) RemoveInterface(Object)

Removes an interface from the list of implemented interfaces.

RemoveMember(Object) RemoveMember(Object) RemoveMember(Object) RemoveMember(Object) RemoveMember(Object) RemoveMember(Object)

Removes a member code construct.

RemoveTemplateParameter(Object) RemoveTemplateParameter(Object) RemoveTemplateParameter(Object) RemoveTemplateParameter(Object) RemoveTemplateParameter(Object) RemoveTemplateParameter(Object)

Removes a parameter from a template definition.

ValidateMember(String, vsCMElement, String) ValidateMember(String, vsCMElement, String) ValidateMember(String, vsCMElement, String) ValidateMember(String, vsCMElement, String) ValidateMember(String, vsCMElement, String) ValidateMember(String, vsCMElement, String)

Validates that the proposed name is a valid C++ name for the kind given in the context of the parent object.

ValidateMemberName(String, vsCMElement, vcCMNameValidationOption) ValidateMemberName(String, vsCMElement, vcCMNameValidationOption) ValidateMemberName(String, vsCMElement, vcCMNameValidationOption) ValidateMemberName(String, vsCMElement, vcCMNameValidationOption) ValidateMemberName(String, vsCMElement, vcCMNameValidationOption) ValidateMemberName(String, vsCMElement, vcCMNameValidationOption)

Applies to